Use the Get-DominoMailbox cmdlet to retrieve information from Domino mail databases documents and associate Domino users with existing Active Directory directory service accounts.

Get-DominoMailbox [-SourceIdentity <String>] [-DomainController <String>] [-DominoDirectoryDatabase <String>] [-DominoDirectoryServer <String>] [-DominoOU <String>] [-MatchToTarget <SwitchParameter>] [-MaxThreadCount <UInt32>] [-NotesIniPath <String>] [-SourceCredential <PSCredential>] [-SourceDetail <String>] [-SourceMapping <String>]
Get-DominoMailbox [-DomainController <String>] [-DominoOU <String>] [-MatchToTarget <SwitchParameter>] [-MaxThreadCount <UInt32>] [-SourceCredential <PSCredential>] [-SourceDetail <String>] [-SourceMapping <String>]

Parameters

Parameter Required Type Description

SourceIdentity

Optional

System.String

Unique name for the Domino Mailbox.

GUID,

User's hierarchical name,

User's canonical name or

User's SMTP address.

DomainController

Optional

System.String

Active Directory domain controller

DominoDirectoryDatabase

Optional

System.String

Domino Directory file name (Typically names.nsf)

DominoDirectoryServer

Optional

System.String

Lotus Domino server hosting Directory that will be used for this process

DominoOU

Optional

System.String

Limits list to user names that match supplied organizational unit (OU) value

MatchToTarget

Optional

System.Management.Automation.SwitchParameter

Exposes match to target Directory functionality

MaxThreadCount

Optional

System.UInt32

Maximum number of threads allocated to this task

NotesIniPath

Optional

System.String

Path to local Notes.INI file including filename

SourceCredential

Optional

System.Management.Automation.PSCredential

PSH credential object consisting of Notes ID file and password.

SourceDetail

Optional

System.String

Level of detail:

Light, Extra, Full.

SourceMapping

Optional

System.String

The SourceMapping parameter allows you to specify a custom mapfile that defines how the attributes in the object schema will be mapped from the source schema.

Detailed Description

The Get-DominoMailbox cmdlet returns detailed information about users' Domino mail databases and matches Domino users with existing Active Directory accounts.

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

To run the Get-DominoMailbox 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

None.

Return Types

MigrationUserItem.

Example

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

  Copy Code
Get-DominoMailbox -DominoOU Seattle