panos_static_route – Create static routes on PAN-OS devices¶
New in version 2.6.
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 | Choices/Defaults | Comments | |
---|---|---|---|
admin_dist
-
|
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
-
|
Destination network. Required if state is present.
|
||
interface
-
|
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
-
|
Default: 10
|
Metric for route.
|
|
name
-
/ required
|
Name of static route.
|
||
nexthop
-
|
Next hop IP address. Required if state is present.
|
||
nexthop_type
-
|
|
Type of next hop.
|
|
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
|
Default: 443
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The port number to connect to the PAN-OS device on.
|
|
provider
-
added in 2.8 |
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
|
Default: 443
|
The port number to connect to the PAN-OS device on.
|
|
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
|
Default: admin
|
The username to use for authentication. This is ignored if api_key is specified.
|
|
state
string
|
|
The state.
|
|
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
|
Default: admin
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The username to use for authentication. This is ignored if api_key is specified.
|
|
virtual_router
-
|
Default: default
|
Virtual router to use.
|
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'
panos_static_route:
provider: '{{ provider }}'
name: 'Test-One'
destination: '1.1.1.0/24'
nexthop: '10.0.0.1'
- name: Create route 'Test-Two'
panos_static_route:
provider: '{{ provider }}'
name: 'Test-Two'
destination: '2.2.2.0/24'
nexthop: '10.0.0.1'
- name: Create route 'Test-Three'
panos_static_route:
provider: '{{ provider }}'
name: 'Test-Three'
destination: '3.3.3.0/24'
nexthop: '10.0.0.1'
- name: Delete route 'Test-Two'
panos_static_route:
provider: '{{ provider }}'
name: 'Test-Two'
state: 'absent'
- name: Create route 'Test-Four'
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'
panos_static_route:
provider: '{{ provider }}'
name: 'Test-Five'
destination: '5.5.5.0/24'
nexthop_type: 'none'
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community.
Authors¶
Michael Richardson (@mrichardson03)