paloaltonetworks.panos.panos_bgp_peer module – Manage a BGP Peer

Note

This module is part of the paloaltonetworks.panos collection (version 2.19.1).

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

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

address_family_identifier

string

Peer address family type.

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.

bfd_profile

string

BFD profile configuration.

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:

connection_authentication

string

BGP auth profile name.

connection_hold_time

integer

Hold time (in seconds).

connection_idle_hold_time

integer

Idle hold time (in seconds).

connection_incoming_allow

boolean

Allow incoming connections.

Choices:

connection_incoming_remote_port

integer

Restrict remote port for incoming BGP connections.

connection_keep_alive_interval

integer

Keep-alive interval (in seconds).

connection_min_route_adv_interval

integer

Minimum Route Advertisement Interval (in seconds).

connection_multihop

integer

IP TTL value used for sending BGP packet. set to 0 means eBGP use 2, iBGP use 255.

connection_open_delay_time

integer

Open delay time (in seconds).

connection_outgoing_allow

boolean

Allow outgoing connections.

Choices:

connection_outgoing_local_port

integer

Use specific local port for outgoing BGP connections.

enable

boolean

Enable BGP Peer.

Choices:

enable_mp_bgp

boolean

Enable MP-BGP extentions.

Choices:

enable_sender_side_loop_detection

boolean

Enable sender side loop detection.

Choices:

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.

local_interface

string

Interface to accept BGP session.

local_interface_ip

string

Specify exact IP address if interface has multiple addresses.

max_prefixes

integer

Maximum of prefixes to receive from peer.

name

string

Name of BGP Peer.

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.

peer_address_ip

string

IP address of peer.

peer_as

string

Peer AS number.

peer_group

string / required

Name of the peer group; it must already exist; see paloaltonetworks.panos.panos_bgp_peer_group.

peering_type

string

Peering type.

Choices:

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_client

string

Reflector client type.

Choices:

state

string

The state.

Choices:

subsequent_address_multicast

boolean

Select SAFI for this peer.

Choices:

subsequent_address_unicast

boolean

Select SAFI for this peer.

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; 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 Peer
  paloaltonetworks.panos.panos_bgp_peer:
    provider: '{{ provider }}'
    peer_group: 'peer-group-1'
    name: 'peer-1'
    enable: true
    local_interface: 'ethernet1/1'
    local_interface_ip: '192.168.1.1'
    peer_address_ip: '10.1.1.1'
    peer_as: '64512'
    commit: true

Authors

  • Joshua Colson (@freakinhippie)

  • Garfield Lee Freeman (@shinmog)