W3cubDocs

/Ansible

win_group - Add and remove local groups

New in version 1.7.

Synopsis

  • Add and remove local groups.
  • For non-Windows targets, please use the group module instead.

Options

parameter required default choices comments
description
no
Description of the group
name
yes
Name of the group
state
no present
  • present
  • absent
Create or remove the group

Examples

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

- name: Remove a group
  win_group:
    name: deploy
    state: absent

Notes

Note

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

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.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

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

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/win_group_module.html