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

Примечание

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

Новое в версии 0.0.2: of ansible.builtin

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

Описание

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

Требования

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

groupadd
groupdel
groupmod

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
gid целое число		Необязательный GID для установки группы.
local логический тип добавлен в 2.6 of ansible.builtin	Варианты: нет ← да	Принудительно использует альтернативные «локальные» команды на платформах, которые их поддерживают. Это полезно в средах с централизованной аутентификацией, когда требуется управлять локальными группами. (например, использует `lgroupadd` вместо `groupadd`). Это требует, чтобы эти команды существовали на целевом хосте, в противном случае это будет фатальная ошибка.
name строка / обязательный		Имя группы для управления.
non_unique логический тип добавлен в 2.8 of 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/group_module.html