Set-AdmOrganizationalUnit

Modifies an organizational unit.

Description

The Set-AdmOrganizationalUnit cmdlet modifies the properties of an organizational unit (OU). 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 , Remove , Replace , and Clear parameters.

The Identity parameter specifies the OU to modify. You can identify an OU by its distinguished name (DN) or GUID. You can also set the Identity parameter to an object variable such as $<localADOrganizationalUnitObject>, or you can pass an object through the pipeline to the Identity parameter. For example, you can use the Get-AdmOrganizationalUnit cmdlet to retrieve an OU object and then pass the object through the pipeline to the Set-AdmOrganizationalUnit 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 organizational unit object that was modified, the Set-AdmOrganizationalUnit cmdlet makes the same changes to the original OU. To get a copy of the object to modify, use the Get-AdmOrganizationalUnit object. The Identity parameter is not allowed when you use the Instance parameter.

Examples

Example 1 – Set a description for an organizational unit

Set-AdmOrganizationalUnit -Identity "OU=UserAccounts,DC=FABRIKAM,DC=COM" -Description "This organizational unit holds all of the users accounts of FABRIKAM.COM"

This command sets description for the OU with distinguished name OU=UserAccounts,DC=FABRIKAM,DC=COM.

Example 2 – Set location properties for an organizational unit

Set-AdmOrganizationalUnit -Identity "OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM" -Country "AU" -StreetAddress "45 Martens Place" -City Balmoral -State QLD -PostalCode 4171 -Replace @{co="Australia"}

This command sets the Country, StreetAddress, City, State, PostalCode, and Country Name properties on the OU with distinguished name OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM.

Example 3 – Set organizational unit properties using the Instance parameter

$EuropeSalesOU = Get-AdmOrganizationalUnit "OU=Europe,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM"
$EuropeSalesOU.Country = "UK"
$EuropeSalesOU.StreetAddress = "22 Station Rd"
$EuropeSalesOU.City = "QUARRINGTON"
$EuropeSalesOU.PostalCode = "NG34 0NI"
$EuropeSalesOU.co ="United Kingdom"
Set-AdmOrganizationalUnit -Instance $EuropeSalesOU

This command sets properties of the organizational unit with distinguished name OU=Europe,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM using the Instance parameter.

Parameters

-AdaxesService

Specifies the DNS name of an Adaxes service that will be used to execute this cmdlet. If this parameter is not specified, and the cmdlet is running from an Adaxes Active Directory provider drive, the value for this parameter can be determined from the current path. For example, if the current path is Adaxes:/example.com, the Adaxes service on example.com will be used. If the parameter is not specified and the service DNS name can't be determined from the current path, the cmdlet will access Active Directory directly. To perform an operation in a Microsoft Entra managed domain, you must specify this parameter.

-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, use its schema 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 the parameter is:

-Add @{Attribute1Name=value1, value2, ...; Attribute2Name=value1, value2, ...; AttributeXName=value1, value2, ...}

When you use the Add, Remove, Replace, and Clear parameters together, the operations will be performed in the following order:

• Remove
• Add
• Replace
• Clear

-City

Specifies the town or city of the organizational unit. This parameter sets the City property of the OU. The schema name of the property is l.

-Clear

Specifies an array of object properties that will be cleared. 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, use its schema name. You can modify more than one property by specifying a comma-separated list. The format for this parameter is:

-Clear @(Attribute1Name, Attribute2Name)

When you use the Add, Remove, Replace, and Clear parameters together, the operations will be performed in the following order:

• Remove
• Add
• Replace
• Clear

-Confirm

Prompts you for confirmation before executing the command.

-Country

Specifies the country or region code. This parameter sets the Country property of the OU. The schema name of the property is c.

-Credential

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 Adaxes Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default one.

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.

If the acting credentials do not have permission to perform the task, the cmdlet returns a terminating error.

-Description

Specifies a description of the object. This parameter sets the Description property of the object. The schema name of the property is description.

-DisplayName

Specifies the display name of the object. This parameter sets the DisplayName property of the object. The schema name of the property is displayName.

-Identity

Specifies an organizational unit by providing one of the following property values. The identifier in parentheses is the schema name of the attribute.

Possible values for this parameter are:

• Distinguished name (distinguishedName)
• GUID (objectGUID)

The cmdlet searches the default naming context or partition to find the object. This parameter can also get this object through the pipeline or you can set this parameter to an object instance.

-Instance

Specifies a modified copy of an organizational unit object to use to update the actual OU object. When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding directory object. The cmdlet only updates the object properties that changed.

The Instance parameter can only update organizational unit objects that were retrieved by using the Get-AdmOrganizationalUnit cmdlet. When you specify the Instance parameter, you cannot specify other parameters that set properties on the object.

