pfsense_alias

pfsensible.core.pfsense_alias

        Manage pfSense aliases

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

- address
        The address of the alias. Use a space separator for multiple
        values
        default: null
        type: str

- descr
        The description of the alias
        default: null
        type: str

- detail
        The descriptions of the items. Use || separator between items
        default: null
        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: null
        type: str

- updatefreq
        Update frequency in days for urltable
        default: null
        type: int


AUTHOR: Orion Poplawski (@opoplawski), Frederic Bor (@f-bor)

METADATA:
  metadata_version: '1.1'
  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
        the set of commands that would be pushed to the remote device
        (if pfSense had a CLI)
        returned: always
        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']
        type: list

- diff
        a pair of dicts, before and after, with alias settings before
        and after task run
        returned: always
        sample: {}
        type: dict