ansible.builtin.bigip_vlan (v2.4.6.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

Manage VLANs on a BIG-IP system

Requirements

• f5-sdk

Usage examples

Scanned by Steampunk Spotter

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

- name: Create VLAN
  bigip_vlan:
      name: "net1"
      password: "secret"
      server: "lb.mydomain.com"
      user: "admin"
      validate_certs: "no"
  delegate_to: localhost

Scanned by Steampunk Spotter

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

- name: Set VLAN tag
  bigip_vlan:
      name: "net1"
      password: "secret"
      server: "lb.mydomain.com"
      tag: "2345"
      user: "admin"
      validate_certs: "no"
  delegate_to: localhost

Scanned by Steampunk Spotter

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

- name: Add VLAN 2345 as tagged to interface 1.1
  bigip_vlan:
      tagged_interface: 1.1
      name: "net1"
      password: "secret"
      server: "lb.mydomain.com"
      tag: "2345"
      user: "admin"
      validate_certs: "no"
  delegate_to: localhost

Scanned by Steampunk Spotter

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

- name: Add VLAN 1234 as tagged to interfaces 1.1 and 1.2
  bigip_vlan:
      tagged_interfaces:
          - 1.1
          - 1.2
      name: "net1"
      password: "secret"
      server: "lb.mydomain.com"
      tag: "1234"
      user: "admin"
      validate_certs: "no"
  delegate_to: localhost

Inputs

    
tag:
    description:
    - Tag number for the VLAN. The tag number can be any integer between 1 and 4094. The
      system automatically assigns a tag number if you do not specify a value.

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

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

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      ssh_keyfile:
        description:
        - Specifies the SSH keyfile to use to authenticate the connection to the remote
          device.  This argument is only used for I(cli) transports.
        - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE).
        type: path
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error.
        type: int
      transport:
        choices:
        - cli
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - The username to connect to the BIG-IP with. This user must have administrative
          privileges on the device.
        - You may omit this option by setting the environment variable C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(no), SSL certificates are not validated. Use this only on personally controlled
          sites using self-signed certificates.
        - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: '2.5'
    version_added_collection: f5networks.f5_modules

description:
    description:
    - The description to give to the VLAN.

tagged_interfaces:
    aliases:
    - tagged_interface
    description:
    - Specifies a list of tagged interfaces and trunks that you want to configure for
      the VLAN. Use tagged interfaces or trunks when you want to assign a single interface
      or trunk to multiple VLANs.
    required: false

untagged_interfaces:
    aliases:
    - untagged_interface
    description:
    - Specifies a list of untagged interfaces and trunks that you want to configure for
      the VLAN.
    required: false

Outputs

description:
  description: The description set on the VLAN
  returned: changed
  sample: foo VLAN
  type: string
interfaces:
  description: Interfaces that the VLAN is assigned to
  returned: changed
  sample:
  - '1.1'
  - '1.2'
  type: list
name:
  description: The name of the VLAN
  returned: changed
  sample: net1
  type: string
partition:
  description: The partition that the VLAN was created on
  returned: changed
  sample: Common
  type: string
tag:
  description: The ID of the VLAN
  returned: changed
  sample: 2345
  type: int