-ManagedBy

Specifies the user or group that manages the object by providing one of the following property values. The identifier in parentheses is the schema name of the property.

Possible values for this parameter are:

• Distinguished name (distinguishedName)
• GUID (objectGUID)
• Security identifier (objectSid)
• SAM Account Name (sAMAccountName)

Derived types, such as the following are also accepted:

• Softerra.Adaxes.PowerShellModule.Directory.ADGroup
• Softerra.Adaxes.PowerShellModule.Directory.ADUser
• Softerra.Adaxes.PowerShellModule.Directory.ADComputer
• Softerra.Adaxes.PowerShellModule.Directory.ADOrganizationalUnit

-ManagedByList

Specifies a hashtable of users or groups that should be added or removed from the list of organizational unit owners. The parameter value should be a hashtable with Add or Remove as a key and a comma-separated list of any of the following object identifiers as its value.

• Distinguished name (distinguishedName)
• GUID (objectGUID)
• Security identifier (objectSid)
• SAM Account Name (sAMAccountName)

You can use any combination of the above identifiers in the hashtable to add or remove multiple owners. However, you cannot add and remove owners at the same time – to do this, you need to execute the cmdlet twice. For example:

# Adding owners
$owners = @{
    "Add" = 
        "CN=John Smith,CN=Users,DC=example,DC=com",
        "{75444639-7DAF-460F-AFAF-04CE891A4AF0}",
        "S-1-5-21-318736562-1752376529-4243903518-874036"
}
Set-AdmOrganizationalUnit -Identity "OU=UserAccounts,DC=FABRIKAM,DC=COM" `
    -ManagedByList $owners -AdaxesService localhost

# Removing owners
$owners = @{
    "Remove" = 
        "CN=John Smith,CN=Users,DC=example,DC=com",
        "{75444639-7DAF-460F-AFAF-04CE891A4AF0}",
        "S-1-5-21-318736562-1752376529-4243903518-874036"
}
Set-AdmOrganizationalUnit -Identity "OU=UserAccounts,DC=FABRIKAM,DC=COM" `
    -ManagedByList $owners -AdaxesService localhost

For more details on how object ownership works in Adaxes, see Object owners. If you specify this parameter, the AdaxesService parameter becomes required.

-Partition

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.

In many cases, a default value will be used for the Partition parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first, and once a default value can be determined, no further rules will be evaluated.

• If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name.
• If running cmdlets from an Adaxes Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive.
• If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-PostalCode

Specifies the postal code or zip code. This parameter sets the PostalCode property of the OU. The schema name of the property is postalCode.

-ProtectedFromAccidentalDeletion

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 are:

• $false or 0
• $true or 1

-Remove

Specifies that the cmdlet removes 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, use its schema name. You can set multiple values for 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:

-Remove @{Attribute1Name=value1, value2, ...; Attribute2Name=value1, value2, ...; AttributeXName=value1, value2, ...}

When you use the Add, Remove, Replace, and Clear parameters together, the parameters will be applied in the following sequence:

• Remove
• Add
• Replace
• Clear

-Replace

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, use its schema name. You can set multiple values for 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:

-Replace @{Attribute1Name=value1, value2, ...; Attribute2Name=value1, value2, ...; AttributeXName=value1, value2, ...}

When you use the Add, Remove, Replace, and Clear parameters together, the parameters will be applied in the following sequence:

• Remove
• Add
• Replace
• Clear

-Server

Specifies the directory to connect to by providing one of the following values for a corresponding domain name or directory server. Specify the AD DS instance or the Microsoft Entra domain name in one of the following ways:

Domain name values:

• Fully qualified domain name
• NetBIOS name

Directory server values:

• Fully qualified directory server name
• NetBIOS name
• Fully qualified directory server name and port

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 Adaxes Active Directory PowerShell provider drive, when running under that drive.
• By using the domain of the computer running PowerShell.

-State

Specifies the state or province. This parameter sets the State property of the organizational unit. The schema name of the property is st.

-StreetAddress

Specifies the street address. This parameter sets the StreetAddress property of an organizational unit. The schema name of the property is streetAddress.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Inputs

Softerra.Adaxes.PowerShellModule.Directory.ADOrganizationalUnit

An organizational unit object is received by the Identity parameter.

An organizational unit that was retrieved and then modified is received by the Instance parameter.

Outputs

None or Softerra.Adaxes.PowerShellModule.Directory.ADOrganizationalUnit

Returns the modified organizational unit object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

See also

• Get-AdmOrganizationalUnit
• New-AdmOrganizationalUnit
• Remove-AdmOrganizationalUnit