Модуль cyberark.pas.cyberark_credential — получение учетных данных с помощью AAM Central Credential Provider.

Примечание

Этот модуль входит в коллекцию cyberark.pas (версия 1.0.39).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install cyberark.pas.

Чтобы использовать ее в плейбуке, укажите: cyberark.pas.cyberark_credential.

Добавлено в cyberark.pas 1.0.0

Описание
Параметры
Примеры
Возвращаемые значения

Описание

Создает URI для получения учетных данных из объекта пароля, хранящегося в Cyberark Vault. Запрос использует SDK веб-служб Privileged Account Security через Central Credential Provider, запрашивая доступ с помощью идентификатора приложения.

Параметры

Параметр	Описание
api_base_url string / обязательный	Строка с базовым URL-адресом сервера, на котором размещен Central Credential Provider.
app_id string / обязательный	Строка с идентификатором приложения, которому разрешено получать учетные данные.
client_cert string	Строка с расположением и именем файла клиентского сертификата, используемого для аутентификации.
client_key string	Строка с расположением и именем файла закрытого ключа клиентского сертификата, используемого для аутентификации.
connection_timeout integer	Целое число, задающее время ожидания, по истечении которого запрос завершается с ошибкой. По умолчанию: `30`
fail_request_on_password_change boolean	Логический параметр, определяющий, следует ли завершить запрос, если в данный момент меняется пароль запрашиваемых учетных данных. Варианты: `false` ← (по умолчанию) `true`
path string	Строка с путем к API Accounts службы AIM. По умолчанию: `"/AIMWebService/api/Accounts"`
query string / обязательный	Строка со сведениями об объекте, который запрашивается; Возможные параметры: Safe, Folder, Object (внутреннее имя учетной записи), UserName, Address, Database, PolicyID.
query_format string	Формат, в котором CCP получит ваш запрос. Варианты: `"Exact"` ← (по умолчанию) `"Regexp"`
reason string	Причина запроса учетных данных, если это предусмотрено политикой; Ее необходимо указать, если политика, управляющая объектом, требует этого.
validate_certs boolean	Если значение `false`, цепочка SSL-сертификатов проверяться не будет. Значение `true` следует задавать только в том случае, если на каждом узле установлен сертификат корневого центра сертификации. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: credential retrieval basic
  cyberark.pas.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.pas.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 boolean	Указывает, привело ли выполнение плейбука к каким-либо изменениям учетной записи. Возвращается: всегда
failed boolean	Указывает, завершилось ли выполнение плейбука ошибкой любого рода. Возвращается: всегда
result complex	Результат выполнения действия в формате JSON. Возвращается: при успешном выполнении
Address string	Целевой адрес запрашиваемых учетных данных Возвращается: если требуется
Content string	Пароль запрашиваемого объекта Возвращается: всегда
CPMDisabled string	Описание причины, по которой эти учетные данные из хранилища не управляются CPM. Возвращается: если управление CPM отключено и указана причина
CreationMethod string	Способ создания объекта в Vault Возвращается: всегда
DeviceType string	Внутренняя категория файлов для более детального управления платформами. Возвращается: всегда
Folder string	Папка в сейфе, где хранятся учетные данные. Возвращается: всегда
LogonDomain string	Понятное имя адреса, определенное CPM Возвращается: если задано
Name string	Уникальный идентификатор запрашиваемого объекта в Cyberark. Возвращается: всегда
PasswordChangeInProcess boolean	Указывает, установлен ли CPM флаг изменения пароля Возвращается: всегда
PolicyID string	Указывает, назначена ли политика проверки SSL-сертификатов. Возвращается: если назначено политике
Safe string	Сейф, в котором хранятся запрашиваемые учетные данные Возвращается: всегда
Username string	Имя пользователя запрашиваемых учетных данных Возвращается: если требуется
status_code integer	Код состояния HTTP-ответа. Возвращается: при успешном выполнении Пример: `"200, 201, -1, 204"`

Авторы

Edward Nunez (@enunez-cyberark)
CyberArk BizDev (@cyberark-bizdev)
Erasmo Acosta (@erasmix)
James Stutes (@JimmyJamCABD)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cyberark/pas/cyberark_credential_module.html