paloaltonetworks / paloaltonetworks.panos / 2.19.1 / module / panos_bgp_peer Manage a BGP Peer | "added in version" 1.0.0 of paloaltonetworks.panos" Authors: Joshua Colson (@freakinhippie), Garfield Lee Freeman (@shinmog)paloaltonetworks.panos.panos_bgp_peer (2.19.1) — module
Install with ansible-galaxy collection install paloaltonetworks.panos:==2.19.1
collections: - name: paloaltonetworks.panos version: 2.19.1
Use BGP to publish and consume routes from disparate networks.
- 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
name: description: - Name of BGP Peer. type: str port: default: 443 description: - B(Deprecated) - Use I(provider) to specify PAN-OS connectivity instead. - HORIZONTALLINE - The port number to connect to the PAN-OS device on. type: int state: choices: - present - absent - replaced - merged - deleted - gathered default: present description: - The state. type: str commit: description: - B(Deprecated) - Please use M(paloaltonetworks.panos.panos_commit_firewall), M(paloaltonetworks.panos.panos_commit_panorama), M(paloaltonetworks.panos.panos_commit_push) instead. - HORIZONTALLINE - Commit changes after creating object. If I(ip_address) is a Panorama device, and I(device_group) or I(template) are also set, perform a commit to Panorama and a commit-all to the device group/template. type: bool enable: default: true description: - Enable BGP Peer. type: bool api_key: description: - B(Deprecated) - Use I(provider) to specify PAN-OS connectivity instead. - HORIZONTALLINE - The API key to use instead of generating it using I(username) / I(password). type: str peer_as: description: - Peer AS number. type: str vr_name: default: default description: - Name of the virtual router; it must already exist; see M(paloaltonetworks.panos.panos_virtual_router). type: str password: description: - B(Deprecated) - Use I(provider) to specify PAN-OS connectivity instead. - HORIZONTALLINE - The password to use for authentication. This is ignored if I(api_key) is specified. type: str provider: description: - A dict object containing connection details. suboptions: api_key: description: - The API key to use instead of generating it using I(username) / I(password). type: str ip_address: description: - The IP address or hostname of the PAN-OS device being configured. type: str password: description: - The password to use for authentication. This is ignored if I(api_key) is specified. type: str port: default: 443 description: - The port number to connect to the PAN-OS device on. type: int serial_number: description: - The serial number of a firewall to use for targeted commands. If I(ip_address) is not a Panorama PAN-OS device, then this param is ignored. type: str username: default: admin description: - The username to use for authentication. This is ignored if I(api_key) is specified. type: str type: dict version_added: 1.0.0 version_added_collection: paloaltonetworks.panos template: description: - (Panorama only) The template this operation should target. Mutually exclusive with I(template_stack). type: str username: default: admin description: - B(Deprecated) - Use I(provider) to specify PAN-OS connectivity instead. - HORIZONTALLINE - The username to use for authentication. This is ignored if I(api_key) is specified. type: str ip_address: description: - B(Deprecated) - Use I(provider) to specify PAN-OS connectivity instead. - HORIZONTALLINE - The IP address or hostname of the PAN-OS device being configured. type: str peer_group: description: - Name of the peer group; it must already exist; see M(paloaltonetworks.panos.panos_bgp_peer_group). required: true type: str bfd_profile: description: - BFD profile configuration. type: str max_prefixes: description: - Maximum of prefixes to receive from peer. type: int peering_type: choices: - unspecified - bilateral description: - Peering type. type: str enable_mp_bgp: description: - Enable MP-BGP extentions. type: bool template_stack: description: - (Panorama only) The template stack this operation should target. Mutually exclusive with I(template). type: str gathered_filter: description: - When I(state=gathered). - An advanced filtering option to filter results returned from PAN-OS. - Refer to the guide discussing I(gathered_filter) for more information. type: str local_interface: description: - Interface to accept BGP session. type: str peer_address_ip: description: - IP address of peer. type: str reflector_client: choices: - non-client - client - meshed-client description: - Reflector client type. type: str local_interface_ip: description: - Specify exact IP address if interface has multiple addresses. type: str connection_multihop: description: - IP TTL value used for sending BGP packet. set to 0 means eBGP use 2, iBGP use 255. type: int connection_hold_time: description: - Hold time (in seconds). type: int address_family_identifier: choices: - ipv4 - ipv6 description: - Peer address family type. type: str connection_authentication: description: - BGP auth profile name. type: str connection_idle_hold_time: description: - Idle hold time (in seconds). type: int connection_incoming_allow: description: - Allow incoming connections. type: bool connection_outgoing_allow: description: - Allow outgoing connections. type: bool connection_open_delay_time: description: - Open delay time (in seconds). type: int subsequent_address_unicast: description: - Select SAFI for this peer. type: bool subsequent_address_multicast: description: - Select SAFI for this peer. type: bool connection_keep_alive_interval: description: - Keep-alive interval (in seconds). type: int connection_outgoing_local_port: description: - Use specific local port for outgoing BGP connections. type: int connection_incoming_remote_port: description: - Restrict remote port for incoming BGP connections. type: int connection_min_route_adv_interval: description: - Minimum Route Advertisement Interval (in seconds). type: int enable_sender_side_loop_detection: description: - Enable sender side loop detection. type: bool