paloaltonetworks.panos.panos_bgp (2.19.1) — module

Install collection

Install with ansible-galaxy collection install paloaltonetworks.panos:==2.19.1

Add to requirements.yml

  collections:
    - name: paloaltonetworks.panos
      version: 2.19.1

Description

Use BGP to publish and consume routes from disparate networks.

Requirements

• pan-python can be obtained from PyPI U(https://pypi.python.org/pypi/pan-python)
• pandevice can be obtained from PyPI U(https://pypi.python.org/pypi/pandevice)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure and enable BGP
  paloaltonetworks.panos.panos_bgp:
    provider: '{{ provider }}'
    router_id: '1.1.1.1'
    local_as: '64512'

Inputs

    
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
    - enabled
    - disabled
    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.
    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.
    type: str

local_as:
    description:
    - Local Autonomous System (AS) number.
    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

as_format:
    choices:
    - 2-byte
    - 4-byte
    default: 2-byte
    description:
    - AS format I('2-byte')/I('4-byte').
    type: str

router_id:
    description:
    - Router ID in IP format (eg. 1.1.1.1)
    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

aggregate_med:
    default: true
    description:
    - Aggregate route only if they have same MED attributes.
    type: bool

ecmp_multi_as:
    default: false
    description:
    - Support multiple AS in ECMP.
    type: bool

install_route:
    default: false
    description:
    - Populate BGP learned route to global route table.
    type: bool

template_stack:
    description:
    - (Panorama only) The template stack this operation should target. Mutually exclusive
      with I(template).
    type: str

enforce_first_as:
    default: true
    description:
    - Enforce First AS for EBGP.
    type: bool

always_compare_med:
    default: false
    description:
    - Always compare MEDs.
    type: bool

global_bfd_profile:
    description:
    - Bidirectional Forwarding Detection (BFD) profile.
    type: str

gr_stale_route_time:
    description:
    - Time to remove stale routes after peer restart (in seconds).
    type: int

reflector_cluster_id:
    description:
    - Route reflector cluster ID.
    type: str

reject_default_route:
    default: true
    description:
    - Reject default route.
    type: bool

gr_local_restart_time:
    description:
    - Local restart time to advertise to peer (in seconds).
    type: int

confederation_member_as:
    description:
    - Confederation requires member-AS number.
    type: str

graceful_restart_enable:
    default: true
    description:
    - Enable graceful restart.
    type: bool

default_local_preference:
    default: 100
    description:
    - Default local preference.
    type: int

gr_max_peer_restart_time:
    description:
    - Maximum of peer restart time accepted (in seconds).
    type: int

allow_redist_default_route:
    default: false
    description:
    - Allow redistribute default route to BGP.
    type: bool

deterministic_med_comparison:
    default: true
    description:
    - Deterministic MEDs comparison.
    type: bool