Set-ADOrganizationalUnit
Synopsis
Description
The Identity parameter specifies the Active Directory organizational unit to modify. You can identify an organizational unit 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-ADOrganizationalUnit cmdlet to retrieve an organizational unit object and then pass the object through the pipeline to the Set-ADOrganizationalUnit cmdlet.
The Instance parameter provides a way to update an organizational unit 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 organizational unit object that has been modified, the Set-ADOrganizationalUnit cmdlet makes the same changes to the original organizational unit object. To get a copy of the object to modify, use the Get-ADOrganizationalUnit object. When you specify the Instance parameter you should not pass the Identity parameter. For more information about the Instance parameter, see the Instance parameter description.
The following examples show how to modify the ManagedBy property of an organizational unit object by using three methods:
-By specifying the Identity and the ManagedBy parameters
-By passing an organizational unit object through the pipeline and specifying the ManagedBy parameter
-By specifying the Instance parameter.
Method 1: Modify the ManagedBy property for the “AccountingDepartment” organizational unit by using the Identity and ManagedBy parameters.
Set-ADOrganizationalUnit -Identity “AccountingDepartment” -ManagedBy “RaviSGroup”
Method 2: Modify the ManagedBy property for the “AccountingDepartment” organizational unit by passing the “AccountingDepartment” organizational unit through the pipeline and specifying the ManagedBy parameter.
Get-ADOrganizationalUnit -Identity “”AccountingDepartment”” | Set-ADOrganizationalUnit -ManagedBy “RaviSGroup”
Method 3: Modify the ManagedBy property for the “AccountingDepartment” organizational unit by using the Windows PowerShell command line to modify a local instance of the “AccountingDepartment” organizational unit. Then set the Instance parameter to the local instance.
$organizational unit = Get-ADOrganizationalUnit -Identity “AccountingDepartment”
$organizational unit.ManagedBy = “RaviSGroup”
Set-ADOrganizationalUnit -Instance $organizational unit.
-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
-City <String>
Specifies the user's town or city. This parameter sets the City property of a user. The LDAP display name (ldapDisplayName) of this property is "l".
Required? false
Position? named
Default value
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
-Country <String>
Specifies the country or region code for the user's language of choice. This parameter sets the Country property of a user object. The LDAP Display Name (ldapDisplayName) of this property is "c". This value is not used by Windows 2000.
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 <ADOrganizationalUnit>
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 <ADOrganizationalUnit>
Specifies a modified copy of an organizational unit object to use to update the actual Active Directory organizational unit 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
-ManagedBy <ADPrincipal>
Specifies the user or group that manages the object by providing one of the following property values. Note: The identifier in parentheses is the LDAP display name for the property.
Required? false
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
-PostalCode <String>
Specifies the user's postal code or zip code. This parameter sets the PostalCode property of a user. The LDAP Display Name (ldapDisplayName) of this property is "postalCode".
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
-State <String>
Specifies the user's or Organizational Unit's state or province. This parameter sets the State property of a User or Organizational Unit object. The LDAP display name (ldapDisplayName) of this property is "st".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StreetAddress <String>
Specifies the organizational unit's street address. This parameter sets the StreetAddress property of a organizational unit object. The LDAP display name (ldapDisplayName) of this property is "street".
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-ADOrganizationalUnit [-WhatIf] [-Confirm] [-Add <Hashtable>] [-AuthType <ADAuthType>] [-City <String>] [-Clear <String[]>] [-Country <String>] [-Credential <PSCredential>] [-Description <String>] [-DisplayName <String>] [-Identity] <ADOrganizationalUnit> [-ManagedBy <ADPrincipal>] [-Partition <String>] [-PassThru] [-PostalCode <String>] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>] [-State <String>] [-StreetAddress <String>] [<CommonParameters>]
Set-ADOrganizationalUnit [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] -Instance <ADOrganizationalUnit> [-PassThru] [-Server <String>] [<CommonParameters>]
This cmdlet does not work with an Active Directory Snapshot.
C:\PS>Set-ADOrganizationalUnit -Identity “OU=UserAccounts,DC=TOSSolution,DC=COM” -Description “This Organizational Unit holds all of the users accounts of TOSSolution.COM”
Sets the description of the OrganizationalUnit with distinguishedName OU=UserAccounts,DC=TOSSolution,DC=COM.
C:\PS>Set-ADOrganizationalUnit -Identity “OU=UserAccounts,DC=TOSSolution,DC=COM” -ProtectedFromAccidentalDeletion $false
Sets the ProtectedFromAccidentalDeletion property to $false on the OrganizationalUnit with distinguishedName OU=UserAccounts,DC=TOSSolution,DC=COM.
C:\PS>Set-ADOrganizationalUnit -Identity “OU=AP,OU=Sales,OU=UserAccounts,DC=TOSSolution,DC=COM” -Country “AU” -StreetAddress “45 Martens Place” -City Balmoral -State QLD -PostalCode 4171 -Replace @{co=”Australia”}
Sets the Country, City and State, PostalCode and co properties on the OrganizationalUnit ‘OU=AP,OU=Sales,OU=UserAccounts,DC=TOSSolution,DC=COM’.
C:\PS>$EuropeSalesOU = Get-ADOrganizationalUnit “OU=Europe,OU=Sales,OU=UserAccounts,DC=TOSSolution,DC=COM”
$EuropeSalesOU.Country = “UK”
$EuropeSalesOU.StreetAddress = “22 Station Rd”
$EuropeSalesOU.City = “London”
$EuropeSalesOU.co =”United Kingdom”
Set-ADOrganizationalUnit -Instance $EuropeSalesOU
Creates a new OrganizationalUnit using the OrganizationalUnit ‘OU=Europe,OU=Sales,OU=UserAccounts,DC=TOSSolution,DC=COM’ as a template.
C:\PS>Set-ADOrganizationalUnit -Identity “OU=Managed,DC=AppNC” -Server “TOSSolution-SRV1:60000” -Country “UK”
Set the Country property of the OrganizationalUnit ‘OU=Managed,DC=AppNC’ in an AD LDS instance.
Get-Command Set-ADOrganizationalUnit
. Get-ADOrganizationalUnit
. New-ADOrganizationalUnit
. Remove-ADOrganizationalUnit
