cisco.aci.aci_l3out_bgp_peer module – Manage Layer 3 Outside (L3Out) BGP Peers (bgp:PeerP)

Note

This module is part of the cisco.aci collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.aci.

To use it in a playbook, specify: cisco.aci.aci_l3out_bgp_peer.

Synopsis

  • Manage L3Out BGP Peers on Cisco ACI fabrics.

Parameters

Parameter

Comments

address_type_controls

list / elements=string

Address Type Controls

Choices:

  • af-ucast

  • af-mcast

admin_state

string

Admin state for the BGP session

Choices:

  • enabled

  • disabled

allow_self_as_count

integer

Number of allowed self AS.

Only used if allow-self-as is enabled under bgp_controls.

annotation

string

User-defined string for annotating an object.

If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead.

bgp_controls

list / elements=string

BGP Controls

Choices:

  • send-com

  • send-ext-com

  • allow-self-as

  • as-override

  • dis-peer-as-check

  • nh-self

certificate_name

aliases: cert_name

string

The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.

If a private_key filename was provided, this defaults to the private_key basename, without extension.

If PEM-formatted content was provided for private_key, this defaults to the username value.

If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.

host

aliases: hostname

string / required

IP Address or hostname of APIC resolvable by Ansible control host.

If the value is not specified in the task, the value of environment variable ACI_HOST will be used instead.

interface_profile

aliases: interface_profile_name, logical_interface

string / required

Name of the interface profile.

l3out

aliases: l3out_name

string / required

Name of an existing L3Out.

node_id

string / required

Node to build the interface on for Port-channels and single ports.

Hyphen separated pair of nodes (e.g. “201-202”) for vPCs.

node_profile

aliases: node_profile_name, logical_node

string / required

Name of the node profile.

output_level

string

Influence the output of this ACI module.

normal means the standard output, incl. current dict

info adds informational output, incl. previous, proposed and sent dicts

debug adds debugging output, incl. filter_string, method, response, status and url information

If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead.

Choices:

  • debug

  • info

  • normal ← (default)

output_path

string

Path to a file that will be used to dump the ACI JSON configuration objects generated by the module.

If the value is not specified in the task, the value of environment variable ACI_OUTPUT_PATH will be used instead.

password

string

The password to use for authentication.

This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.

If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.

path_ep

string / required

Path to interface

Interface Port Group name for Port-channels and vPCs

Port number for single ports (e.g. “eth1/12”)

peer_controls

list / elements=string

Peer Controls

Choices:

  • bfd

  • dis-conn-check

peer_ip

string / required

IP address of the BGP peer.

pod_id

string / required

Pod to build the interface on.

port

integer

Port number to be used for REST connection.

The default value depends on parameter use_ssl.

If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.

private_asn_controls

list / elements=string

Private AS Controls

Choices:

  • remove-exclusive

  • remove-all

  • replace-as

private_key

aliases: cert_key

string

Either a PEM-formatted private key file or the private key content used for signature-based authentication.

This value also influences the default certificate_name that is used.

This option is mutual exclusive with password. If password is provided too, it will be ignored.

If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.

remote_asn

integer

Autonomous System Number of the BGP peer.

state

string

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

Choices:

  • absent

  • present ← (default)

  • query

tenant

aliases: tenant_name

string / required

Name of an existing tenant.

timeout

integer

The socket level timeout in seconds.

If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead.

Default: 30

ttl

integer

eBGP Multihop Time To Live

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

If the value is not specified in the task, the value of environment variable ACI_USE_PROXY will be used instead.

Choices:

  • no

  • yes ← (default)

use_ssl

boolean

If no, an HTTP connection will be used instead of the default HTTPS connection.

If the value is not specified in the task, the value of environment variable ACI_USE_SSL will be used instead.

Choices:

  • no

  • yes ← (default)

username

aliases: user

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

Default: “admin”

validate_certs

boolean

