Use the Get-DominoGroup cmdlet to retrieve group information from Domino directory database documents and associate Domino users with existing Active Directory groups.

Get-DominoGroup [-SourceIdentity <String>] [-DominoDirectoryDatabase <String>] [-DominoDirectoryServer <String>] [-GlobalCatalog <String>] [-GroupType <String>] [-MatchToTarget <SwitchParameter>] [-MaxThreadCount <UInt32>] [-NotesIniPath <String>] [-Quiet <SwitchParameter>] [-SourceCredential <PSCredential>]

Parameters

Parameter

Required

Type

Description

DominoDirectoryDatabase

Optional

System.String

The DominoDirectoryDatabase parameter specifies the name of the database from which directory information should be extracted.

The default format is the Domino Directory file name (Typically names.nsf)

The default parameter value is false.

DominoDirectoryServer

Optional

System.String

The DominoDirectoryServer parameter specifies the name of the Domino server hosting the directory that the task will be connecting to. This name should be in one of the following formats:

  • IP Address

  • Host name (NetBIOS)

  • Domino Hierarchical name, ex. DF-Contoso-01/Example1

The default parameter value is false.

GlobalCatalog

Optional

System.String

The GlobalCatalog parameter identifies the Active Directory server.

GroupType

Optional

System.String

The GroupType parameter specifies the type of group to be extracted from Domino. Possible choices are ALL, DISTRIBUTION, HYBRID, and SECURITY.

The default behavior is ALL.

The default parameter value is false.

MatchToTarget

Optional

System.Management.Automation.SwitchParameter

The MatchToTarget parameter exposes match to target directory functionality.

The default parameter value is false.

MaxThreadCount

Optional

System.UInt32

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

NotesIniPath

Optional

System.String

The NotesIniPath parameter specifies the path to the local Notes.INI file including filename.

If a value is not supplied, the notes.ini that is in the install directory will be used.

The default parameter value is false.

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 PSH credential object consisting of the Notes ID file and password.

The default parameter value is false.

SourceIdentity

Optional

System.String

The SourceIdentity parameter is 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.

Detailed Description

The Get-DominoGroup cmdlet returns detailed information about users' Domino groups and matches Domino groups with existing Active Directory groups.

To run the Get-DominoGroup 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 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 are running the cmdlet.

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

Directory.group

Example

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

  Copy Code 
Get-DominoGroup -DominoOU Seattle