W3cubDocs

/Ansible 2.11

ansible.windows.win_group – Add and remove local groups

Note

This plugin is part of the ansible.windows collection (version 1.3.0).

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 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

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/windows/win_group_module.html