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

Примечание

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

Атрибуты

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

Примеры

- name: Create a user group
  theforeman.foreman.usergroup:
    name: test
    admin: false
    roles:
      - Manager
    users:
      - myuser1
      - myuser2
    usergroups:
      - mynestedgroup
    state: present

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Описание
entity словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращено: успех
usergroups список / элементы=словарь	Список групп пользователей. Возвращено: успех

Авторы

Baptiste Agasse (@bagasse)

Ссылки на сборку

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