cisco.aci.aci_fabric_pod_external_tep 模块 – 管理 Fabric Pod 外部 TEP (fabric:ExtRoutablePodSubnet)

注意

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

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

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

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

概要

• 管理 Fabric Pod 外部 TEP 子网。

参数

参数	注释
annotation string	用于注释对象的用户定义字符串。 如果任务中未指定该值，则将改用环境变量 ACI_ANNOTATION 的值。 如果未在任务和环境变量 ACI_ANNOTATION 中指定该值，则将使用默认值。 默认值： "orchestrator:ansible"
certificate_name 别名：cert_name string	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则此项默认为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则此项默认为 username 值。 如果任务中未指定该值，则将改用环境变量 ACI_CERTIFICATE_NAME 的值。
description 别名：descr string	外部 TEP 的描述。
external_tep_pool 别名：ip，ip_address，tep_pool，pool string	外部 TEP 的子网 IP 地址池。 必须是有效的 IPv4，并且包含子网掩码。 示例 192.168.1.0/24
host 别名：hostname string	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将改用环境变量 ACI_HOST 的值。
name_alias string	当前对象的别名。 这与 ACI 中的 nameAlias 字段相关。
output_level string	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息性输出，包括 previous、 proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、 status 和 url 信息 如果任务中未指定该值，则将改用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 "debug" "info" "normal" ← （默认）
output_path string	将用于转储模块生成的 ACI JSON 配置对象的文件的路径。 如果任务中未指定该值，则将改用环境变量 ACI_OUTPUT_PATH 的值。
owner_key string	用于 ACI 对象的 ownerKey 属性的用户定义字符串。 此属性表示一个密钥，使客户端能够拥有其用于实体关联的数据。 如果任务中未指定该值，则将改用环境变量 ACI_OWNER_KEY 的值。
owner_tag string	用于 ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，使客户端能够添加自己的数据。 例如，指示谁创建了此对象。 如果任务中未指定该值，则将改用环境变量 ACI_OWNER_TAG 的值。
password string	用于身份验证的密码。 此选项与 private_key 互斥。 如果也提供了 private_key，则将改用它。 如果任务中未指定该值，则将改用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
pod_id 别名：pod integer	外部 TEP 的 Pod ID。
port integer	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将改用环境变量 ACI_PORT 的值。
private_key 别名：cert_key string	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响所使用的默认 certificate_name。 此选项与 password 互斥。 如果也提供了 password，则将忽略它。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
reserve_address_count 别名: address_count integer	指示从子网起始位置预留的 IP 地址数量。
state string	使用 present 或 absent 来添加或删除。 使用 query 来列出单个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
status string	外部 TEP 的状态，active 或 inactive。 仅当状态为 inactive 时，才能删除外部 TEP。 在创建期间未设置时，APIC 默认为 active。 选项 "active" "inactive"
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 integer	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将使用环境变量 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 string	用于身份验证的用户名。 如果任务中未指定该值，则将使用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
validate_certs 布尔值	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果任务中未指定该值，则将使用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选项 false true

说明

注意

• 必须在 playbook 中使用此模块之前存在 Fabric Pod Setup Policy。 cisco.aci.aci_fabric_pod 模块可用于此目的。

另请参阅

另请参阅

APIC 管理信息模型参考

有关内部 APIC 类 fabric:ExtRoutablePodSubnet 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add an External TEP to a fabric pod setup policy
  cisco.aci.aci_fabric_pod_external_tep:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_id: 2
    external_tep_pool: 10.6.1.0/24
    reserve_address_count: 5
    status: active
    state: present
  delegate_to: localhost

- name: Change an External TEP state on a fabric pod setup policy to inactive
  cisco.aci.aci_fabric_pod_external_tep:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_id: 2
    external_tep_pool: 10.6.1.0/24
    status: inactive
    state: present
  delegate_to: localhost

- name: Query the External TEP on a fabric pod setup policy
  cisco.aci.aci_fabric_pod_external_tep:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_id: 2
    external_tep_pool: 10.6.1.0/24
    state: query
  delegate_to: localhost
  register: query_result

- name: Query External TEPs on all fabric pod setup policies
  cisco.aci.aci_fabric_pod_external_tep:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete an External TEP on a fabric pod setup policy
  cisco.aci.aci_fabric_pod_external_tep:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_id: 2
    external_tep_pool: 10.6.1.0/24
    state: absent
  delegate_to: localhost

返回值

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

键	描述
current 列表 / 元素=字符串	模块完成后，来自 APIC 的现有配置 已返回: 成功 示例: [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	从 APIC 返回的错误信息 已返回: 失败 示例: {"code": "122", "text": "未知受管对象类 foo"}
filter_string string	用于请求的过滤器字符串 已返回: 失败或调试 示例: "?rsp-prop-include=config-only"
method string	用于向 APIC 发出请求的 HTTP 方法 已返回: 失败或调试 示例: "POST"
previous 列表 / 元素=字符串	模块启动前，来自 APIC 的原始配置 已返回: 信息 示例: [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	从用户提供的参数组装的配置 已返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "生产环境", "name": "production"}}}
raw string	APIC REST API 返回的原始输出 (xml 或 json) 已返回: 解析错误 示例: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"未知受管对象类 foo\"/></imdata>"
response string	来自 APIC 的 HTTP 响应 已返回: 失败或调试 示例: "OK (30 字节)"
sent 列表 / 元素=字符串	推送到 APIC 的实际/最小配置 已返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "生产环境"}}}
status integer	来自 APIC 的 HTTP 状态 已返回: 失败或调试 示例: 200
url string	用于向 APIC 发出请求的 HTTP url 已返回: 失败或调试 示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Samita Bhattacharjee (@samitab)

集合链接

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