ansible.builtin.group – Добавить или удалить группы

Примечание

Этот модуль входит в состав ansible-base и включён во все установки Ansible. В большинстве случаев, вы можете использовать короткое имя модуля group даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя класса (FQCN) для удобной ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь такое же имя модуля.

Добавлен в версии 0.0.2: модуля ansible.builtin

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление наличием групп на узле.
Для целевых систем Windows используйте модуль ansible.windows.win_group вместо этого.

Требования

Ниже перечислены требования, которые должны быть выполнены на узле, на котором выполняется данный модуль.

groupadd
groupdel
groupmod

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
gid целое число		Необязательный GID для установки группы.
local булево добавлен в версии 2.6 ansible.builtin	Варианты: нет ← да	Принудительно использует альтернативы команд "local" на платформах, которые их поддерживают. Это полезно в средах с централизованной аутентификацией, когда необходимо управлять локальными группами. (например, использует `lgroupadd` вместо `groupadd`). Требует, чтобы эти команды существовали на целевом узле, иначе произойдёт ошибка.
name строка / обязательно		Имя группы для управления.
non_unique булево добавлен в версии 2.8 ansible.builtin	Варианты: нет ← да	Этот параметр позволяет изменить идентификатор группы на не уникальное значение. Требует `gid`. Не поддерживается на macOS или дистрибутивах BusyBox.
state строка	Варианты: отсутствует наличие ←	Определяет, должна ли группа присутствовать на удалённом узле или нет.
system булево	Варианты: нет ← да	Если да, указывает, что созданная группа — это системная группа.

Примечания

Примечание

Поддерживает check_mode.

См. также

ansible.builtin.user: Официальная документация модуля ansible.builtin.user.
ansible.windows.win_group: Официальная документация модуля ansible.windows.win_group.

Примеры

- name: Ensure group "somegroup" exists
  ansible.builtin.group:
    name: somegroup
    state: present

- name: Ensure group "docker" exists with correct gid
  ansible.builtin.group:
    name: docker
    state: present
    gid: 1750

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
gid целое число	Когда `state` равно 'наличие'	Идентификатор группы. Пример: 1001
name строка	всегда	Имя группы. Пример: users
state строка	всегда	Присутствует или отсутствует группа. Пример: отсутствует
system булево	Когда `state` равно 'наличие'	Является ли группа системной или нет.

Авторы

Stephen Fromm (@sfromm)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/group_module.html