paloaltonetworks.panos.panos_bgp_aggregate module – Manage a BGP Aggregation Prefix Policy

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_bgp_aggregate.

New in paloaltonetworks.panos 1.0.0

Synopsis

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

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
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 boolean	Generate AS-set attribute. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
attr_as_path_limit integer	Add AS path limit attribute if it does not exist.
attr_as_path_prepend_times integer	Prepend local AS for specified number of times.
attr_as_path_type string	AS path update options. Choices: :ansible-option-choices-entry-default:`"none"` ← (default) :ansible-option-choices-entry:`"remove"` :ansible-option-choices-entry:`"prepend"` :ansible-option-choices-entry:`"remove-and-prepend"`
attr_community_argument string	Argument to the action community value if needed.
attr_community_type string	Community update options. Choices: :ansible-option-choices-entry-default:`"none"` ← (default) :ansible-option-choices-entry:`"remove-all"` :ansible-option-choices-entry:`"remove-regex"` :ansible-option-choices-entry:`"append"` :ansible-option-choices-entry:`"overwrite"`
attr_extended_community_argument string	Argument to the action extended community value if needed.
attr_extended_community_type string	Extended community update options. Choices: :ansible-option-choices-entry-default:`"none"` ← (default) :ansible-option-choices-entry:`"remove-all"` :ansible-option-choices-entry:`"remove-regex"` :ansible-option-choices-entry:`"append"` :ansible-option-choices-entry:`"overwrite"`
attr_local_preference integer	New Local Preference value.
attr_med integer	New Multi-Exit Discriminator value.
attr_nexthop list / elements=string	Next-hop address.
attr_origin string	New route origin. Choices: :ansible-option-choices-entry:`"igp"` :ansible-option-choices-entry:`"egp"` :ansible-option-choices-entry-default:`"incomplete"` ← (default)
attr_weight integer	New weight value.
commit boolean	Deprecated Please use paloaltonetworks.panos.panos_commit_firewall, paloaltonetworks.panos.panos_commit_panorama, paloaltonetworks.panos.panos_commit_push instead. Commit changes after creating object. If ip_address is a Panorama device, and device_group or template are also set, perform a commit to Panorama and a commit-all to the device group/template. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enable boolean	Enable policy. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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.
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 string	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	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`
prefix string	Aggregating address prefix.
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"`
summary boolean	Summarize route. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
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"`
vr_name string	Name of the virtual router, it must already exist. See paloaltonetworks.panos.panos_virtual_router. Default: :ansible-option-default:`"default"`

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
  paloaltonetworks.panos.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
  paloaltonetworks.panos.panos_bgp_aggregate:
    provider: '{{ provider }}'
    vr_name: 'default'
    name: 'aggr-rule-01'
    state: 'absent'

Authors

• Joshua Colson (@freakinhippie)

• Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)