Модуль theforeman.foreman.user — управление пользователями
Примечание
Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в playbook, укажите: theforeman.foreman.user.
Добавлено в theforeman.foreman 1.0.0
Краткое описание
- Создание, обновление и удаление пользователей
Псевдонимы: foreman_user
Требования
Указанные ниже требования необходимы на узле, на котором выполняется этот модуль.
- requests
Параметры
Параметр | Комментарии |
|---|---|
admin boolean | Является ли пользователь администратором Варианты:
|
auth_source string | Источник аутентификации, в котором существует пользователь |
ca_path path | Файл в формате PEM, содержащий сертификат ЦС, который будет использоваться для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
default_location string | Местоположение, используемое пользователем по умолчанию |
default_organization string | Организация, используемая пользователем по умолчанию |
description string | Описание пользователя |
firstname string | Имя пользователя |
lastname string | Фамилия пользователя |
locale string | Языковая локаль пользователя Варианты:
|
locations list / elements=string | Список местоположений, которым следует назначить объект |
login псевдонимы: name string / обязательный | Имя пользователя |
string |
Обязателен при создании нового пользователя |
oauth1_consumer_key string | Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
oauth1_consumer_secret string | Секретный ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
organizations list / elements=string | Список организаций, которым следует назначить объект |
password string | Пароль пользователя для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
roles list / elements=string | Список ролей, назначенных пользователю |
server_url string / обязательный | URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
state string | Состояние объекта Варианты:
|
timezone string | Часовой пояс пользователя Если значение не задано, будет использоваться часовой пояс браузера. Варианты:
|
use_gssapi boolean | Использовать GSSAPI для аутентификации; обычно это Kerberos или аутентификация Kerberos через Negotiate. Требуется установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
user_password string | Пароль пользователя. При использовании этого параметра модуль не будет идемпотентным. |
username string | Имя пользователя для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
validate_certs boolean | Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Модуль может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя объект |
diff_mode | Поддержка: полная | В режиме diff возвращает сведения об изменениях (или о том, что, возможно, потребуется изменить в режиме check_mode) |
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
entity dictionary | Итоговое состояние затронутых объектов, сгруппированных по типу. Возвращается: при успехе |
|
users list / elements=dictionary |
Список пользователей. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/theforeman/foreman/user_module.html