Skip to content

vpcs_ipv6_list.md

Latest commit

 

History

History
116 lines (100 loc) · 4.79 KB

vpcs_ipv6_list.md

File metadata and controls

116 lines (100 loc) · 4.79 KB

vpcs_ipv6_list

List and filter on all VPC IPv6 addresses.

NOTE: IPv6 VPCs may not currently be available to all users.

Minimum Required Fields

Field Type Required Description
api_token str Required The Linode account personal access token. It is necessary to run the module.
It can be exposed by the environment variable LINODE_API_TOKEN instead.
See details in Usage.

Examples

- name: List all IPv6 addresses for the current user.
  linode.cloud.vpcs_ipv6_list: {}

Parameters

Field Type Required Description
order str Optional The order to list all VPC IPv6 Addresses in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order all VPC IPv6 Addresses by.
filters (sub-options) list Optional A list of filters to apply to the resulting all VPC IPv6 Addresses.
count int Optional The number of all VPC IPv6 Addresses to return. If undefined, all results will be returned.

filters

Field Type Required Description
name str Required The name of the field to filter on. Valid filterable fields can be found here.
values list Required A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.

Return Values

  • addresses - The returned all VPC IPv6 Addresses.

    • Sample Response: 
      [
  {
    "active": false,
    "address": null,
    "address_range": null,
    "config_id": 123,
    "database_id": null,
    "gateway": null,
    "interface_id": 123,
    "ipv6_addresses": [
      {
        "slaac_address": "2001:db8:acad:1:abcd:ef12:3456:7890"
      }
    ],
    "ipv6_is_public": false,
    "ipv6_range": "2001:db8:acad:1::/64",
    "linode_id": 123,
    "nat_1_1": "",
    "nodebalancer_id": null,
    "prefix": 64,
    "region": "us-mia",
    "subnet_id": 123,
    "subnet_mask": "",
    "vpc_id": 123
  },
  {
    "active": false,
    "address": null,
    "address_range": null,
    "config_id": 123,
    "database_id": null,
    "gateway": null,
    "interface_id": 123,
    "ipv6_addresses": [],
    "ipv6_is_public": false,
    "ipv6_range": "2001:db8::/64",
    "linode_id": 123,
    "nat_1_1": "",
    "nodebalancer_id": null,
    "prefix": 64,
    "region": "us-mia",
    "subnet_id": 271170,
    "subnet_mask": "",
    "vpc_id": 262108
  },
  {
    "active": false,
    "address": null,
    "address_range": null,
    "config_id": 123,
    "database_id": null,
    "gateway": null,
    "interface_id": 123,
    "ipv6_addresses": [],
    "ipv6_is_public": false,
    "ipv6_range": "2001:db8::/64",
    "linode_id": 123,
    "nat_1_1": "",
    "nodebalancer_id": null,
    "prefix": 64,
    "region": "us-mia",
    "subnet_id": 123,
    "subnet_mask": "",
    "vpc_id": 123
  }
]
    • See the Linode API response documentation for a list of returned fields