pfsense_default_gateway

pfsensible.core.pfsense_default_gateway

        Check and update pfSense default gateway

ADDED IN: version 0.6.0 of pfsensible.core

OPTIONS (= is mandatory):

- gateway
        Default gateway name
        default: null
        type: str

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


AUTHOR: Nicolas Zagulajew (@freeeflyer)

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

EXAMPLES:

- name: Sets default gateway to automatic
  pfsense_default_gateway:
    gateway: automatic
    ipprotocol: inet

- name: Remove gateway (ie setting it to None)
  pfsense_default_gateway:
    gateway: none
    ipprotocol: inet

- name: return gateways
  pfsense_default_gateway:


RETURN VALUES:
- commands
        the set of commands that would be pushed to the remote device
        (if pfSense had a CLI). If state=read, also returns defaultgw4
        and defaultgw6.
        returned: always
        sample: [update default_gateway name='my_gw', protocol='inet6']
        type: list

- defaultgw4
        default gateway for ipv4
        returned: always
        sample: INTERNET_GW4
        type: str

- defaultgw6
        default gateway for ipv6
        returned: always
        sample: INTERNET_GW4
        type: str