Модуль theforeman.foreman.external_usergroup — Управление внешними группами пользователей

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.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 строка / обязательно	Имя источника аутентификации, который будет использоваться для этой группы
name строка / обязательно	Имя группы
password строка / обязательно	Пароль пользователя, обращаясь к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
server_url строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
state строка	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
usergroup строка / обязательно	Имя связанной группы пользователей
username строка / обязательно	Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USERNAME`.
validate_certs логическое	Требовать ли проверку сертификатов TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме check_mode и возвращать предсказание о том, изменилось ли состояние, не изменяя сущность
diff_mode	Поддержка: полная	Возвращает подробности о том, что изменилось (или, возможно, нужно изменить в режиме check_mode), когда используется режим diff

Примеры

- 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 словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращается: успех
external_usergroups список / элементы=словарь	Список внешних групп пользователей. Возвращается: успех

Авторы

Кирилл Ширинкин (@Fodoj)

Ссылки на коллекцию

© 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/external_usergroup_module.html