TechNet
Export (0) Print
Expand All

Get-OrganizationalUnit

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-OrganizationalUnit cmdlet to view a list of organizational units (OUs) that exist in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-OrganizationalUnit [-Identity <ExtendedOrganizationalUnitIdParameter>] [-SingleNodeOnly <SwitchParameter>] <COMMON PARAMETERS>

Get-OrganizationalUnit [-SearchText <String>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-DomainController <Fqdn>] [-IncludeContainers <SwitchParameter>] [-ResultSize <Unlimited>]

This example retrieves a list of the first level child OUs beneath the North America OU and formats the output so that only the Name and DistinguishedName properties are displayed.

Get-OrganizationalUnit "North America" -SingleNodeOnly | Format-Table Name, DistinguishedName

For more information about pipelining and the Format-Table cmdlet, see Pipelining and Working with command output.

This example retrieves a list of OUs that match the text string "Executives" and formats the output so that only the Name and DistinguishedName properties are displayed.

Get-OrganizationalUnit -SearchText "Executives" | Format-Table Name, DistinguishedName

For more information about pipelining and the Format-Table cmdlet, see Pipelining and Working with command output.

The Get-OrganizationalUnit cmdlet is used by the Exchange admin center to populate fields that display OU information.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Active Directory Domain Services server settings" entry in the Exchange infrastructure and PowerShell permissions topic.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.ExtendedOrganizationalUnitIdParameter

The Identity parameter specifies the OU or domain that you want to view. You can use any value that uniquely identifies the OU or domain. For example:

  • Name

  • Canonical name

  • Distinguished name (DN)

  • GUID

You can use this parameter with the SearchText parameter.

IncludeContainers

Optional

System.Management.Automation.SwitchParameter

The IncludeContainers switch instructs the command to return containers in the results. You don't need to specify a value with this switch.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

SearchText

Optional

System.String

The SearchText parameter enables you to search the names of all OUs in your organization for the specified string. Only the OUs that match the string you specify are returned. If the string you specify contains spaces, enclose it in quotation marks (").

You can't use this parameter with the Identity parameter.

SingleNodeOnly

Optional

System.Management.Automation.SwitchParameter

The SingleNodeOnly switch instructs the command to return only the first level child OUs beneath the OU specified in the Identity parameter. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show:
© 2016 Microsoft