pfsense_vlan

pfsensible.core.pfsense_vlan

        Manage pfSense VLANs

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

- descr
        The description of the VLAN
        default: ''
        type: str

= interface
        The interface on which to declare the VLAN. Friendly name
        (assignments) can be used.
        type: str

- priority
        802.1Q VLAN Priority code point. Must be between 0 and 7.
        default: null
        type: int

- state
        State in which to leave the VLAN
        choices: [present, absent]
        default: present
        type: str

= vlan_id
        The VLAN tag. Must be between 1 and 4094.
        type: int


AUTHOR: Frederic Bor (@f-bor)

METADATA:
  metadata_version: '1.1'
  status:
  - preview
  supported_by: community

EXAMPLES:

- name: Add voice VLAN
  pfsense_vlan:
    interface: mvneta0
    vlan_id: 100
    descr: voice
    priority: 5
    state: present

- name: Remove voice VLAN
  pfsense_vlan:
    interface: mvneta0
    vlan_id: 100
    state: absent


RETURN VALUES:
- commands
        the set of commands that would be pushed to the remote device
        (if pfSense had a CLI)
        returned: always
        sample: ['create vlan ''mvneta.100'', descr=''voice'', priority=''5''', 'update vlan ''mvneta.100'',
            set priority=''6''', delete vlan 'mvneta.100']
        type: list