salt.modules.win_useradd¶
Manage Windows users with the net user command
NOTE: This currently only works with local user accounts, not domain accounts
-
salt.modules.win_useradd.
add
(name, uid=None, gid=None, groups=None, home=False, shell=None, unique=False, system=False, fullname=False, roomnumber=False, workphone=False, homephone=False, createhome=False)¶ Add a user to the minion
CLI Example:
salt '*' user.add name password
-
salt.modules.win_useradd.
addgroup
(name, group)¶ Add user to a group
CLI Example:
salt '*' user.addgroup username groupname
-
salt.modules.win_useradd.
chfullname
(name, fullname)¶ Change the full name of the user
CLI Example:
salt '*' user.chfullname user 'First Last'
-
salt.modules.win_useradd.
chgroups
(name, groups, append=False)¶ Change the groups this user belongs to, add append to append the specified groups
CLI Example:
salt '*' user.chgroups foo wheel,root True
-
salt.modules.win_useradd.
chhome
(name, home)¶ Change the home directory of the user
CLI Example:
salt '*' user.chhome foo \\fileserver\home\foo
-
salt.modules.win_useradd.
chprofile
(name, profile)¶ Change the profile directory of the user
CLI Example:
salt '*' user.chprofile foo \\fileserver\profiles\foo
-
salt.modules.win_useradd.
delete
(name, purge=False, force=False)¶ Remove a user from the minion NOTE: purge and force have not been implemented on Windows yet
CLI Example:
salt '*' user.delete name
-
salt.modules.win_useradd.
getent
()¶ Return the list of all info for all users
CLI Example:
salt '*' user.getent
-
salt.modules.win_useradd.
info
(name)¶ Return user information
CLI Example:
salt '*' user.info root
-
salt.modules.win_useradd.
list_groups
(name)¶ Return a list of groups the named user belongs to
CLI Example:
salt '*' user.list_groups foo
-
salt.modules.win_useradd.
list_users
()¶ Return a list of users on Windows
-
salt.modules.win_useradd.
removegroup
(name, group)¶ Remove user from a group
CLI Example:
salt '*' user.removegroup username groupname
-
salt.modules.win_useradd.
setpassword
(name, password)¶ Set a user's password
CLI Example:
salt '*' user.setpassword name password