cyberark_authentication – Модуль для аутентификации в CyberArk Vault с использованием PAS Web Services SDK

Новое в версии 2.4.

Описание
Параметры
Примеры
Значения возврата
Статус

Описание

Производит аутентификацию в CyberArk Vault с использованием Privileged Account Security Web Services SDK и создаёт факт сессии, который может использоваться другими модулями. Возвращает факт Ansible под названием cyberark_session. Каждый модуль может использовать этот факт как параметр cyberark_session.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_base_url -		Строка, содержащая базовый URL-адрес сервера, на котором размещены веб-службы CyberArk Privileged Account Security.
cyberark_session -		Словарь, устанавливаемый при аутентификации в CyberArk, содержащий различные значения для выполнения действий в залогиненной сессии CyberArk.
new_password -		Новый пароль пользователя. Этот параметр необязателен и позволяет изменить пароль.
password -		Пароль пользователя.
state -	Варианты: present ← absent	Указывает, следует ли добавлять/удалять запись об аутентификации (вход/выход) и факт cyberark_session.
use_radius_authentication boolean	Варианты: no ← yes	Используется ли аутентификация через сервер RADIUS. Допустимые значения — true/false.
use_shared_logon_authentication boolean	Варианты: no ← yes	Используется ли аутентификация Shared Logon.
username -		Имя пользователя, который будет авторизоваться в Vault.
validate_certs boolean	Варианты: no yes ←	Если `false`, сертификаты SSL не будут проверены. Это должно быть установлено только в `false` на сайтах с самозаверяющимися сертификатами.

Примеры

- name: Logon to CyberArk Vault using PAS Web Services SDK - use_shared_logon_authentication
  cyberark_authentication:
    api_base_url: "{{ web_services_base_url }}"
    use_shared_logon_authentication: yes

- name: Logon to CyberArk Vault using PAS Web Services SDK - Not use_shared_logon_authentication
  cyberark_authentication:
    api_base_url: "{{ web_services_base_url }}"
    username: "{{ password_object.password }}"
    password: "{{ password_object.passprops.username }}"
    use_shared_logon_authentication: no

- name: Logoff from CyberArk Vault
  cyberark_authentication:
    state: absent
    cyberark_session: "{{ cyberark_session }}"

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

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

Ключ	Возвращённое значение	Описание
cyberark_session словарь	успех	Факты аутентификации. Пример: {'api_base_url': {'описание': 'Базовый URL для вызовов API. Возвращается в cyberark_session, чтобы его можно было использовать в последующих вызовах.', 'тип': 'строка', 'возвращается': 'всегда'}, 'token': {'описание': 'Токен, идентифицирующий сессию, закодированный в BASE 64.', 'тип': 'строка', 'возвращается': 'всегда'}, 'use_shared_logon_authentication': {'описание': 'Использовалась ли аутентификация Shared Logon для установления сессии.', 'тип': 'логическое', 'возвращается': 'всегда'}, 'validate_certs': {'описание': 'Следует ли проверять сертификаты SSL.', 'тип': 'логическое', 'возвращается': 'всегда'}}

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Edward Nunez @ CyberArk BizDev (@enunez-cyberark, @cyberark-bizdev, @erasmix)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/cyberark_authentication_module.html