ansible.windows.win_user – Manages local Windows user accounts
ansible.windows.win_user – Manages local Windows user accounts
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_user
.
Synopsis
- Manages local Windows user accounts.
- For non-Windows targets, use the ansible.builtin.user module instead.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
account_disabled boolean |
|
|
account_locked boolean |
|
Only |
description string |
Description of the user. | |
fullname string |
Full name of the user. | |
groups list / elements=string |
Adds or removes the user from this comma-separated list of groups, depending on the value of groups_action. When groups_action is | |
groups_action string |
|
If If If |
home_directory string added in 1.0.0 of ansible.windows |
The designated home directory of the user. | |
login_script string added in 1.0.0 of ansible.windows |
The login script of the user. | |
name string / required |
Name of the user to create, remove or modify. | |
password string |
Optionally set the user's password to this (plain text) value. | |
password_expired boolean |
|
|
password_never_expires boolean |
|
|
profile string added in 1.0.0 of ansible.windows |
The profile path of the user. | |
state string |
|
When When When |
update_password string |
|
|
user_cannot_change_password boolean |
|
|
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:
Key | Returned | Description |
---|---|---|
account_disabled boolean |
user exists |
Whether the user is disabled.
|
account_locked boolean |
user exists |
Whether the user is locked.
|
description string |
user exists |
The description set for the user.
Sample: Username for test |
fullname string |
user exists |
The full name set for the user.
Sample: Test Username |
groups list / elements=string |
user exists |
A list of groups and their ADSI path the user is a member of.
Sample: [{'name': 'Administrators', 'path': 'WinNT://WORKGROUP/USER-PC/Administrators'}] |
name string |
always |
The name of the user
Sample: username |
password_expired boolean |
user exists |
Whether the password is expired.
|
password_never_expires boolean |
user exists |
Whether the password is set to never expire.
Sample: True |
path string |
user exists |
The ADSI path for the user.
Sample: WinNT://WORKGROUP/USER-PC/username |
sid string |
user exists |
The SID for the user.
Sample: S-1-5-21-3322259488-2828151810-3939402796-1001 |
user_cannot_change_password boolean |
user exists |
Whether the user can change their own password.
|
Authors
- Paul Durivage (@angstwad)
- Chris Church (@cchurch)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/windows/win_user_module.html