win_user – Manages local Windows user accounts¶
Synopsis¶
- Manages local Windows user accounts.
- For non-Windows targets, use the user module instead.
Parameters¶
See Also¶
See also
- user – Manage user accounts
- The official documentation on the user module.
- win_domain_membership – Manage domain/workgroup membership for a Windows host
- The official documentation on the win_domain_membership module.
- win_domain_user – Manages Windows Active Directory user accounts
- The official documentation on the win_domain_user module.
- win_group – Add and remove local groups
- The official documentation on the win_group module.
- win_group_membership – Manage Windows local group membership
- The official documentation on the win_group_membership module.
- win_user_profile – Manages the Windows user profiles
- The official documentation on the win_user_profile module.
Examples¶
- name: Ensure user bob is present
win_user:
name: bob
password: B0bP4ssw0rd
state: present
groups:
- Users
- name: Ensure user bob is absent
win_user:
name: bob
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Core Team. [core]
Red Hat Support¶
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors¶
- Paul Durivage (@angstwad)
- Chris Church (@cchurch)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.