ips

Overview

Name	ips
Type	Resource
Id	linode.networking.ips

Fields

Name	Datatype	Description
subnet_mask	string	The mask that separates host bits from network bits for this address.
linode_id	integer	The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses my be moved using the /networking/ipv4/assign endpoint. For SLAAC and link-local addresses, this value may not be changed.
type	string	The type of address this is.
address	string	The IP address.
rdns	string	The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.
region	string	The Region this IP address resides in.
prefix	integer	The number of bits set in the subnet mask.
gateway	string	The default gateway for this address.
public	boolean	Whether this is a public or private IP address.

Methods

Name	Accessible by	Required Params	Description
getIP	SELECT	address	Returns information about a single IP Address on your Account.
getIPs	SELECT		Returns a paginated list of IP Addresses on your Account, excluding private addresses.
_getIP	EXEC	address	Returns information about a single IP Address on your Account.
_getIPs	EXEC		Returns a paginated list of IP Addresses on your Account, excluding private addresses.
allocateIP	EXEC	data__linode_id, data__public, data__type	Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please open a support ticket requesting additional addresses before attempting allocation.
assignIPs	EXEC	data__assignments, data__region	Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes. The following restrictions apply: All Linodes involved must have at least one public IPv4 address after assignment. Linodes may have no more than one assigned private IPv4 address. Linodes may have no more than one assigned IPv6 range. Open a Support Ticket to request additional IPv4 addresses or IPv6 ranges beyond standard account limits. Note: Removing an IP address that has been set as a Managed Linode's ssh.ip causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands: Linode's Managed Settings View (GET /managed/linode-settings/{linodeId}) * Linode's Managed Settings Update (PUT /managed/linode-settings/{linodeId})
shareIPs	EXEC	data__ips, data__linode_id	Configure shared IPs. IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses. IP failover requires configuration of a failover service (such as Keepalived) within the internal system of the primary Linode.
updateIP	EXEC	address, data__rdns	Sets RDNS on an IP Address. Forward DNS must already be set up for reverse DNS to be applied. If you set the RDNS to null for public IPv4 addresses, it will be reset to the default ip.linodeusercontent.com RDNS value.