paloaltonetworks.panos.panos_static_route module – Manage static routes on PAN-OS devices.

Note

This module is part of the paloaltonetworks.panos collection (version 2.21.2).

To install it, use: ansible-galaxy collection install paloaltonetworks.panos. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: paloaltonetworks.panos.panos_static_route.

New in paloaltonetworks.panos 1.0.0

Synopsis

• Manage static routes on PAN-OS devices.

Requirements

The below requirements are needed on the host that executes this module.

• pan-python can be obtained from PyPI https://pypi.python.org/pypi/pan-python

• pandevice can be obtained from PyPI https://pypi.python.org/pypi/pandevice

Parameters

Parameter	Comments
admin_dist string	Administrative distance for static route.
api_key string	Deprecated Use provider to specify PAN-OS connectivity instead. The API key to use instead of generating it using username / password.
destination string	Destination network. Required if state=present.
enable_path_monitor boolean	Enable path monitor. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
failure_condition string	Path monitor failure condition. Choices: :ansible-option-choices-entry:`"any"` :ansible-option-choices-entry:`"all"`
gathered_filter string	When state=gathered. An advanced filtering option to filter results returned from PAN-OS. Refer to the guide discussing gathered_filter for more information.
interface string	The Interface to use.
ip_address string	Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured.
metric integer	Metric for route. Default: :ansible-option-default:`10`
name string	Name of static route.
nexthop string	Next hop IP address. Required if state=present.
nexthop_type string	Type of next hop. Defaults to “ip-address”. Choices: :ansible-option-choices-entry:`"ip-address"` :ansible-option-choices-entry:`"discard"` :ansible-option-choices-entry:`"none"` :ansible-option-choices-entry:`"next-vr"`
password string	Deprecated Use provider to specify PAN-OS connectivity instead. The password to use for authentication. This is ignored if api_key is specified.
port integer	Deprecated Use provider to specify PAN-OS connectivity instead. The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
preemptive_hold_time integer	Path monitor preemptive hold time in minutes.
provider dictionary added in paloaltonetworks.panos 1.0.0	A dict object containing connection details.
api_key string	The API key to use instead of generating it using username / password.
ip_address string	The IP address or hostname of the PAN-OS device being configured.
password string	The password to use for authentication. This is ignored if api_key is specified.
port integer	The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
serial_number string	The serial number of a firewall to use for targeted commands. If ip_address is not a Panorama PAN-OS device, then this param is ignored.
username string	The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
state string	The state. Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry:`"replaced"` :ansible-option-choices-entry:`"merged"` :ansible-option-choices-entry:`"deleted"` :ansible-option-choices-entry:`"gathered"`
template string	(Panorama only) The template this operation should target. Mutually exclusive with template_stack.
template_stack string	(Panorama only) The template stack this operation should target. Mutually exclusive with template.
username string	Deprecated Use provider to specify PAN-OS connectivity instead. The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
virtual_router string	Virtual router to use. Default: :ansible-option-default:`"default"`

Notes

Note

• Checkmode is supported.

• Panorama is supported.

• IPv6 is not supported.

• PAN-OS connectivity should be specified using provider or the classic PAN-OS connectivity params (ip_address, username, password, api_key, and port). If both are present, then the classic params are ignored.

• If the PAN-OS to be configured is Panorama, either template or template_stack must be specified.

Examples

- 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'

- 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'

- 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'

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

- 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'

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

Authors

• Michael Richardson (@mrichardson03)

• Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)