Set-ADForest

Set-ADForest is accessible with the help of addsadministration module. To install addsadministration on your system please refer to this link.

Modifies an Active Directory forest.

The Set-ADForest cmdlet modifies the properties of an Active Directory forest. You can modify commonly used property values by using the cmdlet parameters. Property values that are not associated with cmdlet parameters can be modified by using the Add, Replace, Clear and Remove parameters.

The Identity parameter specifies the Active Directory forest to modify. You can identify a forest by its fully qualified domain name (FQDN), GUID, DNS host name, or NetBIOS name. You can also set the Identity parameter to an object variable such as $, or you can pass an object through the pipeline to the Identity parameter. For example, you can use the Get-ADForest cmdlet to retrieve a forest object and then pass the object through the pipeline to the Set-ADForest cmdlet.

The Instance parameter provides a way to update a forest object by applying the changes made to a copy of the object. When you set the Instance parameter to a copy of an Active Directory forest object that has been modified, the Set-ADForest cmdlet makes the same changes to the original forest object. To get a copy of the object to modify, use the Get-ADForest object. The Identity parameter is not allowed when you use the Instance parameter. For more information about the Instance parameter, see the Instance parameter description.

The following examples show how to modify the UPNSuffixes property of a forest object by using three methods:

-By specifying the Identity and the UPNSuffixes parameters
-By passing a forest object through the pipeline and specifying the UPNSuffixes parameter
-By specifying the Instance parameter.

Method 1: Modify the UPNSuffixes property for the fabrikam.com forest by using the Identity and UPNSuffixes parameters.
Set-ADForest -Identity TOSSolution.com -UPNSuffixes @{replace=”TOSSolution.com”,”TOSSolution”,”Delhi.TOSSolution.com”}

Method 2: Modify the UPNSuffixes property for the TOSSolution.com forest by passing the TOSSolution.com forest through the pipeline and specifying the UPNSuffixes parameter.
Get-ADForest -Identity TOSSolution.com | Set-ADForest -UPNSuffixes @{replace=”TOSSolution.com”,”TOSSolution”,”Delhi.TOSSolution.com”}

Method 3: Modify the UPNSuffixes property for the TOSSolution.com forest by using the Windows PowerShell command line to modify a local instance of the TOSSolution.com forest. Then set the Instance parameter to the local instance.
$forest = Get-ADForest -Identity TOSSolution.com
$forest.UPNSuffixes = “TOSSolution.com”,”TOSSolution”,”Delhi.TOSSolution.com”
Set-ADForest -Instance $forest.

-AuthType 
         Specifies the authentication method to use. Possible values for this parameter include:

    Required?                    false
    Position?                    named
    Default value                Microsoft.ActiveDirectory.Management.AuthType.Negotiate
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Credential <PSCredential>
    Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Identity <ADForest>
    Specifies an Active Directory forest object by providing one of the following attribute values. The identifier in parentheses is the LDAP display name for the attribute.

    Required?                    true
    Position?                    1
    Default value                
    Accept pipeline input?       True (ByValue)
    Accept wildcard characters?  false

-PassThru <SwitchParameter>
    Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not generate any output.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-SPNSuffixes <Hashtable>
    Modifies the list of service principal name (SPN) suffixes of the forest. This parameter sets the multi-valued msDS-SPNSuffixes property of the cross-reference container. This parameter uses the following syntax to add remove, replace, or clear SPN suffix values.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Server <String>
    Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following:  Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-UPNSuffixes <Hashtable>
    Modifies the list of user principal name (UPN) suffixes of the forest. This parameter sets the multi-valued msDS-UPNSuffixes property of the cross-reference container. This parameter uses the following syntax to add remove, replace, or clear UPN suffix values.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WhatIf <SwitchParameter>
    Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

Set-ADForest [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] [-Identity] <ADForest> [-PassThru] [-Server <String>] [-SPNSuffixes <Hashtable>] [-UPNSuffixes <Hashtable>] [<CommonParameters>]

Notes
This cmdlet does not work with AD LDS.

————————– EXAMPLE 1 ————————–
C:\PS>Set-ADForest -Identity TOSSolution.com -UPNSuffixes @{replace=”TOSSolution.com”,”TOSSolution”,”Delhi.TOSSolution.com”}
Set the UPNSuffixes property on the TOSSolution.com forest.

————————– EXAMPLE 2 ————————–
C:\PS>Set-ADForest -Identity TOSSolution.com -SPNSuffixes @{add=”Delhi.TOSSolution.com”}
Add Delhi.TOSSolution.com to the SPNSuffixes property on the forest TOSSolution.com

————————– EXAMPLE 3 ————————–
C:\PS>Get-ADForest | Set-ADForest -SPNSuffixes @{Add=”Delhi.TOSSolution.com”;Remove=”TOSSolution”}
Get the forest of the current logged on user and update the SPNSuffixes property.

————————– EXAMPLE 4 ————————–
C:\PS>Get-ADForest | Set-ADForest -UPNSuffixes $null
Get the forest of the current logged on user and clear the UPNSuffixes property.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

You can also read about
. Get-ADForest
. Set-ADForestMode

To know more PowerShell cmdlets(Commands) on addsadministration (Active Directory) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft