Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Import-AcctIdentityPool

August 3, 2023
Contributed by: 
C

Imports a Identity Pool in the site

Syntax


Import-AcctIdentityPool -IdentityPoolData <String> [-Scope <String[]>] [-ZoneUid <Guid>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Imports a Identity Pool from another site, that has been exported using the Export-IdentityPool

Parameters

Name Description Required? Pipeline Input Default Value
IdentityPoolData The Json encoded data true true (ByPropertyName)  
Scope The administration scopes to be applied to the new identity pool. false false  
ZoneUid The UID that corresponds to the Zone in which these AD accounts will be created. This is only intended to be used for Citrix Cloud Delivery Controllers. false false  
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect 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 becomes the default.

Input Type

Return Values

Citrix.Adidentity.Sdk.Identitypool

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

  • IdentityPoolName &lt;string&gt; The name of the identity pool.

  • IdentityPoolUid &lt;Guid&gt; The unique identifier for the identity pool.

  • NamingScheme &lt;string&gt; The naming scheme for the identity pool.

  • NamingSchemeType &lt;Citrix.XDInterServiceTypes.ADIdentityNamingScheme&gt; 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 &lt;int&gt; The next index to be used when creating an identity from the identity pool.

  • OU &lt;string&gt; The Active Directory distinguished name for the OU in which accounts created from this identity pool will be created.

  • Domain &lt;string&gt; The Active Directory domain that accounts in the pool belong to.

  • Lock &lt;Boolean&gt; Indicates if the identity pool is locked.

Notes

In the case of failure, the following errors can result.

  • 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.

  • 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 


Import-IdentityPool -IdentityPoolData $identityPoolData

<!--NeedCopy-->

Description

Import the identityPool definded in the variable $identityPoolData

Import-AcctIdentityPool
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.