cisco.aci.aci_l3out_extsubnet 模块 – 管理外部子网对象 (l3ext:Subnet)

注意

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

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

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

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

概要

• 管理外部子网对象。

参数

参数	注释
aggregate list / elements=string	确定子网的聚合路由。 export-rtctrl 选项用于导出 VRF 的所有传输路由（0/0 子网）。 import-rtctrl 选项用于导入给定 L3 对等体的所有传入路由（0/0 子网）。 shared-rtctrl 选项用于共享在一个 VRF 中学习到的需要通告到另一个 VRF 的路由。0/0 可用于在多个 VRF 之间共享所有子网路由。 import-rtctrl 仅支持 BGP 和 OSPF。 只有在 L3Out 启用了“导入路由控制强制”时，才可以使用聚合导入路由控制。默认情况下，此功能处于禁用状态，可以使用 cisco.aci.aci_l3out 以及 route_control 来启用。 选项 "export-rtctrl" "import-rtctrl" "shared-rtctrl"
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 的值。
description 别名：descr 字符串	外部子网的描述。
extepg 别名：extepg_name string / required	现有 ExtEpg 的名称。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果在任务中未指定该值，则将改用环境变量 ACI_HOST 的值。
l3out 别名：l3out_name string / required	现有 L3Out 的名称。
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段有关。
network 别名：address, ip 字符串	子网的网络地址。
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 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将使用环境变量 ACI_PORT 的值。
private_key 别名：cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将被忽略。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
scope list / elements=string	确定子网的范围。 export-rtctrl 选项控制使用路由映射和 IP 前缀列表从网络结构中通告哪些外部网络。 import-rtctrl 选项控制使用路由映射和 IP 前缀列表向网络结构中通告哪些外部网络。 import-security 选项对外部 EPG 进行分类。此外部 EPG 中定义的规则和合同适用于与此子网匹配的网络。 shared-rtctrl 选项控制哪些外部前缀被通告给其他租户以获得共享服务。 shared-security 选项配置 VRF 中子网的分类器，其中路由被泄漏。 在创建期间未设置时，APIC 默认为 import-security。 import-rtctrl 仅支持 BGP 和 OSPF。 选项 "export-rtctrl" "import-rtctrl" "import-security" "shared-rtctrl" "shared-security"
state 字符串	使用 present 或 absent 添加或删除。 使用 query 列出一个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
subnet_name 别名：name 字符串	正在创建的外部子网的名称。
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 string / required	现有租户的名称。
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

备注

注意

• 在您的 playbook 中使用此模块之前，必须存在所用的 tenant 和 domain 和 vrf。cisco.aci.aci_tenant 和 cisco.aci.aci_domain 和 cisco.aci.aci_vrf 模块可用于此目的。

另请参阅

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_domain

管理物理、虚拟、桥接、路由或 FC 域配置文件 (phys:DomP、vmm:DomP、l2ext:DomP、l3ext:DomP 和 fc:DomP)。

cisco.aci.aci_vrf

管理上下文或 VRF (fv:Ctx)。

APIC 管理信息模型参考

有关内部 APIC 类 l3ext:Subnet 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new External Subnet
  cisco.aci.aci_l3out_extsubnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    extepg: prod_extepg
    description: External Subnet for Production ExtEpg
    network: 192.0.2.0/24
    scope: export-rtctrl
    aggregate: export-rtctrl
    state: present
  delegate_to: localhost

- name: Delete External Subnet
  cisco.aci.aci_l3out_extsubnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    extepg: prod_extepg
    network: 192.0.2.0/24
    state: absent
  delegate_to: localhost

- name: Query ExtEpg Subnet information
  cisco.aci.aci_l3out_extsubnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    extepg: prod_extepg
    network: 192.0.2.0/24
    state: query
  delegate_to: localhost
  register: query_result

返回值

通用返回值记录在此处，以下是此模块独有的字段

Key	描述
current list / elements=string	模块完成后，来自 APIC 的现有配置 返回：成功 示例： [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	从 APIC 返回的错误信息 返回：失败 示例： {"code": "122", "text": "未知的托管对象类 foo"}
filter_string 字符串	用于请求的过滤器字符串 返回：失败或调试 示例： "?rsp-prop-include=config-only"
method 字符串	用于向 APIC 发出请求的 HTTP 方法 返回：失败或调试 示例： "POST"
previous list / elements=string	模块启动前来自 APIC 的原始配置 返回：信息 示例： [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	从用户提供的参数组装的配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "生产环境", "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 字节)"
已发送 list / elements=string	推送到 APIC 的实际/最小配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "生产环境"}}}
状态 整数	来自 APIC 的 HTTP 状态 返回：失败或调试 示例： 200
URL 字符串	用于向 APIC 发出请求的 HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Rostyslav Davydenko (@rost-d)

• Cindy Zhao (@cizhao)

集合链接

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