pfsense_route

pfsensible.core.pfsense_route

        Manage pfSense routes

ADDED IN: version 0.1.0 of pfsensible.core

OPTIONS (= is mandatory):

= descr
        The description of the route
        type: str

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

- gateway
        Gateway this route applies to
        default: null
        type: str

- network
        Destination network for this static route
        default: null
        type: str

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


AUTHOR: Frederic Bor (@f-bor)

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

EXAMPLES:

- name: Add route
  pfsense_route:
    descr: vpn_route
    gateway: VPN_GW
    network: 10.100.0.0/16
    state: present

- name: Remove route
  pfsense_route:
    name: vpn_route
    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 route ''vpn_route'', gateway=''VPN_GW'', network=''10.100.0.0/16''', delete
            route 'vpn_route']
        type: list