Module for managing Windows Users
Important
If you feel that Salt should be using this module to manage users on a minion, and it is using a different module (or gives an error similar to ‘user.info’ is not available), see here.
| depends: |
|
|---|
Note
This currently only works with local user accounts, not domain accounts
salt.modules.win_useradd.add(name, password=None, fullname=None, description=None, groups=None, home=None, homedrive=None, profile=None, logonscript=None)¶Add a user to the minion.
| Parameters: |
|
|---|---|
| Returns: | True if successful. False is unsuccessful. |
| Return type: |
CLI Example:
salt '*' user.add name password
salt.modules.win_useradd.addgroup(name, group)¶Add user to a group
| Parameters: | |
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.addgroup jsnuffy 'Power Users'
salt.modules.win_useradd.chfullname(name, fullname)¶Change the full name of the user
| Parameters: | |
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.chfullname user 'First Last'
salt.modules.win_useradd.chgroups(name, groups, append=True)¶Change the groups this user belongs to, add append=False to make the user a member of only the specified groups
| Parameters: |
|
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.chgroups jsnuffy Administrators,Users True
salt.modules.win_useradd.chhome(name, home, **kwargs)¶Change the home directory of the user, pass True for persist to move files to the new home directory if the old home directory exist.
| Parameters: | |
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.chhome foo \\fileserver\home\foo True
salt.modules.win_useradd.chprofile(name, profile)¶Change the profile directory of the user
| Parameters: | |
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.chprofile foo \\fileserver\profiles\foo
salt.modules.win_useradd.current(sam=False)¶Get the username that salt-minion is running under. If salt-minion is running as a service it should return the Local System account. If salt is running from a command prompt it should return the username that started the command prompt.
New in version 2015.5.6.
| Parameters: | sam (bool, optional) – False returns just the username without any domain
notation. True returns the domain with the username in the SAM
format. Ie: domain\username |
|---|---|
| Returns: | Returns username |
| Return type: | str |
CLI Example:
salt '*' user.current
salt.modules.win_useradd.delete(name, purge=False, force=False)¶Remove a user from the minion
| Parameters: |
|
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.delete name
salt.modules.win_useradd.getUserSid(username)¶Get the Security ID for the user
| Parameters: | username (str) – The user name for which to look up the SID |
|---|---|
| Returns: | The user SID |
| Return type: | str |
CLI Example:
salt '*' user.getUserSid jsnuffy
salt.modules.win_useradd.getent(refresh=False)¶Return the list of all info for all users
| Parameters: | refresh (bool, optional) – Refresh the cached user information. Useful when used from within a state function. Default is False. |
|---|---|
| Returns: | A dictionary containing information about all users on the system |
| Return type: | dict |
CLI Example:
salt '*' user.getent
salt.modules.win_useradd.info(name)¶Return user information
| Parameters: | name (str) – Username for which to display information |
|---|---|
| Returns: |
|
| Return type: | dict |
CLI Example:
salt '*' user.info jsnuffy
salt.modules.win_useradd.list_groups(name)¶Return a list of groups the named user belongs to
| Parameters: | name (str) – The user name for which to list groups |
|---|---|
| Returns: | A list of groups to which the user belongs |
| Return type: | list |
CLI Example:
salt '*' user.list_groups foo
salt.modules.win_useradd.list_users()¶Return a list of all users on Windows
| Returns: | A list of all users on the system |
|---|---|
| Return type: | list |
CLI Example:
salt '*' user.list_users
salt.modules.win_useradd.removegroup(name, group)¶Remove user from a group
| Parameters: | |
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.removegroup jsnuffy 'Power Users'
salt.modules.win_useradd.rename(name, new_name)¶Change the username for a named user
| Parameters: | |
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.rename jsnuffy jshmoe
salt.modules.win_useradd.setpassword(name, password)¶Set the user’s password
| Parameters: | |
|---|---|
| Returns: | True if successful, otherwise False |
| Return type: |
CLI Example:
salt '*' user.setpassword jsnuffy sup3rs3cr3t
salt.modules.win_useradd.update(name, password=None, fullname=None, description=None, home=None, homedrive=None, logonscript=None, profile=None, expiration_date=None, expired=None, account_disabled=None, unlock_account=None, password_never_expires=None, disallow_change_password=None)¶Updates settings for the windows user. Name is the only required parameter. Settings will only be changed if the parameter is passed a value.
New in version 2015.8.0.
| Parameters: |
|
|---|---|
| Returns: | True if successful. False is unsuccessful. |
| Return type: |
CLI Example:
salt '*' user.update bob password=secret profile=C:\Users\Bob
home=\server\homeshareob homedrive=U:
Docs for previous releases are available on readthedocs.org.
Latest Salt release: 2018.3.3