Download full document:

# Get-AcctIdentityPool

Gets existing identity pools.

Syntax

Get-AcctIdentityPool [[-IdentityPoolName] <String>] [-IdentityPoolUid <Guid>] [-Lock <Boolean>] [-ScopeId <Guid>] [-ScopeName <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Provides the ability to locate existing identity pools.

Parameters

Name Description Required? Pipeline Input Default Value
IdentityPoolName The name of the identity pool. false false
IdentityPoolUid The unique identifier for the identity pool. false false
Lock Whether the identity pool is locked or not. false false
ScopeId Gets only results with a scope matching the specified scope identifier. false false
ScopeName Gets only results with a scope matching the specified scope name. false false
ReturnTotalRecordCount See about_Acct_Filtering for details. false false false
MaxRecordCount See about_Acct_Filtering for details. false false 250
Skip See about_Acct_Filtering for details. false false 0
SortBy See about_Acct_Filtering for details. false false
Filter See about_Acct_Filtering for details. false false
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snap-in connects to. You can provide this as a host name or an IP address. false false LocalHost. Once a value is provided by any cmdlet, this value will become the default.

Input Type

Return Values

Citrix.ADIdentity.Sdk.IdentityPool
This object provides details of the identity pool and contains the following information:
IdentityPoolName
The name of the identity pool.
IdentityPoolUid
The unique identifier for the identity pool.
NamingScheme
The naming scheme for the identity pool.
NamingSchemeType
The naming scheme type for the identity pool. This can be one of the following:
Numeric - naming scheme uses numeric indexes
Alphabetic - naming scheme uses alphabetic indexes
StartCount
The next index to be used when creating an identity from the identity pool.
OU
The Active Directory distinguished name for the OU in which accounts created from this identity pool will be created.
Domain
The Active Directory domain that accounts in the pool belong to.
Lock
Indicates if the identity pool is locked.

## Notes In the case of failure, the following errors can result.
Error Codes
-----------
PartialData
Only a subset of the available data was returned.
CouldNotQueryDatabase
The query required to get the database was not defined.
PermissionDenied
The user does not have administrative rights to perform this operation.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error
CommunicationError
An error occurred while communicating with the service.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
InvalidFilter
A filtering expression was supplied that could not be interpreted for this cmdlet.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

Examples

EXAMPLE 1

C:\PS>Get-AcctIdentityPool

IdentityPoolName : MyPool
IdentityPoolUid  : 22072d9e-6a8f-494b-a5bc-2ef18ca4b915
NamingScheme     : Acc####
NamingSchemeType : Numeric
StartCount       : 1
OU               :
Domain           : mydomain.com
Lock             : True

IdentityPoolName : MyPool2
IdentityPoolUid  : 03743136-e43b-4a87-af74-ab71686b3c16
NamingScheme     : Test####
NamingSchemeType : Alphabetic
StartCount       : 1
OU               :
Domain           : mydomain.com
Lock             : False

Description
-----------
Gets all the identity pools.

EXAMPLE 2

C:\PS>Get-AcctIdentityPool -IdentityPoolName M*

IdentityPoolName : MyPool
IdentityPoolUid  : 22072d9e-6a8f-494b-a5bc-2ef18ca4b915
NamingScheme     : Acc####
NamingSchemeType : Numeric
StartCount       : 1
OU               :
Domain           : mydomain.com
Lock             : True

Description
-----------
Gets all the identity pools beginning with the character 'M'.