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

Статус

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

Автор

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.5/modules/cyberark_authentication_module.html