Resource Type: dsc_xadforestproperties

Defined in:

lib/puppet/type/dsc_xadforestproperties.rb

Providers:

powershell

Overview

The DSC xADForestProperties resource type. Automatically generated from ‘xActiveDirectory/DSCResources/MSFT_xADForestProperties/MSFT_xADForestProperties.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

Parameters

• dsc_credential

  Credential - Specifies the user account credentials to use to perform this task.

• dsc_forestname

  ForestName - Specifies the target Active Directory forest for the change.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_serviceprincipalnamesuffix

  ServicePrincipalNameSuffix - Specifies the Service Principal Name (SPN) Suffix(es) to be explicitly defined in the forest and replace existing SPNs. Cannot be used with ServicePrincipalNameSuffixToAdd or ServicePrincipalNameSuffixToRemove.

• dsc_serviceprincipalnamesuffixtoadd

  ServicePrincipalNameSuffixToAdd - Specifies the Service Principal Name (SPN) Suffix(es) to be added to the forest. Cannot be used with ServicePrincipalNameSuffix.

• dsc_serviceprincipalnamesuffixtoremove

  ServicePrincipalNameSuffixToRemove - Specifies the Service Principal Name (SPN) Suffix(es) to be removed from the forest. Cannot be used with ServicePrincipalNameSuffix.

• dsc_userprincipalnamesuffix

  UserPrincipalNameSuffix - Specifies the User Principal Name (UPN) Suffix(es) to be explicitly defined in the forest and replace existing UPNs. Cannot be used with UserPrincipalNameSuffixToAdd or UserPrincipalNameSuffixToRemove.

• dsc_userprincipalnamesuffixtoadd

  UserPrincipalNameSuffixToAdd - Specifies the User Principal Name (UPN) Suffix(es) to be added to the forest. Cannot be used with UserPrincipalNameSuffix.

• dsc_userprincipalnamesuffixtoremove

  UserPrincipalNameSuffixToRemove - Specifies the User Principal Name (UPN) Suffix(es) to be removed from the forest. Cannot be used with UserPrincipalNameSuffix.

• name (namevar)
• provider

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