cisco.aci.aci_l3out_bgp_peer 模块 – 管理三层外部 (L3Out) BGP 对等体 (bgp:PeerP 和 bgp:InfraPeerP)

注意

此模块是 cisco.aci 集合 (版本 2.10.1) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.aci。

要在 playbook 中使用它，请指定： cisco.aci.aci_l3out_bgp_peer。

概要

• 管理 Cisco ACI 结构上的 L3Out BGP 对等体。

参数

参数	注释
address_type_controls 列表 / 元素=字符串	地址类型控制 选项 "af-ucast" "af-mcast"
admin_state 字符串	BGP 会话的管理状态 选项 "已启用" "已禁用"
allow_self_as_count 整数	允许的自 AS 数量。 仅当 bgp_controls 下启用了 allow-self-as 时才使用。
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定值且未设置环境变量 ACI_ANNOTATION，则将使用默认值。 默认值： "orchestrator:ansible"
bgp_controls 列表 / 元素=字符串	BGP 控制 选项 "send-com" "send-ext-com" "allow-self-as" "as-override" "dis-peer-as-check" "nh-self" "send-domain-path"
bgp_infra_peer 别名：infra 布尔值	BGP Infra 对等体 (bgp:InfraPeerP)。 选项 false true
bgp_password 字符串	BGP 对等体的密码。 提供密码将始终导致更改，因为设置的密码无法从 APIC 中检索。
bgp_peer_prefix_policy 别名：bgp_peer_prefix_policy_name 字符串	BGP 对等体前缀策略。 仅当 *bgp_infra_peer=true* 时才允许配置 BGP 对等体前缀策略。
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名，不含扩展名。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
description 别名：descr 字符串	BGP 对等体的描述。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定值，则将使用环境变量 ACI_HOST 的值。
interface_profile 别名：interface_profile_name, logical_interface 字符串	接口配置文件的名称。
l3out 别名：l3out_name 字符串	现有 L3Out 的名称。
local_as_number 别名：local_as_num 整数	L3Out BGP 对等体的本地自治系统编号 (ASN)。 在创建期间未设置时，APIC 默认为 0。
local_as_number_config 别名：local_as_num_config 字符串	L3Out BGP 对等体的本地自治系统编号 (ASN) 配置。 在创建期间未设置时，APIC 默认为 none。 选项 "dual-as" "no-prepend" "none" "replace-as"
node_id 字符串	用于在端口通道和单端口上构建接口的节点。 用于 vPC 的节点的带连字符分隔的对 (例如，“201-202”)。
node_profile 别名：node_profile_name, logical_node 字符串	节点配置文件的名称。
output_level 字符串	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定值，则将改用环境变量ACI_OUTPUT_LEVEL的值。 选项 "debug" "info" "normal" ← (默认)
output_path 字符串	模块生成的ACI JSON配置对象的转储文件路径。 如果任务中未指定值，则将改用环境变量ACI_OUTPUT_PATH的值。
password 字符串	用于身份验证的密码。 此选项与private_key互斥。如果也提供了private_key，则将改用它。 如果任务中未指定值，则将改用环境变量ACI_PASSWORD或ANSIBLE_NET_PASSWORD的值。
path_ep 字符串	接口路径 端口通道和vPC的接口端口组名称 单个端口的端口号（例如，“eth1/12”）
peer_controls 列表 / 元素=字符串	对等体控制 选项 "bfd" "dis-conn-check"
peer_ip 字符串	BGP对等体的IP地址。
peer_type 字符串	BGP对等体类型。 选项 "sr_mpls"
pod_id 字符串	在其上构建接口的Pod。
port 整数	用于REST连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定值，则将改用环境变量ACI_PORT的值。
private_asn_controls 列表 / 元素=字符串	私有AS控制 选项 "remove-exclusive" "remove-all" "replace-as"
private_key 别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将被忽略。 如果任务中未指定值，则将改用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
remote_asn 整数	BGP对等体的自治系统编号。
route_control_profiles 列表 / 元素=字典	字典对象的列表，用于将BGP对等体连接配置文件绑定到路由控制配置文件。
direction 字符串 / 必填	路由控制配置文件方向的名称。
l3out 字符串	L3 Out的名称。
profile 字符串 / 必填	路由控制配置文件的名称。
tenant 字符串 / 必填	租户的名称。
state 字符串	使用present或absent添加或删除。 使用query列出对象或多个对象。 选项 "absent" "present" ← (默认) "query"
suppress_previous 别名：no_previous, ignore_previous 布尔值	如果为true，则在向APIC进行POST更新之前不会发送GET请求以检查先前状态。 如果任务中未指定值，则将改用环境变量ACI_SUPPRESS_PREVIOUS的值。 默认值为false。 警告 - 这会导致先前的返回值为空。 不会检查对象的先前状态，并且POST更新将包含所有属性。 选项 false true
suppress_verification 别名：no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为true，则在向APIC进行POST更新后不会发送验证GET请求。 如果任务中未指定值，则将改用环境变量ACI_SUPPRESS_VERIFICATION的值。 默认值为false。 警告 - 这会导致当前返回值设置为建议值。 包含默认值的当前对象在一个任务中将无法验证。 选项 false true
tenant 别名：tenant_name 字符串	现有租户的名称。
timeout 整数	以秒为单位的套接字级别超时。 如果任务中未指定值，则将改用环境变量ACI_TIMEOUT的值。 默认值为30。
transport_data_plane 字符串	传输数据平面类型。 选项 "mpls" "sr_mpls"
ttl 整数	eBGP多跳生存时间
use_proxy 布尔值	如果为false，即使在目标主机上的环境变量中定义了代理，它也不会使用代理。 如果任务中未指定值，则将改用环境变量ACI_USE_PROXY的值。 默认值为true。 选项 false true
use_ssl 布尔值	如果为false，则将使用HTTP连接而不是默认的HTTPS连接。 如果任务中未指定值，则将改用环境变量ACI_USE_SSL的值。 连接为本地连接时，默认值为true。 选项 false true
username 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定值，则将改用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为admin。
validate_certs 布尔值	如果为false，则不会验证SSL证书。 只有在使用自签名证书的个人控制站点上时，才应将其设置为false。 如果任务中未指定值，则将改用环境变量ACI_VALIDATE_CERTS的值。 默认值为true。 选项 false true
weight 整数	来自此邻居的BGP路由的权重

