Skip to content
This repository has been archived by the owner on Jan 6, 2023. It is now read-only.

pfsense_vlan

Frederic Bor edited this page Oct 30, 2019 · 1 revision

pfsense_vlan

> PFSENSE_VLAN    (/home/fbor/ansible/lib/ansible/modules/network/pfsense/pfsense_vlan.py)

        Manage pfSense vlans

  * This module is maintained by The Ansible Community
OPTIONS (= is mandatory):

- descr
        The description of the vlan
        [Default: None]
        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:
          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


RETURN VALUES:

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