ipv4_addresses
Creates, updates, deletes, gets or lists an ipv4_addresses
resource.
Overview
Name | ipv4_addresses |
Type | Resource |
Id | linode.networking.ipv4_addresses |
Fields
The following fields are returned by SELECT
queries:
SELECT
not supported for this resource, use SHOW METHODS
to view available operations for the resource.
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
post_assign_ipv4s | insert | data__region , data__assignments | This operation is equivalent to Assign IP addresses. 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. - For Linode interfaces, the Linode needs to have a public interface, and the address it receives can't be a private IPv4 address. - 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. > 📘 > > 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 operations: - Get a Linode's managed settings - Update a Linode's managed settings OAuth scopes. <br /> ips:read_write<br />linodes:read_write<br /> Learn more... | |
post_share_ipv4s | insert | data__linode_id , data__ips | This operation is equivalent to Share IP addresses. 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 BGP based failover service within the internal system of the primary Linode. > 📘 > > A public IPv4 address can't be shared if it's configured for a 1:1 NAT on a legacy configuration profile VPC interface or on a Linode VPC interface. OAuth scopes. <br /> ips:read_write<br />linodes:read_write<br /> Learn more... |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|
INSERT
examples
- post_assign_ipv4s
- post_share_ipv4s
- Manifest
This operation is equivalent to Assign IP addresses.
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.
- For Linode interfaces, the Linode needs to have a public interface, and the address it receives can't be a private IPv4 address.
- 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.
> 📘
>
> 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 operations:
- Get a Linode's managed settings
- Update a Linode's managed settings OAuth scopes.
<br /> ips:read_write<br />linodes:read_write<br />
Learn more...
INSERT INTO linode.networking.ipv4_addresses (
data__assignments,
data__region
)
SELECT
'{{ assignments }}' --required,
'{{ region }}' --required
;
This operation is equivalent to Share IP addresses.
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 BGP based failover service within the internal system of the primary Linode.
> 📘
>
> A public IPv4 address can't be shared if it's configured for a 1:1 NAT on a legacy configuration profile VPC interface or on a Linode VPC interface. OAuth scopes.
<br /> ips:read_write<br />linodes:read_write<br />
Learn more...
INSERT INTO linode.networking.ipv4_addresses (
data__ips,
data__linode_id
)
SELECT
'{{ ips }}' --required,
{{ linode_id }} --required
;
# Description fields are for documentation purposes
- name: ipv4_addresses
props:
- name: assignments
value: array
description: >
The list of assignments to make. You must have read_write access to all IPs being assigned and all Linodes being assigned to in order for the assignments to succeed.
- name: region
value: string
description: >
The ID of the Region in which these assignments are to take place. All IPs and Linodes must exist in this Region.
- name: ips
value: array
description: >
A list of secondary Linode IPs to share with the primary Linode.
- Can include both IPv4 addresses and IPv6 ranges (omit /56 and /64 prefix lengths)
- Can include both private and public IPv4 addresses.
- You must have access to all of these addresses and they must be in the same Region as the primary Linode.
- Enter an empty array to remove all shared IP addresses.
- name: linode_id
value: integer
description: >
The ID of the primary Linode that the addresses will be shared with.