另请参见

另请参见

aci_l3out

有关aci_l3out模块的官方文档。

aci_l3out_logical_node_profile

有关aci_l3out_logical_node_profile模块的官方文档。

APIC管理信息模型参考

有关内部APIC类bgp:peerP和bgp:InfraPeerP的更多信息

Cisco ACI指南

使用Ansible管理ACI基础设施的详细信息。

开发Cisco ACI模块

有关如何编写自己的Cisco ACI模块以进行贡献的详细指南。

示例

- 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
    route_control_profiles:
      - tenant: "ansible_tenant"
        profile: "anstest_import"
        direction: "import"
      - tenant: "ansible_tenant"
        profile: "anstest_export"
        direction: "export"
        l3out: "anstest_l3out"
        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: Create Infra BGP Peer with password
  aci_l3out_bgp_peer: &infra_bgp_peer
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: infra
    l3out: ansible_infra_l3out
    node_profile: ansible_infra_l3out_node_profile
    ttl: 2
    bgp_infra_peer: true
    bgp_password: ansible_test_password
    peer_ip: 192.168.50.2
    remote_asn: 65450
    local_as_number: 65460
    peer_type: sr_mpls
    bgp_controls:
      - send-domain-path
    transport_data_plane: sr_mpls
    bgp_peer_prefix_policy: ansible_peer_prefix_profile
    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: Add BGP Peer to the Node Profile level
  cisco.aci.aci_l3out_bgp_peer:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    l3out: ansible_l3out
    node_profile: ansible_node_profile
    peer_ip: 192.168.50.3
    route_control_profiles:
      - tenant: "ansible_tenant"
        profile: "anstest_import"
        direction: "import"
      - tenant: "ansible_tenant"
        profile: "anstest_export"
        direction: "export"
        l3out: "anstest_l3out"
    state: present
  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

- name: Query all BGP peer
  cisco.aci.aci_l3out_bgp_peer:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_all

- name: Query all BGP infra peer
  cisco.aci.aci_l3out_bgp_peer:
    host: apic
    username: admin
    password: SomeSecretPassword
    bgp_infra_peer: true
    state: query
  delegate_to: localhost
  register: query_all

返回值

常用返回值已在此处记录，以下是此模块特有的字段

键	描述
current 列表 / 元素=字符串	模块完成后的APIC现有配置 返回：成功 示例：[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	APIC返回的错误信息 返回：失败 示例：{"code": "122", "text": "unknown managed object class foo"}
filter_string 字符串	用于请求的过滤器字符串 返回：失败或调试 示例："?rsp-prop-include=config-only"
method 字符串	用于向APIC发出请求的HTTP方法 返回：失败或调试 示例："POST"
previous 列表 / 元素=字符串	模块启动前APIC的原始配置 返回：信息 示例： [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
建议值 字典	根据用户提供的参数组装的配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
原始数据 字符串	APIC REST API 返回的原始输出 (XML 或 JSON) 返回： 解析错误 示例： "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
响应 字符串	APIC 的 HTTP 响应 返回：失败或调试 示例： "OK (30 bytes)"
已发送 列表 / 元素=字符串	实际/最小配置已推送到 APIC 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "Production environment"}}}
状态 整数	APIC 的 HTTP 状态 返回：失败或调试 示例： 200
URL 字符串	用于向 APIC 发出请求的 HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Tim Cragg (@timcragg)

• Akini Ross (@akinross)

相关链接

• 问题追踪器
• 代码仓库