ansible/rst/modules/group.rst

.. _group:

group
`````

Adds or removes groups.

+--------------------+----------+---------+----------------------------------------------------------------------------+
| parameter          | required | default | comments                                                                   |
+====================+==========+=========+============================================================================+
| name               | yes      |         | name of the group                                                          |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| gid                |          |         | optional git to set for the group                                          |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| state              |          | present | 'absent' or 'present'                                                      |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| system             |          | no      | if 'yes', indicates that the group being created is a system group.        |
+--------------------+----------+---------+----------------------------------------------------------------------------+

To control members of the group, see the users resource.

Example action from Ansible :doc:`playbooks`::

   group name=somegroup state=present