Модуль theforeman.foreman.usergroup — управление группами пользователей
Примечание
Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.usergroup.
Добавлено в theforeman.foreman 1.0.0
Краткое описание
- Создание, обновление и удаление групп пользователей
Псевдонимы: foreman_usergroup
Требования
Следующие требования должны быть выполнены на узле, где выполняется этот модуль.
- requests
Параметры
Параметр | Комментарии |
|---|---|
admin boolean | Являются ли пользователи этой группы администраторами Варианты:
|
ca_path path | Файл в формате PEM, содержащий сертификат ЦС для проверки. Если значение не указано в задаче, вместо него используется значение переменной окружения |
name string / обязательный | Имя группы |
oauth1_consumer_key string | Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
oauth1_consumer_secret string | Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
password string | Пароль пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
roles list / элементы=string | Список ролей, назначенных группе |
server_url string / обязательный | URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
state string | Состояние сущности Варианты:
|
updated_name string | Новое имя группы пользователей. Если задан этот параметр, модуль не будет идемпотентным. |
use_gssapi boolean | Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Необходимо установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него используется значение переменной окружения Варианты:
|
usergroups list / элементы=string | Список других групп, назначенных этой группе |
username string | Имя пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения |
users list / элементы=string | Список пользователей, назначенных группе |
validate_certs boolean | Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Модуль можно запускать в режиме check_mode; он возвращает прогноз изменения состояния без изменения сущности |
diff_mode | Поддержка: полная | В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в режиме check_mode) |
Примеры
- name: Create a user group
theforeman.foreman.usergroup:
name: test
admin: false
roles:
- Manager
users:
- myuser1
- myuser2
usergroups:
- mynestedgroup
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, характерные только для этого модуля:
Ключ | Описание |
|---|---|
entity dictionary | Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успехе |
|
usergroups list / элементы=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/usergroup_module.html
