/ 
VM-HetznerCloud-0.0.3
River stage zero No dependents
/ VM::HetznerCloud::API::FloatingIps

NAME

VM::HetznerCloud::API::FloatingIps - FloatingIps

VERSION

version 0.0.3

SYNOPSIS

use VM::HetznerCloud;

my $api_key = '1234abc';
my $cloud   = VM::HetznerCloud->new(
    token => $api_key,
);

$cloud->records->create(
);

ATTRIBUTES

  • endpoint

METHODS

list

Returns all Floating IP objects.

$cloud->floating_ips->list(
    label_selector => 'test',
    name => 'test',
    sort => 'test',
);

create

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.

$cloud->floating_ips->create();

delete

Deletes a Floating IP. If it is currently assigned to a Server it will automatically get unassigned.

$cloud->floating_ips->delete(
    id => 'test',
);

get

Returns a specific Floating IP object.

$cloud->floating_ips->get(
    id => 'test',
);

put

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.

$cloud->floating_ips->put(
    id => 'test',
);

list_actions

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.

$cloud->floating_ips->list_actions(
    id => 'test',
    sort => 'test',
    status => 'test',
);

assign

Assigns a Floating IP to a Server.

$cloud->floating_ips->assign(
    id => 'test',
);

change_dns_ptr

Changes the hostname that will appear when getting the hostname belonging to this Floating IP.

$cloud->floating_ips->change_dns_ptr(
    id => 'test',
);

change_protection

Changes the protection configuration of the Floating IP.

$cloud->floating_ips->change_protection(
    id => 'test',
);

unassign

Unassigns a Floating IP, resulting in it being unreachable. You may assign it to a Server again at a later time.

$cloud->floating_ips->unassign(
    id => 'test',
);

get_actions

Returns a specific Action object for a Floating IP.

$cloud->floating_ips->get_actions(
    action_id => 'test',
    id => 'test',
);

AUTHOR

Renee Baecker <reneeb@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Renee Baecker.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)