panos_bgp_aggregate – Configures a BGP Aggregation Prefix Policy

New in version 2.8.

Synopsis

  • Use BGP to publish and consume routes from disparate networks.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_key
string
Deprecated
Use provider to specify PAN-OS connectivity instead.

The API key to use instead of generating it using username / password.
as_set
-
Default:
"no"
Generate AS-set attribute.
attr_as_path_limit
-
Add AS path limit attribute if it does not exist.
attr_as_path_prepend_times
-
Prepend local AS for specified number of times.
attr_as_path_type
-
    Choices:
  • none ←
  • remove
  • prepend
  • remove-and-prepend
AS path update options.
attr_community_argument
-
Argument to the action community value if needed.
attr_community_type
-
    Choices:
  • none ←
  • remove-all
  • remove-regex
  • append
  • overwrite
Community update options.
attr_extended_community_argument
-
Argument to the action extended community value if needed.
attr_extended_community_type
-
    Choices:
  • none ←
  • remove-all
  • remove-regex
  • append
  • overwrite
Extended community update options.
attr_local_preference
-
New Local Preference value.
attr_med
-
New Multi-Exit Discriminator value.
attr_nexthop
-
Next-hop address.
attr_origin
-
    Choices:
  • igp
  • egp
  • incomplete ←
New route origin.
attr_weight
-
New weight value.
commit
-
Default:
"yes"
Commit configuration if changed.
enable
boolean
    Choices:
  • no
  • yes ←
Enable policy.
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 policy.
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.
prefix
-
Aggregating address prefix.
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
    Choices:
  • present ←
  • absent
The state.
summary
-
Summarize route.
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; 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 BGP Aggregation Rule
  panos_bgp_aggregate:
    provider: '{{ provider }}'
    vr_name: 'default'
    name: 'aggr-rule-01'
    prefix: '10.0.0.0/24'
    enable: true
    summary: true

- name: Remove BGP Aggregation Rule
  panos_bgp_aggregate:
    provider: '{{ provider }}'
    vr_name: 'default'
    name: 'aggr-rule-01'
    state: 'absent'

Status

Authors

  • Joshua Colson (@freakinhippie)

  • Garfield Lee Freeman (@shinmog)