panos_redistribution – Configures a Redistribution Profile on a virtual router¶
New in version 2.8.
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 | |
---|---|---|---|
action
-
|
|
Rule action.
|
|
api_key
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The API key to use instead of generating it using username / password.
|
||
bgp_filter_community
-
|
BGP filter on community.
|
||
bgp_filter_extended_community
-
|
BGP filter on extended community.
|
||
commit
boolean
|
|
Commit configuration if changed.
|
|
filter_destination
-
|
Filter destination.
|
||
filter_interface
-
|
Filter interface.
|
||
filter_nexthop
-
|
Filter nexthop.
|
||
filter_type
-
|
Any of 'static', 'connect', 'rip', 'ospf', or 'bgp'.
|
||
ip_address
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
|
||
name
-
/ required
|
Name of rule.
|
||
ospf_filter_area
-
|
OSPF filter on area.
|
||
ospf_filter_pathtype
-
|
Any of 'intra-area', 'inter-area', 'ext-1', or 'ext-2'.
|
||
ospf_filter_tag
-
|
OSPF filter on tag.
|
||
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.
|
|
priority
integer
|
Priority ID.
|
||
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.
|
||
type
-
|
|
Name of rule.
|
|
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.
|
|
vr_name
-
|
Default: default
|
Name of the virtual router; it must already exist; see panos_virtual_router.
|
Notes¶
Note
Checkmode is supported.
Panorama is 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 Redistribution Profile
panos_redistribution:
provider: '{{ provider }}'
name: 'my-profile'
priority: 42
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community.
Authors¶
Joshua Colson (@freakinhippie)