cisco.aci.aci_esg_to_contract 模块 – 将 ESG 绑定到策略 (fv:RsCons、fv:RsProv、fv:RsConsIf 和 fv:RsIntraEpg)

注意

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

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

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

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

概要

• 在 Cisco ACI 结构中将 ESG 绑定到策略。

参数

参数	注释
注解 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将改用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定此值，并且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。 默认值： "orchestrator:ansible"
ap 别名：app_profile, app_profile_name 字符串	包含 ESG 的现有应用网络配置文件的名称。
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基本名称（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将改用环境变量 ACI_CERTIFICATE_NAME 的值。
contract 别名：contract_name, contract_interface 字符串	策略或策略接口的名称。
contract_type 字符串 / 必需	确定策略的类型。 选项 "consumer" (使用者) "provider" (提供者) "interface" (接口) "intra_esg" (ESG内部)
esg 别名：esg_name 字符串	端点安全组的名称。
host 别名：hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改用环境变量 ACI_HOST 的值。
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的值。
端口 整数	用于REST连接的端口号。 默认值取决于参数use_ssl。 如果在任务中未指定此值，则将改用环境变量ACI_PORT的值。
优先级 字符串	QoS 类别。 创建时未设置时，APIC 默认值为unspecified。 此参数不支持 o(contract_type=intra_esg) 合同。 选项 "level1" "level2" "level3" "level4" "level5" "level6" "unspecified"
private_key 别名：cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将忽略它。 如果在任务中未指定此值，则将改用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
状态 字符串	使用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
租户 别名：tenant_name 字符串	现有租户的名称。
超时 整数	以秒为单位的套接字级别超时。 如果在任务中未指定此值，则将改用环境变量ACI_TIMEOUT的值。 默认值为 30。
使用代理 布尔值	如果为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

注释

注意

• 在您的 playbook 中使用此模块之前，必须先存在使用的tenant、ap、esg和contract。可以使用cisco.aci.aci_tenant、cisco.aci.aci_ap、cisco.aci.aci_esg和cisco.aci.aci_contract模块来实现此目的。

另请参见

另请参见

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_ap

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

cisco.aci.aci_esg

管理端点安全组 (ESG) 对象 (fv:ESg)。

cisco.aci.aci_contract

管理合同资源 (vz:BrCP)。

APIC 管理信息模型参考

有关内部 APIC 类fv:RsCons、fv:RsProv、fv:RsConsIf和fv:RsIntraEpg的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new contract to ESG binding
  cisco.aci.aci_esg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    esg: anstest
    contract: anstest_http
    contract_type: provider
    state: present
  delegate_to: localhost

- name: Query a specific contract to ESG binding
  cisco.aci.aci_esg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    esg: anstest
    contract: anstest_http
    contract_type: provider
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all provider contract to ESG bindings
  cisco.aci.aci_esg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    contract_type: provider
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove an existing contract to ESG binding
  cisco.aci.aci_esg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    esg: anstest
    contract: anstest_http
    contract_type: provider
    state: absent
  delegate_to: localhost

返回值

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

键	描述
当前 列表 / 元素=字符串	模块完成后的 APIC 中的现有配置 返回：成功 示例：[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
错误 字典	APIC 返回的错误信息 返回：失败 示例：{"code": "122", "text": "unknown managed object class 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"

作者

• Akini Ross (@akinross)

收藏链接

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