arraynetworks.array_modules.apv_vlan (1.0.3) — module

Install collection

Install with ansible-galaxy collection install arraynetworks.array_modules:==1.0.3

Add to requirements.yml

  collections:
    - name: arraynetworks.array_modules
      version: 1.0.3

Description

Manage VLANs on a APV system

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add VLAN 2345 as tagged to interface port1
  apv_vlan:
    interface: port1
    name: net1
    tag: 2345
    mtu: 1400
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
mtu:
    description:
    - Specifies the maximum transmission unit (MTU) for traffic on this VLAN. When creating
      a new VLAN, if this parameter is not specified, the default value used is C(1500).
    - This number must be between 72 to 65535.
    type: int

tag:
    description:
    - Tag number for the VLAN. The tag number can be any integer between 1 and 4094.
    type: int

name:
    description:
    - The VLAN to manage. If the special VLAN C(ALL) is specified with the C(state) value
      of C(absent), all VLANs will be removed.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state of the VLAN on the system. When C(present), guarantees the VLAN exists
      with the provided attributes. When C(absent), removes the VLAN from the system.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      password:
        description:
        - The password for the user account used to connect to the APV.
        - You may omit this option by setting the environment variable C(ARRAY_PASSWORD).
        required: true
        type: str
      protocol:
        choices:
        - http
        - https
        default: https
        description:
        - The protocol to connect to the remote device.
        - You may omit this option by setting the environment variable C(ARRAY_PROTOCOL).
        type: str
      server:
        description:
        - The APV host.
        - You may omit this option by setting the environment variable C(ARRAY_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The APV server port.
        - You may omit this option by setting the environment variable C(ARRAY_SERVER_PORT).
        type: int
      user:
        description:
        - The username to connect to the APV with. This user must be in API level on the
          device.
        - You may omit this option by setting the environment variable C(ARRAY_USER).
        required: true
        type: str
    type: dict
    version_added: 1.0.0
    version_added_collection: arraynetworks.array_modules

interface:
    description:
    - "Specify the system interface name, which, by default, is port1, port2, port3, port4,\
      \ etc. (Administrators can self-define the system interface name by using the command\
      \ \u201Cinterface name\u201D."
    - "Specify the bond interface name, which, by default, is bond1, bond2, bond3, bond4,\
      \ etc. (Administrators can self-define the bond interface name by using the command\
      \ \u201Cbond name\u201D."
    type: str

description:
    description:
    - The description of the VLAN.
    type: str

Outputs

interface:
  description: Interfaces the VLAN is assigned to.
  returned: changed
  sample: port1
  type: str
tag:
  description: The ID of the VLAN.
  returned: changed
  sample: 2345
  type: int