Skip to content

Latest commit

 

History

History
70 lines (53 loc) · 3.16 KB

vlan_list.md

File metadata and controls

70 lines (53 loc) · 3.16 KB
Raw

vlan_list

List and filter on VLANs.

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 of the VLANs for the current Linode Account
  linode.cloud.vlan_list:
    api_version: v4beta
- name: List all VLANs in the us-southeast region
  linode.cloud.vlan_list:
    api_version: v4beta
    filters:
      - name: region
        values: us-southeast

Parameters

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

  • vlans - The returned VLANs.

    • Sample Response: 
      [
   {
   "created": "2020-01-01T00:01:01",
    "label": "vlan-example",
    "linodes": [
        111,
        222
      ],
      "region": "ap-west"
   }
]
    • See the Linode API response documentation for a list of returned fields