Resource Type: dsc_xadgroup

Defined in:

lib/puppet/type/dsc_xadgroup.rb

Providers:

powershell

Overview

The DSC xADGroup resource type. Automatically generated from ‘xActiveDirectory/DSCResources/MSFT_xADGroup/MSFT_xADGroup.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_category

  Category - Active Directory group category Valid values are Security, Distribution.

• dsc_credential

  Credential - Credentials used to enact the change upon

• dsc_description

  Description - Description of the Active Directory group

• dsc_displayname

  DisplayName - Display name of the Active Directory group

• dsc_domaincontroller

  DomainController - Active Directory domain controller to enact the change upon

• dsc_ensure

  Ensure - Should this resource be present or absent Valid values are Present, Absent.

• dsc_groupname

  GroupName - Name of the Active Directory group

• dsc_groupscope

  GroupScope - Active Directory group scope Valid values are DomainLocal, Global, Universal.

• dsc_managedby

  ManagedBy - Active Directory managed by attribute specified as a DistinguishedName

• dsc_members

  Members - Active Directory group membership should match membership exactly

• dsc_membershipattribute

  MembershipAttribute - Active Directory attribute used to perform membership operations Valid values are SamAccountName, DistinguishedName, ObjectGUID, SID.

• dsc_memberstoexclude

  MembersToExclude - Active Directory group should NOT include these members

• dsc_memberstoinclude

  MembersToInclude - Active Directory group should include these members

• dsc_notes

  Notes - Active Directory group notes field

• dsc_path

  Path - Location of the group within Active Directory expressed as a Distinguished Name

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_restorefromrecyclebin

  RestoreFromRecycleBin - Indicates whether or not the group object should first tried to be restored from the recycle bin before creating a new group object.

  Supported values:

  • true
  • false
• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xadgroup` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.