Use the Get-ActiveDirectoryUser cmdlet to retrieve information from the Active Directory directory service about a specified user object.

Get-ActiveDirectoryUser [-SourceIdentity <String>] [-GlobalCatalog <String>] [-MaxThreadCount <UInt32>] [-OrganizationalUnit <String>] [-Quiet <SwitchParameter>] [-SourceCredential <PSCredential>] [-SourceDetail <String>] [-SourceMapping <String>]

Parameters

Parameter Required Type Description

GlobalCatalog

Optional

System.String

The GlobalCatalog parameter specifies a Global Catalog to read user information from.

Supported formats are:

  • Computer NetBios Name [contoso-GC-01]

  • Computer DN

  • Computer IP address

Note: Also used in cross-forest operations to specify a Global Catalog in another forest.

If the parameter is not set, the nearest Global Catalog will be auto-selected.

MaxThreadCount

Optional

System.UInt32

The MaxThreadCount parameter specifies the maximum number of threads allocated to this task.

OrganizationalUnit

Optional

System.String

The OrganizationalUnit parameter is used as a filter so that only user objects in a specific Active Directory organizational unit (OU) will be returned. The following formats are supported:

  • Full DN: OU= Users,DC=cp,DC=com]

  • Abbreviated Name: [Users\Sales] - Based on root of current domain.

  • Abbreviated DN: [OU=Sales,OU=Users] - Based on root of current domain.

Quiet

Optional

System.Management.Automation.SwitchParameter

The Quiet parameter suppresses feedback during task actions.

SourceCredential

Optional

System.Management.Automation.PSCredential

The SourceCredential parameter specifies the Active Directory Domain credentials that will be used to connect to the Global Catalog server.

It is also used in cross-forest operations so that an external account can be used to connect to the Global Catalog server.

Format: PSH credential object consisting of Notes ID file and password.

The credentials of the current logged in user will be used if nothing is specified.

SourceDetail

Optional

System.String

The SourceDetail parameter defines the level of detail retrieved for the application. Levels include:

  • 0 returns basic application information.

  • 1 returns additional information such as forms, fields, and views and matches ACL entries with Active Directory accounts. Identifies mail routing options (@functions and LotusScript).

  • 2 returns additional information such as the code (@functions, LotusScript, etc.) for the application.

SourceIdentity

Optional

System.String

The SourceIdentity parameter identifies the name of the object to be acted upon.

For Domino directory objects, this name should be in one of the following formats:

  • GUID

  • Hierarchical name

  • Canonical name

  • SMTP address

If no identity is specified in the command, all of the objects of the type specified in the task on the server specified will be extracted.

The default parameter value is true.

SourceMapping

Optional

System.String

The SourceMapping parameter specifies a custom mapfile that defines how the attributes in the object schema are mapped from the source schema.

Detailed Description

The Get-ActiveDirectoryUser cmdlet returns detailed information about existing Active Directory user objects.

To run the Get-ActiveDirectoryUser cmdlet, the Notes ID file on the local workstation must have Reader or higher access control list (ACL) access to the Domino Directory. To perform Active Directory user lookups, this cmdlet requires Read access to Active Directory. You must have the Microsoft Exchange Server 2007 administration classes installed on the workstation where you are running the cmdlet.

To run the Get-ActiveDirectoryUser cmdlet, the account you use must be delegated the following:

  • Exchange Recipient Administrator role

  • Account Operator role for applicable Active Directory containers

For related information, see Mail Migration Prerequisites.

Input Types

Return Types

Example

The following code example returns information about users in the Seattle organizational unit (OU) listed in the Domino Directory.

  Copy Code 
Get-ActiveDirectoryUser -DominoOU Seattle