Модуль cyberark.pas.cyberark_credential – Получение учетных данных с помощью центрального поставщика учетных данных AAM.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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. Запрос использует веб-службы Privileged Account Security SDK через центрального поставщика учетных данных, запрашивая доступ с помощью идентификатора приложения.

Параметры

Параметр	Комментарии
api_base_url строка / обязательно	Строка, содержащая базовый URL-адрес сервера, на котором размещён центральный поставщик учетных данных.
app_id строка / обязательно	Строка, содержащая идентификатор приложения, авторизованного для получения учетных данных.
client_cert строка	Строка, содержащая путь и имя файла с клиентом сертификата, используемого для аутентификации.
client_key строка	Строка, содержащая путь и имя файла с приватным ключом клиентского сертификата, используемого для аутентификации.
connection_timeout целое число	Целое значение, определяющее время ожидания перед возвратом запроса с ошибкой. По умолчанию: `30`
fail_request_on_password_change булево	Булевый параметр для завершения запроса посередине изменения пароля запрашиваемых учетных данных. Выбор: `false` ← (по умолчанию) `true`
path строка	Строковый перезадающий контекстный путь
query строка / обязательно	Строка, содержащая детали запрошенного объекта; Возможные параметры могут быть Safe, Folder, Object (внутреннее имя учётной записи), UserName, Address, Database, PolicyID.
query_format строка	Формат, в котором CCP получит ваш запрос. Выбор: `"Exact"` ← (по умолчанию) `"Regexp"`
reason строка	Причина запроса учетных данных, если это требуется политикой; Она должна быть указана, если политика, управляющая объектом, требует этого.
validate_certs булево	Если `false`, цепочка сертификатов SSL не будет проверена. Это должно быть установлено в `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

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
changed boolean	Указывает, привело ли выполнение книги задач к каким-либо изменениям в учетной записи. Возвращается: всегда
failed boolean	Указывает, привело ли выполнение книги задач к каким-либо ошибкам. Возвращается: всегда
result complex	JSON-представление результата действия. Возвращается: при успехе
Адрес string	Адрес целевого объекта запроса. Возвращается: если требуется
Контент string	Пароль объекта запроса. Возвращается: всегда
CPMDisabled string	Описание причины, по которой заархивированный объект запроса не управляется CPM. Возвращается: если управление CPM отключено и указана причина
CreationMethod string	Метод создания объекта в хранилище. Возвращается: всегда
Тип устройства string	Внутренняя категория файлов для более точного управления платформами. Возвращается: всегда
Папка string	Папка в хранилище, где хранится объект запроса. Возвращается: всегда
Домен входа string	Дружественное имя адреса, разрешенное CPM. Возвращается: если заполнено
Имя string	Уникальный идентификатор объекта Cyberark запрошенного объекта. Возвращается: всегда
Изменение пароля в процессе boolean	Если CPM установил флаг изменения пароля. Возвращается: всегда
PolicyID string	Указывает, нужно ли проверять сертификаты SSL. Возвращается: если присвоено политике
Хранилище string	Хранилище, где хранится запрошенный объект. Возвращается: всегда
Имя пользователя 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cyberark/pas/cyberark_credential_module.html