salt.modules.win_groupadd

Manage groups on Windows

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.win_groupadd.add(name, **kwargs)

Add the specified group

Parameters: name (str) -- The name of the group to add
Returns: True if successful, otherwise False
Return type: bool

CLI Example:

salt '*' group.add foo

salt.modules.win_groupadd.adduser(name, username, **kwargs)

Add a user to a group

Parameters

name (str) -- The name of the group to modify
username (str) -- The name of the user to add to the group

Returns

True if successful, otherwise False

Return type

bool

CLI Example:

salt '*' group.adduser foo username

salt.modules.win_groupadd.delete(name, **kwargs)

Remove the named group

Parameters: name (str) -- The name of the group to remove
Returns: True if successful, otherwise False
Return type: bool

CLI Example:

salt '*' group.delete foo

salt.modules.win_groupadd.deluser(name, username, **kwargs)

Remove a user from a group

Parameters

name (str) -- The name of the group to modify
username (str) -- The name of the user to remove from the group

Returns

True if successful, otherwise False

Return type

bool

CLI Example:

salt '*' group.deluser foo username

salt.modules.win_groupadd.getent(refresh=False)

Return info on all groups

Parameters: refresh (bool) -- Refresh the info for all groups in __context__. If False only the groups in __context__ will be returned. If True the __context__ will be refreshed with current data and returned. Default is False
Returns: A list of groups and their information

CLI Example:

salt '*' group.getent

salt.modules.win_groupadd.info(name)

Return information about a group

Parameters: name (str) -- The name of the group for which to get information
Returns: A dictionary of information about the group
Return type: dict

CLI Example:

salt '*' group.info foo

salt.modules.win_groupadd.list_groups(refresh=False)

Return a list of groups

Parameters: refresh (bool) -- Refresh the info for all groups in __context__. If False only the groups in __context__ will be returned. If True, the __context__ will be refreshed with current data and returned. Default is False
Returns: A list of groups on the machine
Return type: list

CLI Example:

salt '*' group.list_groups

salt.modules.win_groupadd.members(name, members_list, **kwargs)

Ensure a group contains only the members in the list

Parameters

name (str) -- The name of the group to modify
members_list (str) -- A single user or a comma separated list of users. The group will contain only the users specified in this list.

Returns

True if successful, otherwise False

Return type

bool

CLI Example:

salt '*' group.members foo 'user1,user2,user3'

Generated on August 05, 2021 at 04:04:00 UTC.

You are viewing docs for the previous stable release, 3000.9. Switch to docs for the latest stable release, 3003.1, or to a recent doc build from the master branch.

saltstack.com