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

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

Обзор
Параметры
Примеры
Возвращаемые значения
- Статус

Обзор

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

Параметры

параметр	обязателен	по умолчанию	значения	комментарии
api_base_url	нет			Строка, содержащая базовый URL-адрес сервера, на котором размещены веб-службы Privileged Account Security CyberArk.
cyberark_session	нет			Словарь, устанавливаемый модулем аутентификации CyberArk, содержащий различные значения для выполнения действий в залогиненной сессии CyberArk.
new_password	нет			Новый пароль пользователя. Этот параметр необязателен и позволяет изменить пароль.
password	нет			Пароль пользователя.
state	нет	present	present absent	Указывает, нужно ли добавить/удалить запись входа/выхода и факт cyberark_session.
use_radius_authentication	нет	нет	да нет	Указывает, будут ли пользователи аутентифицированы через RADIUS-сервер. Допустимые значения — true/false.
use_shared_logon_authentication	нет	нет	да нет	Использовать ли аутентификацию Shared Logon.
username	нет			Имя пользователя, который войдет в Vault.
validate_certs	нет	да	да нет	Если `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	Факты аутентификации.	успех	словарь	{'token': {'тип': 'строка', 'описание': 'Токен, идентифицирующий сессию, закодирован в BASE 64.', 'возвращается': 'всегда'}, 'validate_certs': {'тип': 'логическое', 'описание': 'Проверять ли сертификаты SSL.', 'возвращается': 'всегда'}, 'use_shared_logon_authentication': {'тип': 'логическое', 'описание': 'Использовалась ли аутентификация Shared Logon для создания сессии.', 'возвращается': 'всегда'}, 'api_base_url': {'тип': 'строка', 'описание': 'Базовый URL для вызовов API. Возвращается в cyberark_session, чтобы его можно было использовать в последующих вызовах.', 'возвращается': 'всегда'}}

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.

Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, прочитайте Информация о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.

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