panos_bgp_peer – Configures a BGP Peer

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
address_family_identifier
-
    Choices:
  • ipv4
  • ipv6
Peer address family type.
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
-
BFD profile configuration.
commit
-
Default:
"yes"
Commit configuration if changed.
connection_authentication
-
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
    Choices:
  • no
  • yes
Allow incoming connections.
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
    Choices:
  • no
  • yes
Allow outgoing connections.
connection_outgoing_local_port
integer
Use specific local port for outgoing BGP connections.
enable
boolean
    Choices:
  • no
  • yes ←
Enable BGP Peer.
enable_mp_bgp
boolean
    Choices:
  • no
  • yes
Enable MP-BGP extentions.
enable_sender_side_loop_detection
boolean
    Choices:
  • no
  • yes
Enable sender side loop detection.
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
-
Interface to accept BGP session.
local_interface_ip
-
Specify exact IP address if interface has multiple addresses.
max_prefixes
integer
Maximum of prefixes to receive from peer.
name
- / required
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
-
IP address of peer.
peer_as
-
Peer AS number.
peer_group
- / required
Name of the peer group; it must already exist; see panos_bgp_peer_group.
peering_type
-
    Choices:
  • unspecified
  • bilateral
Peering type.
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.
reflector_client
-
    Choices:
  • non-client
  • client
  • meshed-client
Reflector client type.
state
string
    Choices:
  • present ←
  • absent
The state.
subsequent_address_multicast
boolean
    Choices:
  • no
  • yes
Select SAFI for this peer.
subsequent_address_unicast
boolean
    Choices:
  • no
  • yes
Select SAFI for this peer.
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 Peer
  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

Status

Authors

  • Joshua Colson (@freakinhippie)

  • Garfield Lee Freeman (@shinmog)