Skip to content

pfsense_interface_group

Orion Poplawski edited this page Jan 13, 2023 · 1 revision

pfsensible.core.pfsense_interface_group


        Manage pfSense interface groups.

ADDED IN: version 0.5.0 of pfsensible.core

OPTIONS (= is mandatory):

- descr
        Description of the interface group.
        default: null
        type: str

= members
        The members of the interface group.
        elements: str
        type: list

= name
        The name of the interface group.
        type: str

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


AUTHOR: Orion Poplawski (@opoplawski)

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

EXAMPLES:

- name: Add interface group
  pfsense_interface_group:
    name: VPN
    members:
      - VPN1
      - VPN2
    descr: All VPN interfaces

- name: Remove interface group
  pfsense_interface_group:
    state: absent
    name: VPN


RETURN VALUES:
- commands
        The set of commands that would be pushed to the remote device
        (if pfSense had a CLI).
        returned: always
        sample: [create interface-group 'VPN', delete interface-group 'VPN']
        type: list

- member_ifnames
        The pseudo-device interface names of all of the members.
        returned: always
        sample: [opt1, opt2]
        type: list