panos_bgp_policy_filter – Configures a BGP Policy Import/Export Rule¶
New in version 2.9.
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 | |
---|---|---|---|
address_prefix
list
|
List of address prefix strings or dicts with "name"/"exact" keys.
Using the dict form for address prefixes should only be used with policy_type=aggregate.
|
||
api_key
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The API key to use instead of generating it using username / password.
|
||
commit
boolean
|
|
Commit configuration if changed.
|
|
enable
boolean
|
|
Enable filter.
|
|
filter_type
-
/ required
|
|
The type of filter.
|
|
ip_address
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
|
||
match_afi
-
|
|
Address Family Identifier.
|
|
match_as_path_regex
-
|
AS-path regular expression.
|
||
match_community_regex
-
|
Community AS-path regular expression.
|
||
match_extended_community_regex
-
|
Extended Community AS-path regular expression.
|
||
match_from_peer
-
|
Filter by peer that sent this route.
|
||
match_med
-
|
Multi-Exit Discriminator.
|
||
match_nexthop
-
|
Next-hop attributes.
|
||
match_route_table
-
|
|
Route table to match rule.
|
|
match_safi
-
|
|
Subsequent Address Family Identifier.
|
|
name
-
/ required
|
Name of filter.
|
||
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.
|
||
policy_name
-
|
The name of the policy object.
|
||
policy_type
-
/ required
|
|
The type of policy object.
|
|
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
-
|
|
Add or remove BGP Policy Filter.
state=return-object is deprecated and will be removed in 2.12.
|
|
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.
|
|
vr_name
-
|
Default: default
|
Name of the virtual router; it must already exist and have BGP configured.
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.
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
panos_obj
string
|
success |
a serialized policy filter is returned when state == 'return-object'
Sample:
LUFRPT14MW5xOEo1R09KVlBZNnpnemh0VHRBOWl6TGM9bXcwM3JHUGVhRlNiY0dCR0srNERUQT09
|
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)