aci_l3out_bgp_peer
Manage Layer 3 Outside (L3Out) BGP Peers (bgp:PeerP and bgp:InfraPeerP)
Collection: cisco.aci
Full Name: cisco.aci.aci_l3out_bgp_peer
Synopsis
Manage Layer 3 Outside (L3Out) BGP Peers (bgp:PeerP and bgp:InfraPeerP)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| address_type_controls | list | Address Type Controls | ||
| admin_state | string | Admin state for the BGP session | ||
| allow_self_as_count | int | Number of allowed self AS. Only used if C(allow-self-as) is enabled under C(bgp_controls). | ||
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| bgp_controls | list | BGP Controls | ||
| bgp_infra_peer | bool | BGP Infra peer (bgp:InfraPeerP). | ||
| bgp_password | string | Password for the BGP Peer. Providing the password will always result in a change because the set password cannot be retrieved from APIC. | ||
| bgp_peer_prefix_policy | string | BGP Peer Prefix Policy. BGP Peer Prefix Policy is only allowed to be configured when I(bgp_infra_peer=true). | ||
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| description | string | Description for the BGP Peer. | ||
| host | string | 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 C(ACI_HOST) will be used instead. | ||
| interface_profile | string | Name of the interface profile. | ||
| l3out | string | Name of an existing L3Out. | ||
| local_as_number | int | The local Autonomous System Number (ASN) of the L3Out BGP Peer. The APIC defaults to 0 when unset during creation. | ||
| local_as_number_config | string | The local Autonomous System Number (ASN) configuration of the L3Out BGP Peer. The APIC defaults to C(none) when unset during creation. | ||
| node_id | string | 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 | string | Name of the node profile. | ||
| output_level | string | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| 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 C(ACI_OUTPUT_PATH) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| path_ep | string | Path to interface Interface Port Group name for Port-channels and vPCs Port number for single ports (e.g. “eth1/12”) | ||
| peer_controls | list | Peer Controls | ||
| peer_ip | string | IP address of the BGP peer. | ||
| peer_type | string | BGP Peer type. | ||
| pod_id | string | Pod to build the interface on. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| private_asn_controls | list | Private AS Controls | ||
| private_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 C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| remote_asn | int | Autonomous System Number of the BGP peer. | ||
| route_control_profiles | list | List of dictionaries objects, which is used to bind the BGP Peer Connectivity Profile to Route Control Profile. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. | ||
| tenant | string | Name of an existing tenant. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| transport_data_plane | string | Transport Data Plane type. | ||
| ttl | int | eBGP Multihop Time To Live | ||
| use_proxy | bool | If C(false), 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 C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), 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 C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. | ||
| weight | int | Weight for BGP routes from this neighbor |
Example
yaml
- {"cisco.aci.aci_l3out_bgp_peer": {"bgp_controls": ["nh-self", "send-com", "send-ext-com"], "host": "apic", "interface_profile": "my_interface_profile", "l3out": "my_l3out", "node_id": 201, "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "eth1/12", "peer_controls": ["bfd"], "peer_ip": "192.168.10.2", "pod_id": 1, "remote_asn": 65456, "route_control_profiles": [{"direction": "import", "profile": "anstest_import", "tenant": "ansible_tenant"}, {"direction": "export", "l3out": "anstest_l3out", "profile": "anstest_export", "tenant": "ansible_tenant"}], "tenant": "my_tenant", "username": "admin", state: present}, "delegate_to": "localhost", "name": "Add a new BGP peer on a physical interface"}
- {"cisco.aci.aci_l3out_bgp_peer": {"host": "apic", "interface_profile": "my_interface_profile", "l3out": "my_l3out", "node_id": "201-202", "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "my_vpc_ipg", "peer_ip": "192.168.20.2", "pod_id": 1, "remote_asn": 65457, "state": "present", "tenant": "my_tenant", "ttl": 4, "username": "admin", "weight": 50}, "delegate_to": "localhost", "name": "Add a new BGP peer on a vPC"}
- {"aci_l3out_bgp_peer": {"bgp_controls": ["send-domain-path"], "bgp_infra_peer": true, "bgp_password": "ansible_test_password", "bgp_peer_prefix_policy": "ansible_peer_prefix_profile", "host": "apic", "l3out": "ansible_infra_l3out", "local_as_number": 65460, "node_profile": "ansible_infra_l3out_node_profile", "password": "SomeSecretPassword", "peer_ip": "192.168.50.2", "peer_type": "sr_mpls", "remote_asn": 65450, "state": "present", "tenant": "infra", "transport_data_plane": "sr_mpls", "ttl": 2, "username": "admin"}, "delegate_to": "localhost", "name": "Create Infra BGP Peer with password"}
- {"cisco.aci.aci_l3out_bgp_peer": {"admin_state": "disabled", "host": "apic", "interface_profile": "my_interface_profile", "l3out": "my_l3out", "node_id": 201, "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "eth1/12", "peer_ip": "192.168.10.2", "pod_id": 1, "state": "present", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Shutdown a BGP peer"}
- {"cisco.aci.aci_l3out_bgp_peer": {"host": "apic", "interface_profile": "my_interface_profile", "l3out": "my_l3out", "node_id": 201, "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "eth1/12", "peer_ip": "192.168.10.2", "pod_id": 1, "state": "absent", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Delete a BGP peer"}
- {"cisco.aci.aci_l3out_bgp_peer": {"host": "apic", "l3out": "ansible_l3out", "node_profile": "ansible_node_profile", "password": "SomeSecretPassword", "peer_ip": "192.168.50.3", "route_control_profiles": [{"direction": "import", "profile": "anstest_import", "tenant": "ansible_tenant"}, {"direction": "export", "l3out": "anstest_l3out", "profile": "anstest_export", "tenant": "ansible_tenant"}], "state": "present", "tenant": "ansible_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Add BGP Peer to the Node Profile level"}
- {"cisco.aci.aci_l3out_bgp_peer": {"host": "apic", "interface_profile": "my_interface_profile", "l3out": "my_l3out", "node_id": 201, "node_profile": "my_node_profile", "password": "SomeSecretPassword", "path_ep": "eth1/12", "peer_ip": "192.168.10.2", "pod_id": 1, "state": "query", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Query a BGP peer", "register": "query_result"}
- {"cisco.aci.aci_l3out_bgp_peer": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all BGP peer", "register": "query_all"}
- {"cisco.aci.aci_l3out_bgp_peer": {"bgp_infra_peer": true, "host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all BGP infra peer", "register": "query_all"}