Resource Type: dsc_adgroup
- Defined in:
- lib/puppet/type/dsc_adgroup.rb
Overview
The DSC ADGroup resource type. Automatically generated from version 6.4.0
Properties
-
dsc_category
Active Directory group category. Default value is ‘Security’.
-
dsc_description
Description of the Active Directory group.
-
dsc_displayname
Display name of the Active Directory group.
-
dsc_distinguishedname
Returns the distinguished name of the Active Directory group.
-
dsc_domaincontroller
Active Directory domain controller to enact the change upon.
-
dsc_ensure
Specifies if this Active Directory group should be present or absent. Default value is ‘Present’.
-
dsc_groupscope
Active Directory group scope. Default value is ‘Global’.
-
dsc_managedby
Active Directory managed by attribute specified as a DistinguishedName.
-
dsc_members
Active Directory group membership should match membership exactly.
-
dsc_membershipattribute
Active Directory attribute used to perform membership operations. Default value is ‘SamAccountName’.
-
dsc_memberstoexclude
Active Directory group should NOT include these members.
-
dsc_memberstoinclude
Active Directory group should include these members.
-
dsc_notes
Active Directory group notes field.
-
dsc_path
Location of the group within Active Directory expressed as a Distinguished Name.
-
dsc_restorefromrecyclebin
Try to restore the group from the recycle bin before creating a new one.
Parameters
-
dsc_credential
The credential to be used to perform the operation on Active Directory.
-
dsc_groupname (namevar)
Name of the Active Directory group.
-
dsc_psdscrunascredential
-
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).