ansible.windows.win_group_module.rst

ansible.windows.win_group

Add and remove local groups

• Synopsis
• Parameters
• See Also
• Examples
• Status

Synopsis

• Add and remove local groups.
• For non-Windows targets, please use the :ref:`ansible.builtin.group <ansible.builtin.group_module>` module instead.

Parameters

Parameter	Choices/Defaults	Comments
description string		Description of the group.
name string / required		Name of the group.
state string	Choices: absent present ←	Create or remove the group.

See Also

.. seealso::

   :ref:`ansible.builtin.group_module`
      The official documentation on the **ansible.builtin.group** module.
   :ref:`community.windows.win_domain_group_module`
      The official documentation on the **community.windows.win_domain_group** module.
   :ref:`ansible.windows.win_group_membership_module`
      The official documentation on the **ansible.windows.win_group_membership** module.

Examples

- name: Create a new group
  ansible.windows.win_group:
    name: deploy
    description: Deploy Group
    state: present

- name: Remove a group
  ansible.windows.win_group:
    name: deploy
    state: absent

Status

Authors

• Chris Hoffman (@chrishoffman)