Set-ADObject
Synopsis
Description
The Identity parameter specifies the Active Directory object to modify. You can identify an object by its distinguished name (DN) or GUID. 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-ADObject cmdlet to retrieve an object and then pass the object through the pipeline to the Set-ADObject cmdlet.
The Instance parameter provides a way to update an 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 object that has been modified, the Set-ADObject cmdlet makes the same changes to the original object. To get a copy of the object to modify, use the Get-ADObject 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. For more information about how the Instance concept is used in Active Directory cmdlets, see about_ActiveDirectory_Instance.
-By specifying the Identity and the DisplayName parameters
-By passing an object through the pipeline and specifying the DisplayName parameter
-By specifying the Instance parameter.
Method 1: Modify the DisplayName property for the SecurityL2AccessGroup object by using the Identity and DisplayName parameters.
Set-ADObject -Identity “SecurityL2AccessGroup” -DisplayName “Security Level 2”
Method 2: Modify the DisplayName property for the SecurityL2AccessGroup object by passing the SecurityL2AccessGroup object through the pipeline and specifying the DisplayName parameter.
Get-ADObject -Identity “SecurityLevel2AccessGroup” | Set-ADObject -DisplayName “Security Level 2”
Method 3: Modify the DisplayName property for the SecurityL2AccessGroup object by using the Windows PowerShell command line to modify a local instance of the SecurityL2AccessGroup object. Then set the Instance parameter to the local instance.
$adobject = Get-ADObject -Identity “SecurityL2AccessGroup”
$adobject.DisplayName = “Security Level 2”
Set-ADObject -Instance $adobject.
-The cmdlet is run from an Active Directory provider drive.
-A default naming context or partition is defined for the AD LDS environment. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance.
Parameters
-Add
Specifies values to add to an object property. Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name. You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. The format for this parameter is
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthType <ADAuthType>
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
-Clear <String[]>
Specifies an array of object properties that will be cleared in the directory. Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name. You can modify more than one property by specifying a comma-separated list. The format for this parameter is
Required? false
Position? named
Default value
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
-Description <String>
Specifies a description of the object. This parameter sets the value of the Description property for the object. The LDAP Display Name (ldapDisplayName) for this property is "description".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DisplayName <String>
Specifies the display name of the object. This parameter sets the DisplayName property of the object. The LDAP Display Name (ldapDisplayName) for this property is "displayName".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADObject>
Specifies an Active Directory object by providing one of the following property 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
-Instance <ADObject>
Specifies a modified copy of an Active Directory object to use to update the actual Active Directory object. When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding Active Directory object. The cmdlet only updates the object properties that have changed.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Partition <String>
Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. The cmdlet searches this partition to find the object defined by the Identity parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
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
-ProtectedFromAccidentalDeletion <Boolean>
Specifies whether to prevent the object from being deleted. When this property is set to true, you cannot delete the corresponding object without changing the value of the property. Possible values for this parameter include:
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Remove <Hashtable>
Specifies that the cmdlet remove values of an object property. Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. To remove an object property, you must use the LDAP display name. You can remove more than one property by specifying a semicolon-separated list. The format for this parameter is
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Replace <Hashtable>
Specifies values for an object property that will replace the current values. Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name. You can modify more than one property by specifying a comma-separated list. The format for this parameter is
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
-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? falseSyntax
Set-ADObject [-WhatIf] [-Confirm] [-Add <Hashtable>] [-AuthType <ADAuthType>] [-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-DisplayName <String>] [-Identity] <ADObject> [-Partition <String>] [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>] [<CommonParameters>]
Set-ADObject [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] -Instance <ADObject> [-PassThru] [-Server <String>] [<CommonParameters>]
This cmdlet does not work with an Active Directory Snapshot.
C:\PS>Set-ADObject ‘CN=AntonioAl Direct Reports,OU=Finance,OU=UserAccounts,DC=TOSSolution,DC=COM’ -Description ‘Distribution List of Antonio Alwan Direct Reports’
Set the Description property on the object with DistinguishedName ‘CN=AntonioAl Direct Reports,OU=Finance,OU=UserAccounts,DC=TOSSolution,DC=COM’.
C:\PS>Set-ADObject ‘CN=DEFAULTIPSITELINK,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=TOSSolution,DC=COM’ -Add @{siteList=’CN=BO3,CN=Sites,CN=Configuration,DC=TOSSolution,DC=COM’} -Partition ‘CN=Configuration,DC=TOSSolution,DC=COM’
Add the site ‘CN=BO3,CN=Sites,CN=Configuration,DC=TOSSolution,DC=COM’ to the property siteList on the object with DistinguishedName ‘CN=DEFAULTIPSITELINK,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=TOSSolution,DC=COM’.
C:\PS>$urlValues = @()
$urlValues += “www. TOSSolution .com”
$urlValues += “www.INSC.com”
Set-ADObject “desch2e3-d3a8-4fd1-9d30-5cf72d94a056” -Add @{url=$urlValues}
Add two new urls to the property urlValues in the object with objectGuid ‘desch2e3-d3a8-4fd1-9d30-5cf72d94a056’.
C:\PS>$urlValues = @()
$urlValues += “www.TOSSolution.com”
$urlValues += “www.INSC.com”
Set-ADObject “desch2e3-d3a8-4fd1-9d30-5cf72d94a056″ -Replace @{url=$urlValues;description=”Ramesh Arvind”}
Replaces the old values of the multi-valued attribute ‘url’ with the new values and sets the value of the attribute ‘description’.
C:\PS>Set-ADObject “desch2e3-d3a8-4fd1-9d30-5cf72d94a056″ -Remove @{url=”www.INSC.com”} -Replace @{description=”Antonio Alwan (European Manager)”}
Removes the specified value from the attribute ‘url’ and sets the value of the attribute ‘description’.
C:\PS>$myComp = Get-ADObject -identity “desch2e3-d3a8-4fd1-9d30-5cf72d94a056” -Properties “userAccountControl”,”description”
Now set the new account control using powershell bitwise OR operation (-bor) and set description
$myComp.userAccountControl = $myComp.userAccountControl -bor 50
$myComp.description = “Setting a new UAC on the object”
Save the changes
Set-ADObject -Instance $myComp
Sets a new UAC bit on an object by updating the attribute ‘userAccountControl’ and setting the value of the attribute ‘description’.
C:\PS>set-adobject “CN=InternalApps,DC=AppNC” -protectedFromAccidentalDeletion $true -server “TOSSolution-SRV1:60000”
Sets container “CN=InternalApps,DC=AppNC” in an LDS instance to be protected from accidental deletion
Get-Command Set-ADObject
. Get-ADObject
. New-ADObject
. Remove-ADObject
