ansible.builtin.group (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Manage presence of groups on a host.

For Windows targets, use the M(win_group) module instead.

Requirements

• groupadd
• groupdel
• groupmod

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure group "somegroup" exists
  group:
    name: somegroup
    state: present

Inputs

    
gid:
    description:
    - Optional I(GID) to set for the group.
    type: int

name:
    description:
    - Name of the group to manage.
    required: true
    type: str

local:
    default: false
    description:
    - Forces the use of "local" command alternatives on platforms that implement it.
    - This is useful in environments that use centralized authentication when you want
      to manipulate the local groups. (e.g. it uses C(lgroupadd) instead of C(groupadd)).
    - This requires that these commands exist on the targeted host, otherwise it will
      be a fatal error.
    type: bool
    version_added: '2.6'
    version_added_collection: ansible.builtin

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Whether the group should be present or not on the remote host.
    type: str

system:
    default: false
    description:
    - If I(yes), indicates that the group created is a system group.
    type: bool

non_unique:
    default: false
    description:
    - This option allows to change the group ID to a non-unique value. Requires C(gid).
    - Not supported on macOS or BusyBox distributions.
    type: bool
    version_added: '2.8'
    version_added_collection: ansible.builtin

See also

• user
• win_group