salt.modules.mac_user¶
Manage users on Mac OS 10.7+
-
salt.modules.mac_user.
add
(name, uid=None, gid=None, groups=None, home=None, shell=None, fullname=None, createhome=True, **kwargs)¶ Add a user to the minion
CLI Example:
salt '*' user.add name <uid> <gid> <groups> <home> <shell>
-
salt.modules.mac_user.
chfullname
(name, fullname)¶ Change the user's Full Name
CLI Example:
salt '*' user.chfullname foo 'Foo Bar'
-
salt.modules.mac_user.
chgid
(name, gid)¶ Change the default group of the user
CLI Example:
salt '*' user.chgid foo 4376
-
salt.modules.mac_user.
chgroups
(name, groups, append=False)¶ Change the groups to which the user belongs. Note that the user's primary group does not have to be one of the groups passed, membership in the user's primary group is automatically assumed.
- groups
- Groups to which the user should belong, can be passed either as a python list or a comma-separated string
- append
- Instead of removing user from groups not included in the
groups
parameter, just add user to any groups for which they are not members
CLI Example:
salt '*' user.chgroups foo wheel,root
-
salt.modules.mac_user.
chhome
(name, home)¶ Change the home directory of the user
CLI Example:
salt '*' user.chhome foo /Users/foo
-
salt.modules.mac_user.
chshell
(name, shell)¶ Change the default shell of the user
CLI Example:
salt '*' user.chshell foo /bin/zsh
-
salt.modules.mac_user.
chuid
(name, uid)¶ Change the uid for a named user
CLI Example:
salt '*' user.chuid foo 4376
-
salt.modules.mac_user.
delete
(name, *args)¶ Remove a user from the minion
CLI Example:
salt '*' user.delete foo
-
salt.modules.mac_user.
getent
()¶ Return the list of all info for all users
CLI Example:
salt '*' user.getent
-
salt.modules.mac_user.
info
(name)¶ Return user information
CLI Example:
salt '*' user.info root
-
salt.modules.mac_user.
list_groups
(name)¶ Return a list of groups the named user belongs to
CLI Example:
salt '*' user.list_groups foo
-
salt.modules.mac_user.
list_users
()¶ Return a list of all users
CLI Example:
salt '*' user.list_users