ip_addresses
Creates, updates, deletes, gets or lists an ip_addresses resource.
Overview
| Name | ip_addresses |
| Type | Resource |
| Id | linode.vpcs.ip_addresses |
Fields
The following fields are returned by SELECT queries:
- get_vpc_ips
- get_vpcs_ips
The IP addresses for the requested VPC.
| Name | Datatype | Description |
|---|---|---|
config_id | integer | Filterable, Read-only The globally general entity identifier for the Linode configuration profile that includes the VPC. If this is a VPC Linode interface, the value is null. |
interface_id | integer | Beta, Read-only The globally general API entity identifier for the Linode interface. |
linode_id | integer | Filterable, Read-only The identifier for the Linode the VPC interface currently belongs to. |
subnet_id | integer | The id of the VPC Subnet for this interface. |
vpc_id | integer | Filterable, Read-only The unique globally general API entity identifier for the VPC. |
active | boolean | Filterable, Read-only Returns true if the VPC interface is in use, meaning that the Linode was powered on using the config_id to which the interface belongs. Otherwise returns false. |
address | string (ip) | Read-only An IPv4 address configured for this VPC interface. These follow the RFC 1918 private address format. Displayed as null if an address_range. (example: 192.0.2.141) |
address_range | string | Read-only A range of IPv4 addresses configured for this VPC interface. Displayed as null if a single address. |
gateway | string (ip) | Read-only The default gateway for the VPC subnet that the IP or IP range belongs to. (example: 192.0.2.1) |
nat_1_1 | string (ip) | Read-only The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn't used. (example: 192.168.0.42) |
prefix | integer | Read-only The number of bits set in the subnet_mask. |
region | string | Filterable, Read-only The region of the VPC. (example: us-east) |
subnet_mask | string (ip) | Read-only The mask that separates host bits from network bits for the address or address_range. (example: 255.255.255.0) |
A paginated list of VPC interface IP addresses.
| Name | Datatype | Description |
|---|---|---|
config_id | integer | Filterable, Read-only The globally general entity identifier for the Linode configuration profile that includes the VPC. If this is a VPC Linode interface, the value is null. |
interface_id | integer | Beta, Read-only The globally general API entity identifier for the Linode interface. |
linode_id | integer | Filterable, Read-only The identifier for the Linode the VPC interface currently belongs to. |
subnet_id | integer | The id of the VPC Subnet for this interface. |
vpc_id | integer | Filterable, Read-only The unique globally general API entity identifier for the VPC. |
active | boolean | Filterable, Read-only Returns true if the VPC interface is in use, meaning that the Linode was powered on using the config_id to which the interface belongs. Otherwise returns false. |
address | string (ip) | Read-only An IPv4 address configured for this VPC interface. These follow the RFC 1918 private address format. Displayed as null if an address_range. (example: 192.0.2.141) |
address_range | string | Read-only A range of IPv4 addresses configured for this VPC interface. Displayed as null if a single address. |
gateway | string (ip) | Read-only The default gateway for the VPC subnet that the IP or IP range belongs to. (example: 192.0.2.1) |
nat_1_1 | string (ip) | Read-only The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn't used. (example: 192.168.0.42) |
prefix | integer | Read-only The number of bits set in the subnet_mask. |
region | string | Filterable, Read-only The region of the VPC. (example: us-east) |
subnet_mask | string (ip) | Read-only The mask that separates host bits from network bits for the address or address_range. (example: 255.255.255.0) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_vpc_ips | select | page, page_size | Returns a paginated list of IP addresses for a single VPC. Learn more... Learn more... | |
get_vpcs_ips | select | page, page_size | Returns a paginated list of all VPC IP addresses and address ranges on your account. > 📘 > > If a Linode has several configuration profiles that include a VPC interface, address information for all of them is listed in the response. Since VPCs can use the same address space, you may see duplicate IP addresses. Learn more... 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 |
|---|---|---|
page | integer | The page of a collection to return. |
page_size | integer | The number of items to return per page. |
SELECT examples
- get_vpc_ips
- get_vpcs_ips
Returns a paginated list of IP addresses for a single VPC.
Learn more...
Learn more...
SELECT
config_id,
interface_id,
linode_id,
subnet_id,
vpc_id,
active,
address,
address_range,
gateway,
nat_1_1,
prefix,
region,
subnet_mask
FROM linode.vpcs.ip_addresses
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';
Returns a paginated list of all VPC IP addresses and address ranges on your account.
> 📘
>
> If a Linode has several configuration profiles that include a VPC interface, address information for all of them is listed in the response. Since VPCs can use the same address space, you may see duplicate IP addresses.
Learn more...
Learn more...
SELECT
config_id,
interface_id,
linode_id,
subnet_id,
vpc_id,
active,
address,
address_range,
gateway,
nat_1_1,
prefix,
region,
subnet_mask
FROM linode.vpcs.ip_addresses
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';