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。

要在playbook中使用它，请指定： 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 整数	使用静态encap_mode绑定VMM域时EPG的VLAN封装。 在使用useg时，这充当辅助encap。 可接受的值范围在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 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将使用它。 如果任务中未指定此值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定此值，则将使用环境变量 ACI_PORT 的值。
port_allocation 字符串	端口分配方法。 选项 "elastic" "fixed"
port_binding 字符串	端口绑定方法。 选项 "dynamic" "ephemeral" "static"
primary_encap 整数	使用 useg 时确定主 VLAN ID。 可接受的值范围在1和4096之间。
private_key 别名：cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将被忽略。 如果任务中未指定此值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
promiscuous 字符串	允许/不允许在 VMM 域中使用混杂模式 选项 "accept" "reject" ← (默认)
resolution_immediacy 字符串	确定何时应解析并提供策略。 在创建期间未设置时，APIC默认为lazy。 选项 "immediate" "lazy" "pre-provision"
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
switching_mode 字符串	交换机使用的交换模式 选项 "AVE" "native" ← (默认)
tenant 别名：tenant_name 字符串	现有租户的名称。
timeout 整数	以秒为单位的套接字级别超时。 如果任务中未指定此值，则将使用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
untagged_vlan 布尔值	访问 VLAN 未标记。 选项 false true
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
vm_provider 字符串	VMM 域的虚拟机平台。 ACI v3.0 中添加了对 Kubernetes 的支持。 ACI v3.1 中添加了对 CloudFoundry、OpenShift 和 Red Hat 的支持。 选项 "cloudfoundry" "kubernetes" "microsoft" "openshift" "openstack" "redhat" "vmware"
vmm_uplink_active 列表 / 元素=字符串	活动上行链路 ID 列表。 顺序决定活动上行链路接管失败上行链路的顺序。 先前配置了活动上行链路时，列表中必须至少保留一个活动上行链路。
vmm_uplink_standby 列表 / 元素=字符串	备用上行链路 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

返回值

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

键	描述
current 列表 / 元素=字符串	模块完成之后，从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 列表 / 元素=字符串	模块启动之前从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>"
response 字符串	来自APIC的HTTP响应 返回：失败或调试 示例： "OK (30 bytes)"
sent 列表 / 元素=字符串	实际/最小推送到APIC的配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "Production environment"}}}
status 整数	来自APIC的HTTP状态 返回：失败或调试 示例： 200
url 字符串	用于向APIC发出请求的HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Jacob McGill (@jmcgill298)

• Shreyas Srish (@shrsr)

资源链接

• 问题追踪器
• 代码仓库