salt.modules.pw_user¶
Manage users with the useradd command
-
salt.modules.pw_user.
add
(name, uid=None, gid=None, groups=None, home=None, shell=None, unique=True, fullname='', roomnumber='', workphone='', homephone='', createhome=True, **kwargs)¶ Add a user to the minion
CLI Example:
salt '*' user.add name <uid> <gid> <groups> <home> <shell>
-
salt.modules.pw_user.
chfullname
(name, fullname)¶ Change the user's Full Name
CLI Example:
salt '*' user.chfullname foo "Foo Bar"
-
salt.modules.pw_user.
chgid
(name, gid)¶ Change the default group of the user
CLI Example:
salt '*' user.chgid foo 4376
-
salt.modules.pw_user.
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.pw_user.
chhome
(name, home, persist=False)¶ Change the home directory of the user, pass true for persist to copy files to the new home dir
CLI Example:
salt '*' user.chhome foo /home/users/foo True
-
salt.modules.pw_user.
chhomephone
(name, homephone)¶ Change the user's Home Phone
CLI Example:
salt '*' user.chhomephone foo "7735551234"
-
salt.modules.pw_user.
chroomnumber
(name, roomnumber)¶ Change the user's Room Number
CLI Example:
salt '*' user.chroomnumber foo 123
-
salt.modules.pw_user.
chshell
(name, shell)¶ Change the default shell of the user
CLI Example:
salt '*' user.chshell foo /bin/zsh
-
salt.modules.pw_user.
chuid
(name, uid)¶ Change the uid for a named user
CLI Example:
salt '*' user.chuid foo 4376
-
salt.modules.pw_user.
chworkphone
(name, workphone)¶ Change the user's Work Phone
CLI Example:
salt '*' user.chworkphone foo "7735550123"
-
salt.modules.pw_user.
delete
(name, remove=False, force=False)¶ Remove a user from the minion
CLI Example:
salt '*' user.delete name remove=True force=True
-
salt.modules.pw_user.
getent
()¶ Return the list of all info for all users
CLI Example:
salt '*' user.getent
-
salt.modules.pw_user.
info
(name)¶ Return user information
CLI Example:
salt '*' user.info root
-
salt.modules.pw_user.
list_groups
(name)¶ Return a list of groups the named user belongs to
CLI Example:
salt '*' user.list_groups foo