wojtek0806.f5os.f5os_vlan (0.3.0) — module

Install collection

Install with ansible-galaxy collection install wojtek0806.f5os:==0.3.0

Add to requirements.yml

  collections:
    - name: wojtek0806.f5os
      version: 0.3.0

Description

Manage VLANs on F5OS based systems like VELOS partitions or rSeries platforms.

Usage examples

Scanned by Steampunk Spotter

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

- hosts: all
  collections:
    - f5networks.f5os
  connection: httpapi

  vars:
    ansible_host: "lb.mydomain.com"
    ansible_user: "admin"
    ansible_httpapi_password: "secret"
    ansible_network_os: f5networks.f5os.f5os
    ansible_httpapi_use_ssl: yes

  tasks:
    - name: Create a vlan on partition
      f5os_vlan:
        name: foo
        vlan_id: 3212

    - name: Update name of a vlan on partition
      f5os_vlan:
        name: changed_this
        vlan_id: 3212

    - name: Delete vlan on partition
      f5os_vlan:
        vlan_id: 3212
        state: absent

Inputs

    
name:
    description:
    - Specifies the name of the VLAN to configure on the F5OS platform.
    - This parameter is required when creating a resource.
    - The first character must be a letter, alphanumeric characters are allowed.
    - Periods, commas, hyphens, and underscores are allowed.
    - The name cannot exceed 58 characters.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The partition VLAN state.
    - If C(present), creates the specified VLAN if it does not exist, or updates the existing
      VLAN.
    - If C(absent), deletes the VLAN if it exists.
    type: str

vlan_id:
    description:
    - The ID for the VLAN.
    - Valid value range is from C(0) to C(4095).
    required: true
    type: int

Outputs

name:
  description: The name of the VLAN.
  returned: changed
  sample: new_name
  type: str
vlan_id:
  description: The ID of the VLAN.
  returned: changed
  sample: 1234
  type: int