ansible.windows.win_group (2.3.0) — module

Install collection

Install with ansible-galaxy collection install ansible.windows:==2.3.0

Add to requirements.yml

  collections:
    - name: ansible.windows
      version: 2.3.0

Description

Add and remove local groups.

For non-Windows targets, please use the M(ansible.builtin.group) module instead.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - Name of the group.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Create or remove the group.
    type: str

description:
    description:
    - Description of the group.
    type: str

See also

• ansible.builtin.group
• community.windows.win_domain_group
• ansible.windows.win_group_membership