Skip to content

pfsense_rule_separator

Orion Poplawski edited this page Jan 13, 2023 · 2 revisions

pfsensible.core.pfsense_rule_separator


        Manage pfSense firewall rule separators

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

- after
        Rule to go after, or "top"
        default: null
        type: str

- before
        Rule to go before, or "bottom"
        default: null
        type: str

- color
        The separator's color
        choices: [info, warning, danger, success]
        default: info
        type: str

- floating
        Is the rule on floating tab
        default: null
        type: bool

- interface
        The interface for the separator
        default: null
        type: str

= name
        The name of the separator
        type: str

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


AUTHOR: Frederic Bor (@f-bor)

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

EXAMPLES:

- name: Add rule separator voip
  pfsense_rule_separator:
    name: voip
    state: present
    interface: lan_100

- name: Remove rule separator voip
  pfsense_rule_separator:
    name: voip
    state: absent
    interface: lan_100


RETURN VALUES:
- commands
        the set of separators commands that would be pushed to the
        remote device (if pfSense had a CLI)
        returned: success
        sample: ['create rule_separator ''SSH'', interface=''lan'', color=''info''', update rule_separator
            'SSH' set color='warning', delete rule_separator 'SSH']
        type: list