hetzner/floating_ip_actions

Search:
Group by:

Types

FloatingIpActionSortOption = enum
  sortId = "id", sortIdAsc = "id:asc", sortIdDesc = "id:desc",
  sortCommand = "command", sortCommandAsc = "command:asc",
  sortCommandDesc = "command:desc", sortStatus = "status",
  sortStatusAsc = "status:asc", sortStatusDesc = "status:desc",
  sortProgress = "progress", sortProgressAsc = "progress:asc",
  sortProgressDesc = "progress:desc", sortStarted = "started",
  sortStartedAsc = "started:asc", sortStartedDesc = "started:desc",
  sortFinished = "finished", sortFinishedAsc = "finished:asc",
  sortFinishedDesc = "finished:desc"
FloatingIpActionStatusOption = enum
  statusRunning = "running", statusSuccess = "success", statusError = "error"

Procs

proc getFloatingIpsIdActions(client: HetznerClient; id: int64;
                             sort: set[FloatingIpActionSortOption] = {};
                             status: set[FloatingIpActionStatusOption] = {}): Future[
    GetFloatingIpsIdActionsResponse] {....stackTrace: false, raises: [Exception,
    ValueError, KeyError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, OpenParserJsonError, HetznerClientError], tags: [
    RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Returns all Action objects for a Floating IP. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
proc getFloatingIpsIdActionsActionId(client: HetznerClient; id: int64;
                                     actionId: int64): Future[
    GetFloatingIpsIdActionsActionIdResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Returns a specific Action object for a Floating IP.
proc postFloatingIpsIdActionsAssign(client: HetznerClient; id: int64;
                                    body: PostFloatingIpsIdActionsAssignRequest): Future[
    PostFloatingIpsIdActionsAssignResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Assigns a Floating IP to a Server.
proc postFloatingIpsIdActionsChangeDnsPtr(client: HetznerClient; id: int64;
    body: PostFloatingIpsIdActionsChangeDnsPtrRequest): Future[
    PostFloatingIpsIdActionsChangeDnsPtrResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Changes the hostname that will appear when getting the hostname belonging to this Floating IP.
proc postFloatingIpsIdActionsChangeProtection(client: HetznerClient; id: int64;
    body: PostFloatingIpsIdActionsChangeProtectionRequest): Future[
    PostFloatingIpsIdActionsChangeProtectionResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Changes the protection configuration of the Floating IP.
proc postFloatingIpsIdActionsUnassign(client: HetznerClient; id: int64): Future[
    PostFloatingIpsIdActionsUnassignResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Unassigns a Floating IP, resulting in it being unreachable. You may assign it to a Server again at a later time.