cisco.aci.aci_contract_subject 模块 – 管理初始合约主题 (vz:Subj)

注意

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

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

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

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

概要 

管理 Cisco ACI 结构上的初始合约主题。

参数 

参数	注释
annotation string	用于注释对象的用户定义字符串。如果任务中未指定该值，则将使用环境变量 `ACI_ANNOTATION` 的值。如果任务中未指定该值，并且环境变量 `ACI_ANNOTATION` 也未指定，则将使用默认值。默认值： `"orchestrator:ansible"`
apply_both_direction string	用于筛选器的流量匹配方向。选择 `"both"` ←（默认） `"one-way"`
certificate_name 别名：cert_name string	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。如果提供了 `private_key` 文件名，则此项默认为 `private_key` 的基本名称，不带扩展名。如果为 `private_key` 提供了 PEM 格式的内容，则此项默认为 `username` 值。如果任务中未指定该值，则将使用环境变量 `ACI_CERTIFICATE_NAME` 的值。
consumer_match string	跨消费者的匹配标准。在创建期间未设置时，APIC 默认为 `at_least_one`。选择 `"all"` `"at_least_one"` `"at_most_one"` `"none"`
contract 别名：contract_name string	合约的名称。
description 别名：descr string	合约主题的描述。
dscp 别名：target string	目标 DSCP。在创建期间未设置时，APIC 默认为 `unspecified`。选择 `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"unspecified"`
dscp_consumer_to_provider 别名：target_consumer_to_provider string	从消费者到提供商的筛选链的目标 DSCP。在创建期间未设置时，APIC 默认为 `unspecified`。选择 `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"unspecified"`
dscp_provider_to_consumer 别名：target_provider_to_consumer string	从提供商到消费者的筛选链的目标 DSCP。在创建期间未设置时，APIC 默认为 `unspecified`。选择 `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"unspecified"`
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` 的值。
password string	用于身份验证的密码。此选项与 `private_key` 互斥。如果也提供了 `private_key`，则将使用它。如果任务中未指定该值，则将改用环境变量 `ACI_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
端口整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定该值，则将改用环境变量 `ACI_PORT` 的值。
优先级 string	QoS 类。在创建期间未设置时，APIC 默认为 `unspecified`。选择 `"level1"` `"level2"` `"level3"` `"unspecified"`
priority_consumer_to_provider string	消费者到提供商的过滤器链的 QoS 类。在创建期间未设置时，APIC 默认为 `unspecified`。选择 `"level1"` `"level2"` `"level3"` `"unspecified"`
priority_provider_to_consumer string	提供商到消费者的过滤器链的 QoS 类。在创建期间未设置时，APIC 默认为 `unspecified`。选择 `"level1"` `"level2"` `"level3"` `"unspecified"`
private_key 别名: cert_key string	用于基于签名的身份验证的 PEM 格式私钥文件或私钥内容。此值还会影响所使用的默认 `certificate_name`。此选项与 `password` 互斥。如果也提供了 `password`，则会被忽略。如果任务中未指定该值，则将改用环境变量 `ACI_PRIVATE_KEY` 或 `ANSIBLE_NET_SSH_KEYFILE` 的值。
provider_match string	跨提供商的匹配条件。在创建期间未设置时，APIC 默认为 `at_least_one`。选择 `"all"` `"at_least_one"` `"at_most_one"` `"none"`
reverse_filter 布尔值	确定 APIC 是否应该反转源端口和目标端口，以允许返回流量，因为 ACI 是无状态过滤器。在创建期间未设置时，APIC 默认为 `true`。选择 `false` `true`
状态 string	使用 `present` 或 `absent` 进行添加或删除。使用 `query` 列出一个对象或多个对象。选择 `"absent"` `"present"` ← (默认) `"query"`
subject 别名: contract_subject, name, subject_name string	合约主题名称。
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	租户的名称。
超时整数	套接字级别的超时时间（秒）。如果任务中未指定该值，则将改用环境变量 `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`

注释 

注意

在剧本中使用此模块之前，必须存在使用的 tenant 和 contract。可以使用 cisco.aci.aci_tenant 和 cisco.aci.aci_contract 模块来实现此目的。

另请参阅 

另请参阅

cisco.aci.aci_contract: 管理合同资源 (vz:BrCP)。
cisco.aci.aci_tenant: 管理租户 (fv:Tenant)。
APIC 管理信息模型参考: 有关内部 APIC 类 vz:Subj 的更多信息。
Cisco ACI 指南: 有关如何使用 Ansible 管理 ACI 基础设施的详细信息。
开发 Cisco ACI 模块: 有关如何编写自己的 Cisco ACI 模块以进行贡献的详细指南。

示例 

- name: Add a new contract subject
  cisco.aci.aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    description: test
    reverse_filter: true
    priority: level1
    dscp: unspecified
    state: present
  register: query_result

- name: Remove a contract subject
  cisco.aci.aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    state: absent
  delegate_to: localhost

- name: Query a contract subject
  cisco.aci.aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all contract subjects
  cisco.aci.aci_contract_subject:
    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": ""}}}]`
错误字典	从 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=\"unknown managed object class foo\"/></imdata>"`
response string	来自 APIC 的 HTTP 响应返回: 失败或调试示例: `"OK (30 字节)"`
sent 列表 / 元素=字符串	推送到 APIC 的实际/最小配置返回: 信息示例: `{"fvTenant": {"attributes": {"descr": "生产环境"}}}`
status 整数	来自 APIC 的 HTTP 状态返回: 失败或调试示例: `200`
url string	用于向 APIC 发出请求的 HTTP url 返回: 失败或调试示例: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

作者

Swetha Chunduri (@schunduri)