Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.04 KB

vlan_info.md

File metadata and controls

51 lines (37 loc) · 2.04 KB

vlan_info

Get info about a Linode VLAN.

⚠️ This module makes use of beta endpoints and requires the api_version field be explicitly set to v4beta.

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
label str Required The VLAN’s label.

Return Values

  • vlan - The VLAN in JSON serialized form.

    • 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