Set-ADForest
Set-ADForest
Modifies an Active Directory forest.
Syntax
Parameter Set: Default
Set-ADForest [-Identity] <ADForest> [-AuthType <ADAuthType> ] [-Credential <PSCredential> ] [-PassThru] [-Server <String> ] [-SPNSuffixes <Hashtable> ] [-UPNSuffixes <Hashtable> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
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 $<localADForestObject>, 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 fabrikam.com -UPNSuffixes @{replace="fabrikam.com","fabrikam","corp.fabrikam.com"}
Method 2: Modify the UPNSuffixes property for the fabrikam.com forest by passing the fabrikam.com forest through the pipeline and specifying the UPNSuffixes parameter.
Get-ADForest -Identity fabrikam.com | Set-ADForest -UPNSuffixes @{replace="fabrikam.com","fabrikam","corp.fabrikam.com"}
Method 3: Modify the UPNSuffixes property for the fabrikam.com forest by using the Windows PowerShell command line to modify a local instance of the fabrikam.com forest. Then set the Instance parameter to the local instance.
$forest = Get-ADForest -Identity fabrikam.com
$forest.UPNSuffixes = "fabrikam.com","fabrikam","corp.fabrikam.com"
Set-ADForest -Instance $forest.
Parameters
-AuthType<ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
Negotiate or 0
Basic or 1
The default authentication method is Negotiate.
A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
The following example shows how to set this parameter to Basic.
-AuthType Basic
Aliases |
none |
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.
To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.
You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials.
$AdminCredentials = Get-Credential "Domain01\User01"
The following shows how to set the Credential parameter to these credentials.
-Credential $AdminCredentials
If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Fully qualified domain name
Example: corp.contoso.com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
DNS host name
Example: dnsServer.corp.contoso.com
NetBIOS name
Example: corp
The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error.
This parameter can also get this object through the pipeline or you can set this parameter to a forest object instance.
This example shows how to set the parameter to a fully qualified domain name.
-Identity "corp.contoso.com"
This example shows how to set this parameter to a forest object instance named "forestInstance".
-Identity $forestInstance
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-PassThru
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Syntax:
To add values:
-SPNSuffixes @{Add=value1,value2,...}
To remove values:
-SPNSuffixes @{Remove=value3,value4,...}
To replace values:
-SPNSuffixes @{Replace=value1,value2,...}
To clear all values:
-SPNSuffixes $null
You can specify more than one change by using a list separated by semicolons. For example, use the following syntax to add and remove SPN suffix values
@{Add=value1,value2,...};@{Remove=value3,value4,...}
The operators will be applied in the following sequence:
..Remove
..Add
..Replace
The following example shows how to add and remove SPNSuffixes for a forest.
-@{Add="ContosoEurope", "ContosoAsia"};@{Remove="Contoso"}
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive.
-By using the domain of the computer running Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Syntax:
To add values:
-UPNSuffixes @{Add=value1,value2,...}
To remove values:
-UPNSuffixes @{Remove=value3,value4,...}
To replace values:
-UPNSuffixes @{Replace=value1,value2,...}
To clear all values:
-UPNSuffixes $null
You can specify more than one change by using a list separated by semicolons. For example, use the following syntax to add and remove UPN suffix values
@{Add=value1,value2,...};@{Remove=value3,value4,...}
The operators will be applied in the following sequence:
..Remove
..Add
..Replace
The following example shows how to add and remove UPN suffixes for a forest.
-UPNSuffixes @{Add="Fabrikam.Com", "Corp.Fabrikam.Com"}; @{Remove="NA.Fabrikam.Com","Europe.Fabrikam.Com"}
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
None or Microsoft.ActiveDirectory.Management.ADForest
A forest object is received by the Identity parameter.
A forest object that was retrieved by using the Get-ADForest cmdlet and then modified is received by the Instance parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
None or Microsoft.ActiveDirectory.Management.ADForest
Returns the modified forest object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.
Notes
This cmdlet does not work with AD LDS.
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Set the UPNSuffixes property on the fabrikam.com forest.
C:\PS>Set-ADForest -Identity fabrikam.com -UPNSuffixes @{replace="fabrikam.com","fabrikam","corp.fabrikam.com"}
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
Add corp.fabrikam.com to the SPNSuffixes property on the forest fabrikam.com
C:\PS>Set-ADForest -Identity fabrikam.com -SPNSuffixes @{add="corp.fabrikam.com"}
-------------------------- EXAMPLE 3 --------------------------
Description
-----------
Get the forest of the current logged on user and update the SPNSuffixes property.
C:\PS>Get-ADForest | Set-ADForest -SPNSuffixes @{Add="corp.fabrikam.com";Remove="fabrikam"}
-------------------------- EXAMPLE 4 --------------------------
Description
-----------
Get the forest of the current logged on user and clear the UPNSuffixes property.
C:\PS>Get-ADForest | Set-ADForest -UPNSuffixes $null