Skip to content

pfsense_rule_separator

Frederic Bor edited this page Oct 30, 2019 · 2 revisions

pfsense_rule_separator

> PFSENSE_RULE_SEPARATOR    (/home/fbor/ansible/lib/ansible/modules/network/pfsense/pfsense_rule_separator.py)

        Manage pfSense rule separators

  * This module is maintained by The Ansible Community
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

        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:
          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:
    description: the set of separators commands that would be pushed to the remote device (if pfSense had a CLI)
    returned: success
    type: list
    sample: ["create rule_separator 'SSH', interface='lan', color='info'", "update rule_separator 'SSH' set color='warning'", "delete rule_separator 'SSH'"]