paloaltonetworks.panos.panos_bgp module – Manage Border Gateway Protocol (BGP)

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.

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.

Parameters

Parameter

Comments

aggregate_med

boolean

Aggregate route only if they have same MED attributes.

Choices:

allow_redist_default_route

boolean

Allow redistribute default route to BGP.

Choices:

always_compare_med

boolean

Always compare MEDs.

Choices:

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_format

string

AS format ‘2-byte’/‘4-byte’.

Choices:

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:

confederation_member_as

string

Confederation requires member-AS number.

default_local_preference

integer

Default local preference.

Default: :ansible-option-default:`100`

deterministic_med_comparison

boolean

Deterministic MEDs comparison.

Choices:

ecmp_multi_as

boolean

Support multiple AS in ECMP.

Choices:

enable

boolean

Enable BGP.

Choices:

enforce_first_as

boolean

Enforce First AS for EBGP.

Choices:

global_bfd_profile

string

Bidirectional Forwarding Detection (BFD) profile.

gr_local_restart_time

integer

Local restart time to advertise to peer (in seconds).

gr_max_peer_restart_time

integer

Maximum of peer restart time accepted (in seconds).

gr_stale_route_time

integer

Time to remove stale routes after peer restart (in seconds).

graceful_restart_enable

boolean

Enable graceful restart.

Choices:

install_route

boolean

Populate BGP learned route to global route table.

Choices:

ip_address

string

Deprecated

Use provider to specify PAN-OS connectivity instead.

The IP address or hostname of the PAN-OS device being configured.

local_as

string

Local Autonomous System (AS) number.

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`

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"`

reflector_cluster_id

string

Route reflector cluster ID.

reject_default_route

boolean

Reject default route.

Choices:

router_id

string

Router ID in IP format (eg. 1.1.1.1)

state

string

The state.

Choices:

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.

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: Configure and enable BGP
  paloaltonetworks.panos.panos_bgp:
    provider: '{{ provider }}'
    router_id: '1.1.1.1'
    local_as: '64512'

Authors

  • Joshua Colson (@freakinhippie)

  • Garfield Lee Freeman (@shinmog)