ansible.windows.win_group module – Add and remove local groups

Note

This module is part of the ansible.windows collection (version 1.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ansible.windows.

To use it in a playbook, specify: ansible.windows.win_group.

Synopsis

  • Add and remove local groups.

  • For non-Windows targets, please use the ansible.builtin.group module instead.

Parameters

Parameter

Comments

description

string

Description of the group.

name

string / required

Name of the group.

state

string

Create or remove the group.

Choices:

  • "absent"

  • "present" ← (default)

See Also

See also

ansible.builtin.group

The official documentation on the ansible.builtin.group module.

community.windows.win_domain_group

The official documentation on the community.windows.win_domain_group module.

ansible.windows.win_group_membership

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

Authors

  • Chris Hoffman (@chrishoffman)