Skip to content

Latest commit

 

History

History
67 lines (52 loc) · 3.43 KB

vpc_ip_list.md

File metadata and controls

67 lines (52 loc) · 3.43 KB
Raw

vpc_ip_list

List and filter on VPC IP Addresses.

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 IPs of a specific VPC.
  linode.cloud.vpc_ip_list:
    vpc_id: 12345

Parameters

Field Type Required Description
vpc_id int Required The parent VPC for the VPC IP Addresses.
order str Optional The order to list VPC IP Addresses in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order VPC IP Addresses by.
filters (sub-options) list Optional A list of filters to apply to the resulting VPC IP Addresses.
count int Optional The number of VPC IP 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

  • vpcs_ips - The returned VPC IP Addresses.

    • Sample Response: 
      [
    {
        "address": "10.0.0.2",
        "address_range": null,
        "vpc_id": 56242,
        "subnet_id": 55829,
        "region": "us-mia",
        "linode_id": 57328104,
        "config_id": 60480976,
        "interface_id": 1373818,
        "active": false,
        "nat_1_1": null,
        "gateway": "10.0.0.1",
        "prefix": 24,
        "subnet_mask": "255.255.255.0"
    }
]
    • See the Linode API response documentation for a list of returned fields