cyberark.pas.cyberark_credential – Получение учетных данных с помощью центрального поставщика учетных данных AAM.
Примечание
Этот плагин входит в коллекцию cyberark.pas (версия 1.0.5).
Для его установки используйте: ansible-galaxy collection install cyberark.pas.
Для использования в книге задач укажите: cyberark.pas.cyberark_credential.
В версии 2.4: плагина cyberark.pas
Обзор
- Создает URI для получения учетных данных из объекта пароля, хранящегося в хранилище Cyberark Vault. Запрос использует веб-службы Privileged Account Security SDK через центрального поставщика учетных данных, запрашивая доступ с помощью идентификатора приложения.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_base_url строка / обязательно | Строка, содержащая базовый URL-адрес сервера, на котором размещен центральный поставщик учетных данных. | |
| app_id строка / обязательно | Строка, содержащая идентификатор приложения, имеющего разрешения на получение учетных данных. | |
| client_cert строка | Строка, содержащая путь и имя файла клиентского сертификата, используемого для аутентификации. | |
| client_key строка | Строка, содержащая путь и имя файла закрытого ключа клиентского сертификата, используемого для аутентификации. | |
| connection_timeout целое число | По умолчанию: "30" | Целочисленное значение допустимого времени ожидания запроса, после которого он будет считаться не выполненным. |
| fail_request_on_password_change логическое значение |
| Логический параметр для завершения запроса в середине смены пароля запрошенных учетных данных. |
| query строка / обязательно | Строка, содержащая детали запрашиваемого объекта; Возможные параметры: Safe, Folder, Object (внутреннее имя учетной записи), UserName, Address, Database, PolicyID. | |
| query_format строка |
| Формат, в котором запрос будет получен CCP. |
| reason строка | Причина запроса учетных данных, если это требуется политикой; Его нужно указать, если политика, управляющая объектом, требует его. | |
| validate_certs логическое значение |
| Если false, цепочка сертификатов SSL не будет проверена. Это должно быть установлено только в 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: yes
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 строка | всегда | Способ создания объекта в хранилище | |
| DeviceType строка | всегда | Внутренняя категория файлов для более детального управления платформами. | |
| Folder строка | всегда | Папка в хранилище, где хранятся учетные данные. | |
| LogonDomain строка | если заполнен | Дружественное имя адреса, разрешенное CPM | |
| Name строка | всегда | Уникальный идентификатор объекта Cyberark запрашиваемых учетных данных. | |
| 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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cyberark/pas/cyberark_credential_module.html
