FloatingIP
Type: class
An IP address or block that can be assigned/unassigned to/from servers at runtime.
Functions
#getActions([params])
| Parameter | Type | Description |
|---|---|---|
| params | Object |
Can be used for sorting |
Returns: Promise<FloatingIPActionList>
Get an action list for this specific floating IP.
#getAction(id)
| Parameter | Type | Description |
|---|---|---|
| id | number |
The action id |
Returns: Promise<Action>
Get a specific action for this floating IP.
#isV4()
Returns: boolean
#isV6()
Returns: boolean
#changeDescription([description])
| Parameter | Type | Description |
|---|---|---|
| description | string |
The new description |
Returns: Promise<FloatingIP>
#delete()
Returns: Promise
#assign(server)
| Parameter | Type | Description |
|---|---|---|
| server | number, string or Server |
The servers id, name or an instance of Server the IP will be assigned to |
Returns: Promise<Action>
Assigns this floating IP to a server.
#unassign()
Returns: Promise<Action>
Unassignes this floating IP from a server.
#getAddress(ip)
| Parameter | Type | Description |
|---|---|---|
| ip | string |
The IP address (optional for IPv4) |
Returns: Address or null
Only returns an Address instance if a DNS pointer has been set.
#getPointer(ip)
| Parameter | Type | Description |
|---|---|---|
| ip | string |
The IP address (optional for IPv4) |
Returns: string or null
Returns the pointer for the IP address if one has been set.
#setPointer(ip, pointer)
| Parameter | Type | Description |
|---|---|---|
| ip | string |
The IP address |
| pointer | string |
FQDN |
Returns: Promise<Action>
Returns an Action for setting the pointer.
Properties
.id
Type: number
.description
Type: string
.ip
Type: string
.type
Type: string
Will be either ipv4 or ipv6.
.server
Type: number or null
.location
Type: Location
.blocked
Type: boolean
.addresses
Type: Array
An array of Addresses.
.protection
Type: Object
Protection configuration for the floating IP.