cyberark.pas.cyberark_user – Управление пользователями CyberArk с помощью PAS Web Services SDK.
Примечание
Этот плагин входит в коллекцию cyberark.pas (версия 1.0.5).
Для его установки используйте: ansible-galaxy collection install cyberark.pas.
Для использования в книге задач укажите: cyberark.pas.cyberark_user.
Новое в версии 2.4: плагина cyberark.pas
Описание
- Управление пользователями CyberArk с помощью PAS Web Services SDK. В настоящее время поддерживаются следующие действия: Получение данных о пользователе, Добавление пользователя, Обновление пользователя, Удаление пользователя.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| change_password_on_the_next_logon boolean |
| Требуется ли пользователю изменить пароль при следующей авторизации. |
| cyberark_session словарь / обязательно | Словарь, установленный модулем аутентификации CyberArk, содержащий необходимые значения для выполнения действий в сессии CyberArk. Для примера использования cyberark_session, пожалуйста, обратитесь к модулю cyberark_authentication. | |
| disabled boolean |
| Будет ли пользователь заблокирован. |
| email строка | Электронный адрес пользователя. | |
| expiry_date строка | Дата и время истечения срока действия учетной записи пользователя и ее блокировки. | |
| first_name строка | Имя пользователя. | |
| group_name строка | Имя группы, к которой будет добавлен пользователь. | |
| initial_password строка | Пароль, который новый пользователь будет использовать при первой авторизации. Этот пароль должен соответствовать требованиям политики паролей. Этот параметр обязателен, когда state задан в "Добавить пользователя". | |
| last_name строка | Фамилия пользователя. | |
| location строка | Местоположение хранилища для пользователя. | |
| logging_file строка | По умолчанию: "/tmp/ansible_cyberark.log" | Настройка имени и местоположения файла журнала для отладки. |
| logging_level строка / обязательно |
| Параметр, используемый для определения уровня вывода отладки в значение logging_file. |
| new_password строка | Обновленный пароль пользователя. Убедитесь, что этот пароль соответствует требованиям политики паролей. | |
| state строка |
| Указывает состояние пользователя (наличие для создания, отсутствие для удаления). |
| user_type_name строка | Тип пользователя. По умолчанию параметр EPVUser. | |
| username строка / обязательно | Имя пользователя, для которого будут запрошены данные (детали), добавлен, обновлен или удален. |
Примеры
- name: Logon to CyberArk Vault using PAS Web Services SDK
cyberark_authentication:
api_base_url: https://components.cyberark.local
use_shared_logon_authentication: yes
- name: Create user & immediately add it to a group
cyberark_user:
username: username
initial_password: password
user_type_name: EPVUser
change_password_on_the_next_logon: no
group_name: GroupOfUser
state: present
cyberark_session: '{{ cyberark_session }}'
- name: Make sure user is present and reset user credential if present
cyberark_user:
username: Username
new_password: password
disabled: no
state: present
cyberark_session: '{{ cyberark_session }}'
- name: Logoff from CyberArk Vault
cyberark_authentication:
state: absent
cyberark_session: '{{ cyberark_session }}'
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| changed boolean | всегда | Были ли внесены изменения. | |
| cyberark_user сложное | всегда | Словарь, содержащий свойства результата. | |
| result словарь | успех | Свойства пользователя, когда state равен "настоящее". | |
| status_code целое число | успех | Код HTTP статуса результата. Пример: 200 | |
Авторы
- Edward Nunez (@enunez-cyberark)
- Cyberark Bizdev (@cyberark-bizdev)
- Erasmo Acosta (@erasmix)
- James Stutes (@jimmyjamcabd)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cyberark/pas/cyberark_user_module.html