cyberark.pas.cyberark_credential 模块 – 使用 AAM 中央凭证提供程序检索凭证。

注意

此模块是 cyberark.pas 集合 (版本 1.0.30) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install cyberark.pas

要在剧本中使用它,请指定: cyberark.pas.cyberark_credential

cyberark.pas 1.0.0 中的新增功能

概要

  • 创建用于从存储在 Cyberark Vault 中的密码对象检索凭据的 URI。请求通过中央凭证提供程序使用特权帐户安全 Web 服务 SDK,并通过应用程序 ID 请求访问。

参数

参数

注释

api_base_url

字符串 / 必需

包含托管中央凭证提供程序的服务器的基 URL 的字符串。

app_id

字符串 / 必需

包含用于检索凭据的授权应用程序 ID 的字符串。

client_cert

字符串

包含用于身份验证的客户端证书的文件位置和名称的字符串。

client_key

字符串

包含用于身份验证的客户端证书的私钥的文件位置和名称的字符串。

connection_timeout

整数

请求返回失败之前的允许时间(以整数表示)。

默认值: 30

fail_request_on_password_change

布尔值

一个布尔参数,用于在请求的凭据密码更改过程中完成请求。

选项

  • false ← (默认)

  • true

path

字符串

上下文路径的字符串覆盖

query

字符串 / 必需

包含被查询对象的详细信息的字符串;

可能的参数可能是 Safe、Folder、Object

(内部帐户名称)、用户名、地址、数据库、

PolicyID。

query_format

字符串

CCP 将接收您的查询的格式。

选项

  • "Exact" ← (默认)

  • "Regexp"

reason

字符串

如果策略需要,则请求凭据的原因;

如果管理对象的策略需要,则必须指定。

requires it.

validate_certs

布尔值

如果为 false,则不会验证 SSL 证书链。只有在每个节点上都安装了根 CA 证书的情况下,才应将其设置为 true

选项

  • false

  • true ← (默认)

示例

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

返回值

公共返回值已在此处记录 此处,以下是此模块特有的字段

描述

changed

布尔值

标识剧本运行是否以任何方式导致帐户发生更改。

返回:始终

failed

布尔值

剧本运行是否导致任何类型的失败。

返回:始终

result

复杂类型

结果操作的 JSON 转储。

返回:成功

Address

字符串

正在查询的凭据的目标地址

返回:如果需要

Content

字符串

正在查询的对象的密码

返回:始终

CPMDisabled

字符串

此保管凭据为何没有由 CPM 管理的描述。

返回:如果禁用了 CPM 管理并给出了原因

CreationMethod

字符串

这是对象在 Vault 中的创建方式

返回:始终

DeviceType

字符串

用于更精细地管理平台的内部文件类别。

返回:始终

Folder

字符串

存储凭据的安全中的文件夹。

返回:始终

LogonDomain

字符串

CPM 解析的地址友好名称

返回:如果已填充

Name

字符串

正在查询的凭据的 Cyberark 唯一对象 ID。

返回:始终

PasswordChangeInProcess

布尔值

如果密码具有由 CPM 设置的更改标志

返回:始终

PolicyID

字符串

是否应验证 SSL 证书。

返回:如果分配给策略

Safe

字符串

存储查询凭据的安全

返回:始终

Username

字符串

正在查询的凭据的用户名

返回:如果需要

status_code

整数

结果 HTTP 状态代码。

返回:成功

示例: "200, 201, -1, 204"

作者

  • Edward Nunez (@enunez-cyberark)

  • CyberArk BizDev (@cyberark-bizdev)

  • Erasmo Acosta (@erasmix)

  • James Stutes (@JimmyJamCABD)