salt.modules.groupadd¶
Manage groups on Linux, OpenBSD and NetBSD
Important
If you feel that Salt should be using this module to manage groups on a minion, and it is using a different module (or gives an error similar to 'group.info' is not available), see here.
-
salt.modules.groupadd.add(name, gid=None, system=False)¶ Add the specified group
CLI Example:
salt '*' group.add foo 3456
-
salt.modules.groupadd.adduser(name, username)¶ Add a user in the group.
CLI Example:
salt '*' group.adduser foo barVerifies if a valid username 'bar' as a member of an existing group 'foo', if not then adds it.
-
salt.modules.groupadd.chgid(name, gid)¶ Change the gid for a named group
CLI Example:
salt '*' group.chgid foo 4376
-
salt.modules.groupadd.delete(name)¶ Remove the named group
CLI Example:
salt '*' group.delete foo
-
salt.modules.groupadd.deluser(name, username)¶ Remove a user from the group.
CLI Example:
salt '*' group.deluser foo barRemoves a member user 'bar' from a group 'foo'. If group is not present then returns True.
-
salt.modules.groupadd.getent(refresh=False)¶ Return info on all groups
CLI Example:
salt '*' group.getent
-
salt.modules.groupadd.info(name)¶ Return information about a group
CLI Example:
salt '*' group.info foo
-
salt.modules.groupadd.members(name, members_list)¶ Replaces members of the group with a provided list.
CLI Example:
salt '*' group.members foo 'user1,user2,user3,...'- Replaces a membership list for a local group 'foo'.
- foo:x:1234:user1,user2,user3,...
