LocalGroups.adoc

DSC Resource 'LocalGroups'

LocalGroups manages local groups.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/LocalGroups
DSC Resource	xPSDesiredStateConfiguration
Documentation	xGroup

Table 1. Attributes of category 'LocalGroups'

Parameter	Attribute	DataType	Description	Allowed Values
Groups		Hashtable[]	List of local groups.

Table 2. Selected Attributes of category 'LocalGroups/Groups'

Parameter	Attribute	DataType	Description	Allowed Values
GroupName	Key	String	The name of the group to create, modify, or remove.
Ensure		String	Indicates if the group should exist or not.	Absent Present (default)
Description		String	The description the group should have.
Members		String[]	The members the group should have.
MembersToInclude		String[]	The members the group should include.
MembersToExclude		String[]	The members the group should exclude.
Credential		PSCredential	A credential to resolve non-local group members.

Example

LocalGroups:
  Groups:
    - GroupName:   App_123_Read
      Description: App Reader
      MembersToInclude:
        - User01
        - User02
      MembersToExclude:
        - Administrator

Recommended Lookup Options in Datum.yml (Excerpt)

lookup_options:

  LocalGroups:
    merge_hash: deep
  LocalGroups\Groups:
    merge_baseType_array: Unique
    merge_hash_array: DeepTuple
    merge_options:
      tuple_keys:
        - GroupName