DSCResources/MSFT_ADDomainFunctionalLevel/en-US/about_ADDomainFunctionalLevel.help.txt

.NAME
    ADDomainFunctionalLevel
 
.DESCRIPTION
    This resource changes the domain functional level. For further details, see https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/active-directory-functional-levels.
 
    WARNING: This action might be irreversible! Make sure you understand
    the consequences of changing the domain functional level.
 
    Read more about raising function levels and potential roll back
    scenarios in the Active Directory documentation. For example: https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/deploy/upgrade-domain-controllers.
 
    ## Requirements
 
    * Target machine must be running Windows Server 2008 R2 or later.
    * Target machine must be running the minimum required operating system
      version for the domain functional level to set.
 
.PARAMETER DomainIdentity
    Key - String
    Specifies the Active Directory domain to modify. You can identify a domain by its distinguished name, GUID, security identifier, DNS domain name, or NetBIOS domain name.
 
.PARAMETER DomainMode
    Required - String
    Allowed values: Windows2008R2Domain, Windows2012Domain, Windows2012R2Domain, Windows2016Domain
    Specifies the functional level for the Active Directory domain.
 
.EXAMPLE 1
 
This configuration will change the domain functional level to
a Windows Server 2012 R2 Domain.
 
Configuration ADDomainFunctionalLevel_SetLevel_Config
{
    Import-DscResource -ModuleName ActiveDirectoryDsc
 
    node localhost
    {
        ADDomainFunctionalLevel 'ChangeDomainFunctionalLevel'
        {
            DomainIdentity = 'contoso.com'
            DomainMode = 'Windows2012R2Domain'
        }
    }
}