Модуль theforeman.foreman.user — Управление пользователями
Примечание
Этот модуль входит в коллекцию theforeman.foreman (версия 4.2.0).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.
Для использования в плейбуке укажите: theforeman.foreman.user.
Добавлен в theforeman.foreman 1.0.0
Обзор
- Создание, обновление и удаление пользователей
Псевдонимы: foreman_user
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- requests
Параметры
Параметр | Комментарии |
|---|---|
admin boolean | Является ли пользователь администратором Выбор:
|
auth_source string | Источник аутентификации, в котором существует пользователь |
default_location string | Местоположение, используемое пользователем по умолчанию |
default_organization string | Организация, используемая пользователем по умолчанию |
description string | Описание пользователя |
firstname string | Имя пользователя |
lastname string | Фамилия пользователя |
locale string | Языковой регион пользователя Выбор:
|
locations list / elements=string | Список местоположений, которые должны быть назначены сущности |
login aliases: name string / обязательно | Имя пользователя |
string | Электронный адрес пользователя Требуется при создании нового пользователя |
organizations list / elements=string | Список организаций, которые должны быть назначены сущности |
password string / обязательно | Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды |
roles list / elements=string | Список ролей, назначенных пользователю |
server_url string / обязательно | URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды |
state string | Состояние сущности Выбор:
|
часовой пояс строка | Часовой пояс пользователя Если пусто, будет использоваться часовой пояс браузера. Варианты:
|
пароль_пользователя строка | Пароль пользователя. При установке этого параметра модуль не будет идемпотентным. |
имя_пользователя строка / обязательный | Имя пользователя, используемого для доступа к серверу Foreman. Если значение не указано в задаче, будет использоваться значение переменной окружения |
проверять_сертификаты булево | Необходимо ли проверять сертификаты TLS сервера Foreman. Если значение не указано в задаче, будет использоваться значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
режим_проверки | Поддержка: полная | Может работать в режиме проверки и возвращать прогноз изменения состояния без изменения сущности |
режим_сравнения | Поддержка: полная | Возвращает подробности о том, что изменилось (или, возможно, требует изменения в режиме проверки), при сравнении |
Примеры
- name: Create a user
theforeman.foreman.user:
name: test
firstname: Test
lastname: Userson
mail: test.userson@example.com
description: Dr. Test Userson
admin: false
user_password: s3cret
default_location: Test Location
default_organization: Test Organization
auth_source: Internal
timezone: Stockholm
locale: sv_SE
roles:
- Manager
locations:
- Test Location
organizations:
- Test Organization
state: present
- name: Update a user
theforeman.foreman.user:
name: test
firstname: Tester
state: present
- name: Change password
theforeman.foreman.user:
name: test
user_password: newp@ss
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
сущность словарь | Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращается: успех |
|
пользователи список / элементы=словарь |
Список пользователей. Возвращается: успех |
Ссылки на сборку
© 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/theforeman/foreman/user_module.html