pfsense_route

> PFSENSE_ROUTE    (/home/fbor/ansible/lib/ansible/modules/network/pfsense/pfsense_route.py)

        Manage pfSense routes

  * This module is maintained by The Ansible Community
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:
          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:
    descr: vpn_route
    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 route 'vpn_route', gateway='VPN_GW', network='10.100.0.0/16'", "delete route 'vpn_route'"]