If no, SSL certificates will not be validated.

This should only set to no when used on personally controlled sites using self-signed certificates.

If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead.

Choices:

  • no

  • yes ← (default)

weight

integer

Weight for BGP routes from this neighbor

See Also

See also

M(aci_l3out)

The official documentation on the aci_l3out module.

M(aci_l3out_logical_node_profile)

The official documentation on the aci_l3out_logical_node_profile module.

APIC Management Information Model reference

More information about the internal APIC classes bgp:peerP

Cisco ACI Guide

Detailed information on how to manage your ACI infrastructure using Ansible.

Developing Cisco ACI modules

Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- name: Add a new BGP peer on a physical interface
  cisco.aci.aci_l3out_bgp_peer:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    peer_ip: 192.168.10.2
    remote_asn: 65456
    bgp_controls:
      - nh-self
      - send-com
      - send-ext-com
    peer_controls:
      - bfd
    state: present
  delegate_to: localhost

- name: Add a new BGP peer on a vPC
  cisco.aci.aci_l3out_bgp_peer:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201-202
    path_ep: my_vpc_ipg
    peer_ip: 192.168.20.2
    remote_asn: 65457
    ttl: 4
    weight: 50
    state: present
  delegate_to: localhost

- name: Shutdown a BGP peer
  cisco.aci.aci_l3out_bgp_peer:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    peer_ip: 192.168.10.2
    admin_state: disabled
    state: present
  delegate_to: localhost

- name: Delete a BGP peer
  cisco.aci.aci_l3out_bgp_peer:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    peer_ip: 192.168.10.2
    state: absent
  delegate_to: localhost

- name: Query a BGP peer
  cisco.aci.aci_l3out_bgp_peer:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    peer_ip: 192.168.10.2
    state: query
  delegate_to: localhost
  register: query_result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

current

list / elements=string

The existing configuration from the APIC after the module has finished

Returned: success

Sample: [{“fvTenant”: {“attributes”: {“descr”: “Production environment”, “dn”: “uni/tn-production”, “name”: “production”, “nameAlias”: “”, “ownerKey”: “”, “ownerTag”: “”}}}]

error

dictionary

The error information as returned from the APIC

Returned: failure

Sample: {“code”: “122”, “text”: “unknown managed object class foo”}

filter_string

string

The filter string used for the request

Returned: failure or debug

Sample: “?rsp-prop-include=config-only”

method

string

The HTTP method used for the request to the APIC

Returned: failure or debug

Sample: “POST”

previous

list / elements=string

The original configuration from the APIC before the module has started

Returned: info

Sample: [{“fvTenant”: {“attributes”: {“descr”: “Production”, “dn”: “uni/tn-production”, “name”: “production”, “nameAlias”: “”, “ownerKey”: “”, “ownerTag”: “”}}}]

proposed

dictionary

The assembled configuration from the user-provided parameters

Returned: info

Sample: {“fvTenant”: {“attributes”: {“descr”: “Production environment”, “name”: “production”}}}

raw

string

The raw output returned by the APIC REST API (xml or json)

Returned: parse error

Sample: “\u003c?xml version=\”1.0\” encoding=\”UTF-8\”?\u003e\u003cimdata totalCount=\”1\”\u003e\u003cerror code=\”122\” text=\”unknown managed object class foo\”/\u003e\u003c/imdata\u003e”

response

string

The HTTP response from the APIC

Returned: failure or debug

Sample: “OK (30 bytes)”

sent

list / elements=string

The actual/minimal configuration pushed to the APIC

Returned: info

Sample: {“fvTenant”: {“attributes”: {“descr”: “Production environment”}}}

status

integer

The HTTP status from the APIC

Returned: failure or debug

Sample: 200

url

string

The HTTP url used for the request to the APIC

Returned: failure or debug

Sample: “https://10.11.12.13/api/mo/uni/tn-production.json”

Authors

  • Tim Cragg (@timcragg)