Skip to main content

Get-Client

The commandlet Get-Client gets information about the Directory Manager clients such as Admin center, Directory Manager portal(s), management shell, Directory Manager services such as replication service, scheduler service, data service and so on. The information includes client name, client type, and its status whether enabled or disabled.

Syntax​

Get-Client
[[-ClientName] <String>]
[-IdentityStoreId <Int32>]
[-SecurityToken <CustomClaimsPrincipal>]
[-Credential <PSCredential>]
[-WarningAction <ActionPreference>]
[-InformationAction <ActionPreference>]
[-WarningVariable <String>]
[-InformationVariable <String>]
[-PipelineVariable <String>]
[<CommonParameters>]

Required Parameter​

  • None

Example 1:

This example retrieves information about a client Admin Center.

Get-Client –ClientName ‘Admin Center’

Example 2:

This example retrieves information about two clients – ManagementShell <_machine name_> and GroupIDPortal1 – through the pipeline operator.

‘ManagementShell <machine name>’, ‘GroupIDPortal1’ | Get-Client

Example 3:

This example lists all Directory Manager clients available on the Directory Manager machine.

Get-Client