cisco.aci.aci_key_policy 模块 – 管理密钥策略 (fv:KeyPol)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构中密钥链策略的密钥策略。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定值，则将改用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定值，并且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。 默认值： "orchestrator:ansible"
certificate_name 别名: cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定值，则将改用环境变量 ACI_CERTIFICATE_NAME 的值。
description 别名: descr 字符串	密钥链策略的描述。
end_time 字符串	密钥策略的结束时间。 在创建期间未设置时，APIC 默认值为 infinite。 格式为 YYYY-MM-DD HH:MM:SS
host 别名: hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定值，则将改用环境变量 ACI_HOST 的值。
id 整数	对象标识符。
keychain_policy 别名: keychain_policy_name 字符串	现有密钥链策略的名称。
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 的值。
pre_shared_key 字符串	预共享身份验证密钥。 使用 *pre_shared_key* 时，此模块将始终显示为 changed，因为模块无法知道当前配置的密钥是什么。
private_key 别名: cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将被忽略。 如果任务中未指定值，则将改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
start_time 字符串	密钥策略的开始时间。 在创建期间未设置时，APIC 默认值为 now。 格式为 YYYY-MM-DD HH:MM:SS
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
tenant 别名: tenant_name 字符串	现有租户的名称。
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 中使用此模块之前，必须存在 tenant 和 keychain_policy。可以使用 cisco.aci.aci_tenant 和 cisco.aci.aci_keychain_policy 来实现这一点。

另请参阅

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_keychain_policy

管理密钥链策略 (fv:KeyChainPol)。

APIC 管理信息模型参考

有关内部 APIC 类别的更多信息

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    start_time: now
    end_time: infinite
    pre_shared_key: my_password
    state: present
  delegate_to: localhost

- name: Delete an key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    state: absent
  delegate_to: localhost

- name: Query an key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all key policies in my_keychain_policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
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>"
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"

作者

• Gaspard Micol (@gmicol)

集合链接

• 问题追踪器
• 代码仓库