cisco.aci.aci_aaa_key_ring 模块 – 管理 AAA 密钥环 (pki:KeyRing)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构上的 AAA 密钥环。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将改为使用环境变量 ACI_ANNOTATION 的值。 如果任务和环境变量 ACI_ANNOTATION 中均未指定此值，则将使用默认值。 默认值： "orchestrator:ansible"
certificate 别名：cert_data, certificate_data, cert 字符串	密钥环的证书。 证书包含公钥和用于验证身份的签名信息。
certificate_authority 别名：cert_authority, cert_authority_name, certificate_authority_name 字符串	证书颁发机构的名称。
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将改为使用环境变量 ACI_CERTIFICATE_NAME 的值。
cloud_tenant 别名：tenant, tenant_name 字符串	云租户的名称。 此属性仅适用于云 APIC。
description 别名：descr 字符串	密钥环的描述。
ecc_curve 别名：curve 字符串	私钥的曲线。 此属性需要 key_type=ecc。 此属性仅可在 ACI 6.0(2h) 及更高版本中配置。 选项 "P256" "P384" "P521" "none"
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改为使用环境变量 ACI_HOST 的值。
key 字符串	证书的私钥。 提供此选项将始终导致更改，因为它是一个无法从 APIC 检索的安全属性。
key_type 字符串	私钥的类型。 此属性仅可在 ACI 6.0(2h) 及更高版本中配置。 选项 "rsa" "ecc"
modulus 整数	模数是以位为单位的密钥长度。 选项 512 1024 1536 2048
name 别名：key_ring, key_ring_name 字符串	密钥环的名称。
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
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 的值。
owner_key 字符串	ACI 对象的 ownerKey 属性的用户定义字符串。 此属性表示一个密钥，用于启用客户端拥有其数据以进行实体关联。 如果任务中未指定值，则将使用环境变量 ACI_OWNER_KEY 的值。
owner_tag 字符串	ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，用于启用客户端添加他们自己的数据。 例如，指示谁创建了此对象。 如果任务中未指定值，则将使用环境变量 ACI_OWNER_TAG 的值。
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 的值。
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
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 中使用此模块之前，必须存在所使用的 cloud_tenant。cisco.aci.aci_tenant 模块可用于此目的。

另请参阅

另请参阅

APIC 管理信息模型参考

关于内部 APIC 类 **pki:KeyRing** 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a Key Ring
  cisco.aci.aci_aaa_key_ring:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_key_ring
    certificate: '{{ lookup("file", "pki/example_certificate.crt") }}'
    modulus: 2048
    certificate_authority: example_certificate_authority
    key: '{{ lookup("file", "pki/example_key.key") }}'
    state: present
  delegate_to: localhost

- name: Query a Key Ring
  cisco.aci.aci_aaa_key_ring:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_key_ring
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Certificate Authorities
  cisco.aci.aci_aaa_key_ring:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a Key Ring
  cisco.aci.aci_aaa_key_ring:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: example_key_ring
    state: absent
  delegate_to: localhost

返回值

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

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

集合链接

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