hetzner/floating_ips

Types

FloatingIpSortOption = enum
  sortId = "id", sortIdAsc = "id:asc", sortIdDesc = "id:desc",
  sortCreated = "created", sortCreatedAsc = "created:asc",
  sortCreatedDesc = "created:desc"

Procs

proc deleteFloatingIpsId(client: HetznerClient; id: int64): Future[AsyncResponse] {.
    ...stackTrace: false, raises: [Exception, ValueError, HttpRequestError,
                                LibraryError, SslError, OSError, IOError,
                                ProtocolError, KeyError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Deletes a Floating IP. If it is currently assigned to a Server it will automatically get unassigned.
proc getFloatingIps(client: HetznerClient; name: string = default(string);
                    labelSelector: string = default(string);
                    sort: set[FloatingIpSortOption] = {}): Future[
    GetFloatingIpsResponse] {....stackTrace: false, raises: [Exception, ValueError,
    KeyError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, OpenParserJsonError, HetznerClientError],
                              tags: [RootEffect, ReadIOEffect, TimeEffect],
                              forbids: [].}
Returns all Floating IP objects.
proc getFloatingIpsId(client: HetznerClient; id: int64): Future[
    GetFloatingIpsIdResponse] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
                                tags: [RootEffect, ReadIOEffect, TimeEffect],
                                forbids: [].}
Returns a specific Floating IP object.
proc postFloatingIps(client: HetznerClient; body: PostFloatingIpsRequest): Future[
    PostFloatingIpsResponse] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
                               tags: [RootEffect, ReadIOEffect, TimeEffect],
                               forbids: [].}
Creates a new Floating IP assigned to a Server. If you want to create a Floating IP that is not bound to a Server, you need to provide the home_location key instead of server. This can be either the ID or the name of the Location this IP shall be created in. Note that a Floating IP can be assigned to a Server in any Location later on. For optimal routing it is advised to use the Floating IP in the same Location it was created in.
proc putFloatingIpsId(client: HetznerClient; id: int64;
                      body: PutFloatingIpsIdRequest): Future[
    PutFloatingIpsIdResponse] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
                                tags: [RootEffect, ReadIOEffect, TimeEffect],
                                forbids: [].}
Updates the description or labels of a Floating IP. Also note that when updating labels, the Floating IP’s current set of labels will be replaced with the labels provided in the request body. So, for example, if you want to add a new label, you have to provide all existing labels plus the new label in the request body.