cisco.aci.aci_fabric_external_connection_profile 模块 – 管理 Fabric 外部连接配置文件 (fv:FabricExtConnP)。

注意

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

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

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

要在剧本中使用它，请指定：cisco.aci.aci_fabric_external_connection_profile。

概要

• 管理 Cisco ACI 结构中的 Fabric 外部连接配置文件（站内/站间配置文件）。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将改为使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定此值，并且环境变量 ACI_ANNOTATION 也未设置，则将使用默认值。 默认值： "orchestrator:ansible"
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将改为使用环境变量 ACI_CERTIFICATE_NAME 的值。
community 别名：rt, route_target 字符串	Fabric 外部连接配置文件的全局 EVPN 路由目标。 例如：extended:as2-nn4:5:16
description 别名：descr 字符串	指定配置文件定义的描述。
fabric_id 别名：id, fabric 整数	Fabric 外部连接配置文件的结构标识符。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改为使用环境变量 ACI_HOST 的值。
name 别名：profile_name 字符串	Fabric 外部连接配置文件的名称。
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 的值。
owner_key 字符串	ACI 对象的 ownerKey 属性的自定义字符串。 此属性代表一个密钥，用于使客户端能够拥有其数据以进行实体关联。 如果任务中未指定值，则将使用环境变量ACI_OWNER_KEY的值。
owner_tag 字符串	ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，允许客户端添加他们自己的数据。 例如，指示谁创建了此对象。 如果任务中未指定值，则将使用环境变量ACI_OWNER_TAG的值。
password 字符串	用于身份验证的密码。 此选项与private_key互斥。如果也提供了private_key，则将使用它。 如果任务中未指定值，则将使用环境变量ACI_PASSWORD或ANSIBLE_NET_PASSWORD的值。
peering_password 别名：peer_password, peer_pwd 字符串	BGP EVPN 对等密码。用于设置自动对等会话。 提供此选项将始终导致更改，因为它是一个无法从 APIC 检索的安全属性。
peering_type 别名：p_type, peer, peer_t 字符串	BGP EVPN 对等类型。使用automatic_with_full_mesh或automatic_with_rr。 选项 "automatic_with_full_mesh" "automatic_with_rr"
port 整数	用于 REST 连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定值，则将使用环境变量ACI_PORT的值。
private_key 别名：cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将被忽略。 如果任务中未指定值，则将使用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
site_id 别名：sid, site, s_id 整数	结构外部连接配置文件的站点标识符。
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
timeout 整数	以秒为单位的套接字级别超时。 如果任务中未指定值，则将使用环境变量ACI_TIMEOUT的值。 默认值为 30。
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

另请参见

另请参见

APIC 管理信息模型参考

有关内部 APIC 类fv:FabricExtConnP的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new Fabric External Connection Profile
  cisco.aci.aci_fabric_external_connection_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    fabric_id: 1
    name: ansible_fabric_ext_conn_profile
    description: Fabric External Connection Profile
    community: extended:as2-nn4:5:16
    site_id: 1
    peering_type: automatic_with_rr
    peering_password: SomeSecretPeeringPassword
    state: present
  delegate_to: localhost

- name: Query a Fabric External Connection Profile
  cisco.aci.aci_fabric_external_connection_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    fabric_id: 1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric External Connection Profiles
  cisco.aci.aci_fabric_external_connection_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove a Fabric External Connection Profile
  cisco.aci.aci_fabric_external_connection_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    fabric_id: 1
    state: absent
  delegate_to: localhost

返回值

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

键	描述
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": ""}}}]
proposed 字典	用户提供的参数组装的配置 返回值：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw 字符串	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"

作者

• Samita Bhattacharjee (@samitab)

收藏链接

• 问题跟踪器
• 代码库（源代码）