pfsense_alias

pfsense_alias

> PFSENSE_ALIAS    (/home/fbor/ansible/lib/ansible/modules/network/pfsense/pfsense_alias.py)

        Manage pfSense aliases

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

- address
        The address of the alias. Use a space separator for multiple values
        [Default: None]
        type: str

- descr
        The description of the alias
        [Default: None]
        type: str

- detail
        The descriptions of the items. Use || separator between items
        [Default: None]
        type: str

= name
        The name of the alias

        type: str

= state
        State in which to leave the alias
        (Choices: present, absent)[Default: present]
        type: str

- type
        The type of the alias
        (Choices: host, network, port, urltable, urltable_ports)[Default: None]
        type: str

- updatefreq
        Update frequency in days for urltable
        [Default: None]
        type: int


AUTHOR: Orion Poplawski (@opoplawski), Frederic Bor (@f-bor)
        METADATA:
          status:
          - preview
          supported_by: community
        

EXAMPLES:

- name: Add adservers alias
  pfsense_alias:
    name: adservers
    address: 10.0.0.1 10.0.0.2
    state: present

- name: Remove adservers alias
  pfsense_alias:
    name: adservers
    state: absent


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 alias 'adservers', type='host', address='10.0.0.1 10.0.0.2'", "update alias 'one_host' set address='10.9.8.7'", "delete alias 'one_alias'"]
diff:
    description: a pair of dicts, before and after, with alias settings before and after task run
    returned: always
    type: dict
    sample: {}