Resource Type: dsc_xgroup
- Defined in:
- lib/puppet/type/dsc_xgroup.rb
Overview
The DSC xGroup resource type. Automatically generated from version 9.2.1
Properties
-
dsc_description
The description the group should have.
-
dsc_ensure
Indicates if the group should exist or not.
-
dsc_members
The members the group should have. This property will replace all the current group members with the specified members. Members should be specified as strings in the format of their domain qualified name, UPN ,distinguished name or username (for local machine accounts). Using either the MembersToExclude or MembersToInclude properties in the same configuration as this property will generate an error.
-
dsc_memberstoexclude
The members the group should exclude. This property will only remove members from a group. Members should be specified as strings in the format of their domain qualified name, UPN ,distinguished name or username (for local machine accounts). Using the Members property in the same configuration as this property will generate an error.
-
dsc_memberstoinclude
The members the group should include. This property will only add members to a group. Members should be specified as strings in the format of their domain qualified name, UPN ,distinguished name or username (for local machine accounts). Using the Members property in the same configuration as this property will generate an error.
Parameters
-
dsc_credential
A credential to resolve non-local group members.
-
dsc_groupname (namevar)
The name of the group to create, modify, or remove.
-
dsc_psdscrunascredential
-
dsc_timeout
The maximum time in seconds to wait for the DSC resource to complete.
-
name (namevar)
Description of the purpose for this resource declaration.
-
validation_mode
(defaults to: property)
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).