cyberark.pas.cyberark_credential 模块 – 使用 AAM 中央凭证提供程序检索凭证。
注意
此模块是 cyberark.pas 集合（版本 1.0.30）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cyberark.pas。
要在 playbook 中使用它，请指定：cyberark.pas.cyberark_credential。
cyberark.pas 1.0.0 中的新增功能
概要
创建一个 URI，用于从 Cyberark Vault 中存储的密码对象检索凭证。该请求通过使用应用程序 ID 请求访问，使用特权帐户安全 Web 服务 SDK 通过中央凭证提供程序进行。
参数
参数 |
注释 |
|---|---|
一个包含托管中央凭证提供程序的服务器的基本 URL 的字符串。 |
|
一个包含被授权检索凭证的应用程序 ID 的字符串。 |
|
一个包含用于身份验证的客户端证书的文件位置和名称的字符串。 |
|
一个包含用于身份验证的客户端证书的私钥的文件位置和名称的字符串。 |
|
请求返回失败之前允许的时间的整数值。 默认值: |
|
一个布尔参数，用于在请求的凭证的密码更改过程中完成请求。 选项
|
|
上下文路径的字符串覆盖 |
|
一个包含被查询对象的详细信息的字符串； 可能的参数可以是 Safe、Folder、Object （内部帐户名称）、UserName、Address、Database、 PolicyID。 |
|
CCP 接收您的查询的格式。 选项
|
|
如果策略要求，请求凭证的原因； 如果管理对象的策略 要求，则必须指定。 |
|
如果 选项
|
示例
tasks:
- name: credential retrieval basic
cyberark_credential:
api_base_url: "http://10.10.0.1"
app_id: "TestID"
query: "Safe=test;UserName=admin"
register: result
- name: credential retrieval advanced
cyberark_credential:
api_base_url: "https://components.cyberark.local"
validate_certs: true
client_cert: /etc/pki/ca-trust/source/client.pem
client_key: /etc/pki/ca-trust/source/priv-key.pem
app_id: "TestID"
query: "Safe=test;UserName=admin"
connection_timeout: 60
query_format: Exact
fail_request_on_password_change: true
reason: "requesting credential for Ansible deployment"
register: result
返回值
常见的返回值记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
标识 playbook 运行是否以任何方式导致帐户发生更改。 返回: 总是 |
|
playbook 运行是否导致任何类型的失败。 返回: 总是 |
|
结果操作的 json 转储。 返回: 成功 |
|
被查询的凭证的目标地址 返回: 如果需要 |
|
被查询对象的密码 返回: 总是 |
|
关于此保管凭证为何不受 CPM 管理的说明。 返回: 如果禁用 CPM 管理并给出原因 |
|
这是该对象在 Vault 中创建的方式 返回: 总是 |
|
一个内部文件类别，用于更精细地管理平台。 返回: 总是 |
|
凭证存储在 Safe 中的文件夹。 返回: 总是 |
|
由 CPM 解析的地址友好名称 返回: 如果已填充 |
|
被查询凭证的 Cyberark 唯一对象 ID。 返回: 总是 |
|
如果密码有 CPM 设置的更改标志 返回: 总是 |
|
是否应验证 SSL 证书。 返回: 如果分配给策略 |
|
存储被查询凭证的保险箱 返回: 总是 |
|
被查询凭证的用户名 返回: 如果需要 |
|
结果 HTTP 状态代码。 返回: 成功 示例: |