Citrix Virtual Apps and Desktops SDK

Export-AcctIdentityPool

August 3, 2023

Contributed by:

Exports a Identity Pool

Syntax

Export-AcctIdentityPool [-IdentityPoolName] <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Export-AcctIdentityPool -IdentityPoolUid <Guid> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Export an Identity pool and it ADAccounts to JSON encoded string, note that any account that has been created by has not yet been used by MCS will not be exported

Parameters

Name	Description	Required?	Pipeline Input	Default Value
IdentityPoolName	The name of the identity pool.	true	true (ByPropertyName)
IdentityPoolUid	The unique identifier for the identity pool.	true	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

System.String

A JSON encoded version of the identity pool and the ADAccounts that are part of the identity pool

Notes

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

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

Export-AcctIdentityPool -IdentityPoolName MyIdentityPool

<!--NeedCopy-->

Description

Exports the Identity pool MyIdentityPool

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Export-AcctIdentityPool

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Export-AcctIdentityPool

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

System.String

Notes

Examples

Example 1

Description

In this article