Documentation

group - Add or remove groups

Synopsis

  • Manage presence of groups on a host.

Options

parameter required default choices comments
gid
no
Optional GID to set for the group.
name
yes
Name of the group to manage.
state
no present
  • present
  • absent
Whether the group should be present or not on the remote host.
system
no no
  • yes
  • no
If yes, indicates that the group created is a system group.

Examples

# Example group command from Ansible Playbooks
- group:
    name: somegroup
    state: present

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Support

This module is maintained by those with core commit privileges

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.