cisco.aci.aci_epg_to_domain 模块 – 将 EPG 绑定到域 (fv:RsDomAtt)

注意

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

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

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

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

概要

• 将 EPG 绑定到 Cisco ACI 架构上的物理和虚拟域。

参数

参数	注释
allow_useg 字符串	允许微分割。 在创建期间未设置时，APIC 默认为 encap。 选项 "encap" "useg"
annotation 字符串	用于注释对象的用户定义字符串。 如果任务中未指定该值，则将改为使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定该值且环境变量 ACI_ANNOTATION 未指定，则将使用默认值。 默认值： "orchestrator:ansible"
ap 别名：app_profile, app_profile_name 字符串	现有应用程序网络配置文件的名称，该配置文件将包含 EPG。
certificate_name 别名：cert_name 字符串	附加到用于基于签名身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则此值默认为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则此值默认为 username 值。 如果任务中未指定该值，则将改为使用环境变量 ACI_CERTIFICATE_NAME 的值。
custom_epg_name 字符串	VMM 域关联中的自定义 EPG 名称。
delimiter 字符串	分隔符。 选项 "|" "~" "!" "@" "^" "+" "=" "_"
deploy_immediacy 字符串	确定何时将策略推送到硬件策略 CAM。 在创建期间未设置时，APIC 默认为 lazy。 选项 "immediate" "lazy"
domain 别名：domain_name, domain_profile 字符串	与 EPG 关联的物理域或虚拟域的名称。
domain_type 别名：type 字符串	指定域是物理 (phys)、虚拟 (vmm) 还是 L2 外部域关联 (l2dom)。 选项 "l2dom" "phys" "vmm"
encap 整数	将 VMM 域与静态 encap_mode 绑定时，EPG 的 VLAN 封装。 在使用 useg 时，这充当辅助封装。 接受的值范围在 1 到 4096 之间。
encap_mode 字符串	要使用的封装方法。 在创建期间未设置时，APIC 默认为 auto。 如果选择 vxlan，则 switching_mode 必须为 “AVE”。 选项 "auto" "vlan" "vxlan"
enhanced_lag_policy 别名：lag_policy 字符串	VMM 域增强型 LAG 策略的名称。
epg 别名：epg_name, name 字符串	端点组的名称。
forged_transmits 字符串	允许伪造的传输。当网络适配器开始发送将其自身标识为其他内容的流量时，会发生伪造的传输。 选项 "accept" "reject" ←（默认）
host 别名：hostname 字符串	可由 Ansible 控制主机解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将改为使用环境变量 ACI_HOST 的值。
mac_changes 字符串	允许定义虚拟机 (VM) 中网络适配器的新 MAC 地址。 选项 "accept" "reject" ←（默认）
netflow 布尔值	确定是否应启用 netflow。 在创建期间未设置时，APIC 默认为 false。 选项 false true
number_of_ports 整数	端口数。
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 的值。
密码 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将使用它。 如果任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
端口 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将使用环境变量 ACI_PORT 的值。
端口分配 字符串	端口分配方法。 选项 "弹性" "固定"
端口绑定 字符串	端口绑定方法。 选项 "动态" "临时" "静态"
主封装 整数	确定使用 useg 时的主要 VLAN ID。 接受的值范围在 1 到 4096 之间。
私钥 别名: cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将忽略它。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
混杂模式 字符串	允许/禁止在 vmm 域中使用混杂模式 选项 "accept" "reject" ←（默认）
解析即时性 字符串	确定策略应何时解析并可用。 在创建期间未设置时，APIC 默认为 lazy。 选项 "immediate" "lazy" "预配置"
状态 字符串	使用 present 或 absent 进行添加或删除。 使用 query 列出一个或多个对象。 选项 "缺席" "present" ← (默认) "查询"
抑制先前值 别名: no_previous, ignore_previous 布尔值	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 请求以检查先前的值。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致先前的返回值为空。 将不检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
抑制验证 别名: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为 true，则在向 APIC 发送 POST 更新后，不会发送验证 GET 请求。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 在单个任务中，当前对象（包括默认值）将无法验证。 选项 false true
交换模式 字符串	交换机使用的交换模式 选项 "AVE" "native" ← (默认)
租户 别名: tenant_name 字符串	现有租户的名称。
超时 整数	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将使用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
未标记的 vlan 布尔值	访问 vlan 是未标记的。 选项 false true
使用代理 布尔值	如果为 false，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定该值，则将使用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选项 false true
使用 ssl 布尔值	如果为 false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定该值，则将使用环境变量 ACI_USE_SSL 的值。 当连接为本地连接时，默认值为 true。 选项 false true
用户名 别名: user 字符串	用于身份验证的用户名。 如果任务中未指定该值，则将使用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
验证证书 布尔值	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果任务中未指定该值，则将使用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选项 false true
虚拟机提供商 字符串	VMM 域的 VM 平台。 ACI v3.0 中添加了对 Kubernetes 的支持。 ACI v3.1 中添加了对 CloudFoundry、OpenShift 和 Red Hat 的支持。 选项 "cloudfoundry" "kubernetes" "microsoft" "openshift" "openstack" "redhat" "vmware"
vmm 上行链路激活 列表 / 元素=字符串	活动上行链路 ID 的列表。 顺序决定了活动上行链路接管故障上行链路的顺序。 当先前配置了活动上行链路时，必须在列表中保留至少一个活动上行链路。
vmm 上行链路备用 列表 / 元素=字符串	备用上行链路 ID 的列表。 当未配置活动上行链路时，必须在列表中保留至少一个备用上行链路。

注释

注意

• 在使用 playbook 中的此模块之前，必须存在所使用的 tenant、ap、epg 和 domain。可以使用 cisco.aci.aci_tenant cisco.aci.aci_ap、cisco.aci.aci_epg cisco.aci.aci_domain 模块进行此操作。

• 不应使用此模块创建 OpenStack VMM 域。OpenStack VMM 域由 Cisco APIC Neutron 插件在安装和配置过程中直接创建。此模块可用于查询 OpenStack VMM 域的状态。

另请参阅

另请参阅

cisco.aci.aci_ap

管理顶级应用程序配置文件 (AP) 对象 (fv:Ap)。

cisco.aci.aci_epg

管理端点组 (EPG) 对象 (fv:AEPg)。

cisco.aci.aci_domain

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

APIC 管理信息模型参考

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

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new physical domain to EPG binding
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    domain: anstest
    domain_type: phys
    state: present
  delegate_to: localhost

- name: Remove an existing physical domain to EPG binding
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    domain: anstest
    domain_type: phys
    state: absent
  delegate_to: localhost

- name: Query a specific physical domain to EPG binding
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    domain: anstest
    domain_type: phys
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all domain to EPG bindings
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
当前 列表 / 元素=字符串	模块完成后，来自 APIC 的现有配置 已返回：成功 示例： [{"fvTenant": {"attributes": {"descr": "生产 环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
错误 字典	从 APIC 返回的错误信息 已返回：失败 示例： {"code": "122", "text": "未知的 受管 对象 类 foo"}
过滤器字符串 字符串	用于请求的过滤器字符串 已返回：失败或调试 示例: "?rsp-prop-include=config-only"
方法 字符串	用于向APIC发出请求的HTTP方法 已返回：失败或调试 示例: "POST"
之前的配置 列表 / 元素=字符串	模块启动前来自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"

作者

• Jacob McGill (@jmcgill298)

• Shreyas Srish (@shrsr)

集合链接

• 问题跟踪器
• 存储库 (源代码)