Модуль theforeman.foreman.external_usergroup – Управление внешними группами пользователей
Примечание
Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.external_usergroup.
Добавлено в theforeman.foreman 1.0.0
Краткое описание
- Создание, обновление и удаление внешних групп пользователей
Псевдонимы: foreman_external_usergroup
Требования
Перечисленные ниже компоненты должны быть установлены на узле, который выполняет этот модуль.
- requests
Параметры
Параметр | Комментарии |
|---|---|
auth_source псевдонимы: auth_source_ldap string / обязательный | Имя источника аутентификации, используемого для этой группы |
ca_path path | Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
name string / обязательный | Имя группы |
oauth1_consumer_key string | Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
oauth1_consumer_secret string | Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
password string | Пароль пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
server_url string / обязательный | URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
state string | Состояние сущности Варианты:
|
use_gssapi boolean | Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Требуется установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
usergroup string / обязательный | Имя связанной группы пользователей |
username string | Имя пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
validate_certs boolean | Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Модуль может работать в режиме check_mode и возвращать прогноз изменений, не изменяя сущность |
diff_mode | Поддержка: полная | В режиме diff возвращает сведения об изменениях (или о возможных изменениях в режиме check_mode) |
Примеры
- name: Create an external user group
theforeman.foreman.external_usergroup:
name: test
auth_source: "My LDAP server"
usergroup: "Internal Usergroup"
state: present
- name: Link a group from FreeIPA
theforeman.foreman.external_usergroup:
name: ipa_users
auth_source: "External"
usergroup: "Internal Usergroup"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
entity dictionary | Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успехе |
|
external_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/external_usergroup_module.html
