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.
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
Add a user to a group
Parameters: | |
---|---|
Returns: |
|
Return type: |
CLI Example:
salt '*' group.adduser foo username
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
Remove a user from a group
Parameters: | |
---|---|
Returns: |
|
Return type: |
CLI Example:
salt '*' group.deluser foo username
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
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
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
Ensure a group contains only the members in the list
Parameters: | |
---|---|
Returns: |
|
Return type: |
CLI Example:
salt '*' group.members foo 'user1,user2,user3'
© 2019 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.win_groupadd.html