pfsense_gateway

pfsensible.core.pfsense_gateway

        Manage pfSense gateways

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

- action_disable
        No action will be taken on gateway events. The gateway is
        always considered up.
        default: false
        type: bool

- descr
        The description of the gateway
        default: ''
        type: str

- disabled
        Set this option to disable this gateway without removing it
        from the list.
        default: false
        type: bool

- force_down
        This will force this gateway to be considered down.
        default: false
        type: bool

- gateway
        Gateway IP address
        default: null
        type: str

- interface
        Choose which interface this gateway applies to.
        default: null
        type: str

- ipprotocol
        Choose the Internet Protocol this gateway uses.
        choices: [inet, inet6]
        default: inet
        type: str

- monitor
        Enter an alternative address here to be used to monitor the
        link.
        default: null
        type: str

- monitor_disable
        This will consider this gateway as always being up.
        default: false
        type: bool

= name
        Gateway name
        type: str

- nonlocalgateway
        This will allow use of a gateway outside of this interface's
        subnet.
        This is usually indicative of a configuration error, but is
        required for some scenarios.
        default: false
        type: bool

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

- weight
        Weight for this gateway when used in a Gateway Group. Must be
        between 1 and 30.
        default: 1
        type: int


AUTHOR: Frederic Bor (@f-bor)

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

EXAMPLES:

- name: Add gateway
  pfsense_gateway:
    name: default_gw
    interface: wan
    gateway: 1.2.3.4
    state: present

- name: Remove gateway
  pfsense_gateway:
    name: vpn_gw
    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 gateway ''default_gw'', interface=''wan'', address=''1.2.3.4''', delete gateway
            'vpn_gw']
        type: list