Product Documentation

Get-AcctIdentityPool

Oct 21, 2016

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

-IdentityPoolName<String>

The name of the identity pool.

Required? false
Default Value  
Accept Pipeline Input? false

-IdentityPoolUid<Guid>

The unique identifier for the identity pool.

Required? false
Default Value  
Accept Pipeline Input? false

-Lock<Boolean>

Whether the identity pool is locked or not.

Required? false
Default Value  
Accept Pipeline Input? false

-ScopeId<Guid>

Gets only results with a scope matching the specified scope identifier.

Required? false
Default Value  
Accept Pipeline Input? false

-ScopeName<String>

Gets only results with a scope matching the specified scope name.

Required? false
Default Value  
Accept Pipeline Input? false

-ReturnTotalRecordCount<SwitchParameter>

See about_Acct_Filtering for details.

Required? false
Default Value false
Accept Pipeline Input? false

-MaxRecordCount<Int32>

See about_Acct_Filtering for details.

Required? false
Default Value 250
Accept Pipeline Input? false

-Skip<Int32>

See about_Acct_Filtering for details.

Required? false
Default Value 0
Accept Pipeline Input? false

-SortBy<String>

See about_Acct_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-Filter<String>

See about_Acct_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

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.

Required? false
Default Value LocalHost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Return Values

Citrix.AdIdentity.Sdk.IdentityPool

This object provides details of the identity pool and contains the following information:

IdentityPoolName <string>

The name of the identity pool.

IdentityPoolUid <Guid>

The unique identifier for the identity pool.

NamingScheme <string>

The naming scheme for the identity pool.

NamingSchemeType <Citrix.XDInterServiceTypes.ADIdentityNamingScheme>

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 <int>

The next index to be used when creating an identity from the identity pool.

OU <string>

The Active Directory distinguished name for the OU in which accounts created from this identity pool will be created.

Domain <string>

The Active Directory domain that accounts in the pool belong to.

Lock <Boolean>

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

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

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