paloaltonetworks / paloaltonetworks.panos / 2.19.1 / module / panos_bgp_peer_group Manage a BGP Peer Group | "added in version" 1.0.0 of paloaltonetworks.panos" Authors: Joshua Colson (@freakinhippie), Garfield Lee Freeman (@shinmog)paloaltonetworks.panos.panos_bgp_peer_group (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 Group paloaltonetworks.panos.panos_bgp_peer_group: provider: '{{ provider }}' name: 'peer-group-1' enable: true aggregated_confed_as_path: true soft_reset_with_stored_info: false
name: description: - Name of the BGP peer group. 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 type: choices: - ebgp - ibgp - ebgp-confed - ibgp-confed default: ebgp description: - Peer group type. type: str 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 group. 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 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 export_nexthop: choices: - original - resolve - use-self default: resolve description: - Export locally resolved nexthop. type: str import_nexthop: choices: - original - use-peer default: original description: - I(type=ebgp) only; override nexthop with peer address. type: str 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 remove_private_as: description: - I(type=ebgp) only; remove private AS when exporting route. type: bool aggregated_confed_as_path: description: - The peers understand Aggregated Confederation AS Path. type: bool soft_reset_with_stored_info: description: - Enable soft reset with stored info. type: bool