Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 2.05 KB

vlan_info.md

File metadata and controls

50 lines (37 loc) · 2.05 KB

vlan_info

Get info about a Linode VLAN.

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: Get info about a VLAN by label
  linode.cloud.vlan_info:
    api_version: v4beta
    label: example-vlan

Parameters

Field Type Required Description
id int Optional The ID of the VLAN to resolve. (Conflicts With: label)
label str Optional The label of the VLAN to resolve. (Conflicts With: id)

Return Values

  • vlan - The returned VLAN.

    • 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