/ home / paloaltonetworks / paloaltonetworks.panos / 2.19.1 / module / panos_static_route

paloaltonetworks.panos.panos_static_route (2.19.1) — module

Manage static routes on PAN-OS devices.

| "added in version" 1.0.0 of paloaltonetworks.panos"

Authors: Michael Richardson (@mrichardson03), Garfield Lee Freeman (@shinmog)

Install collection

Install with ansible-galaxy collection install paloaltonetworks.panos:==2.19.1

Add to requirements.yml

  collections:
    - name: paloaltonetworks.panos
      version: 2.19.1

Description

Manage static routes on PAN-OS devices.

Requirements

pan-python can be obtained from PyPI U(https://pypi.python.org/pypi/pan-python)
pandevice can be obtained from PyPI U(https://pypi.python.org/pypi/pandevice)

Usage examples

Scanned by Steampunk Spotter

- name: Create route 'Test-One'
  paloaltonetworks.panos.panos_static_route:
    provider: '{{ provider }}'
    name: 'Test-One'
    destination: '1.1.1.0/24'
    nexthop: '10.0.0.1'

Scanned by Steampunk Spotter

- name: Create route 'Test-Two'
  paloaltonetworks.panos.panos_static_route:
    provider: '{{ provider }}'
    name: 'Test-Two'
    destination: '2.2.2.0/24'
    nexthop: '10.0.0.1'

Scanned by Steampunk Spotter

- name: Create route 'Test-Three'
  paloaltonetworks.panos.panos_static_route:
    provider: '{{ provider }}'
    name: 'Test-Three'
    destination: '3.3.3.0/24'
    nexthop: '10.0.0.1'

Scanned by Steampunk Spotter

- name: Delete route 'Test-Two'
  paloaltonetworks.panos.panos_static_route:
    provider: '{{ provider }}'
    name: 'Test-Two'
    state: 'absent'

Scanned by Steampunk Spotter

- name: Create route 'Test-Four'
  paloaltonetworks.panos.panos_static_route:
    provider: '{{ provider }}'
    name: 'Test-Four'
    destination: '4.4.4.0/24'
    nexthop: '10.0.0.1'
    virtual_router: 'VR-Two'

Scanned by Steampunk Spotter

- name: Create route 'Test-Five'
  paloaltonetworks.panos.panos_static_route:
    provider: '{{ provider }}'
    name: 'Test-Five'
    destination: '5.5.5.0/24'
    nexthop_type: 'none'

Inputs

    
name:
    description:
    - Name of static route.
    type: str

port:
    default: 443
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The port number to connect to the PAN-OS device on.
    type: int

state:
    choices:
    - present
    - absent
    - replaced
    - merged
    - deleted
    - gathered
    default: present
    description:
    - The state.
    type: str

metric:
    default: '10'
    description:
    - Metric for route.
    type: int

api_key:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The API key to use instead of generating it using I(username) / I(password).
    type: str

nexthop:
    description:
    - Next hop IP address.  Required if I(state=present).
    type: str

password:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The password to use for authentication.  This is ignored if I(api_key) is specified.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      api_key:
        description:
        - The API key to use instead of generating it using I(username) / I(password).
        type: str
      ip_address:
        description:
        - The IP address or hostname of the PAN-OS device being configured.
        type: str
      password:
        description:
        - The password to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
      port:
        default: 443
        description:
        - The port number to connect to the PAN-OS device on.
        type: int
      serial_number:
        description:
        - The serial number of a firewall to use for targeted commands. If I(ip_address)
          is not a Panorama PAN-OS device, then this param is ignored.
        type: str
      username:
        default: admin
        description:
        - The username to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
    type: dict
    version_added: 1.0.0
    version_added_collection: paloaltonetworks.panos

template:
    description:
    - (Panorama only) The template this operation should target. Mutually exclusive with
      I(template_stack).
    type: str

username:
    default: admin
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The username to use for authentication.  This is ignored if I(api_key) is specified.
    type: str

interface:
    description:
    - The Interface to use.
    type: str

admin_dist:
    description:
    - Administrative distance for static route.
    type: str

ip_address:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The IP address or hostname of the PAN-OS device being configured.
    type: str

destination:
    description:
    - Destination network.  Required if I(state=present).
    type: str

nexthop_type:
    choices:
    - ip-address
    - discard
    - none
    - next-vr
    default: ip-address
    description:
    - Type of next hop.
    type: str

template_stack:
    description:
    - (Panorama only) The template stack this operation should target. Mutually exclusive
      with I(template).
    type: str

virtual_router:
    default: default
    description:
    - Virtual router to use.
    type: str

gathered_filter:
    description:
    - When I(state=gathered).
    - An advanced filtering option to filter results returned from PAN-OS.
    - Refer to the guide discussing I(gathered_filter) for more information.
    type: str

failure_condition:
    choices:
    - any
    - all
    description:
    - Path monitor failure condition.
    type: str

enable_path_monitor:
    description:
    - Enable path monitor.
    type: bool

preemptive_hold_time:
    description:
    - Path monitor preemptive hold time in minutes.
    type: int