ansible.windows.win_user – Manages local Windows user accounts¶
Note
This plugin is part of the ansible.windows collection (version 1.4.0).
To install it use: ansible-galaxy collection install ansible.windows
.
To use it in a playbook, specify: ansible.windows.win_user
.
Synopsis¶
Manages local Windows user accounts.
For non-Windows targets, use the ansible.builtin.user module instead.
Parameters¶
Notes¶
Note
The return values are based on the user object after the module options have been set. When running in check mode the values will still reflect the existing user settings and not what they would have been changed to.
See Also¶
See also
- ansible.builtin.user
The official documentation on the ansible.builtin.user module.
- ansible.windows.win_domain_membership
The official documentation on the ansible.windows.win_domain_membership module.
- community.windows.win_domain_user
The official documentation on the community.windows.win_domain_user module.
- ansible.windows.win_group
The official documentation on the ansible.windows.win_group module.
- ansible.windows.win_group_membership
The official documentation on the ansible.windows.win_group_membership module.
- community.windows.win_user_profile
The official documentation on the community.windows.win_user_profile module.
Examples¶
- name: Ensure user bob is present
ansible.windows.win_user:
name: bob
password: B0bP4ssw0rd
state: present
groups:
- Users
- name: Ensure user bob is absent
ansible.windows.win_user:
name: bob
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Paul Durivage (@angstwad)
Chris Church (@cchurch)