Export-AcctIdentityPool

Last published : Oct 31, 2026
Exports an identity pool.
Related information
about_AcctADIdentitySnapIn

Syntax

Export-AcctIdentityPool
      -IdentityPoolUid <Guid>
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
Export-AcctIdentityPool
      [-IdentityPoolName] <String>
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]

Description

Provides the ability to export an identity pool and contained AD accounts to a JSON encoded string. Any accounts that have not yet been used by MCS will not be exported. Service accounts cannot be exported. If you are using a service account to manage administrator credentials, you will need to reconfigure the service account after importing the identity pool

Examples

EXAMPLE 1

Exports the identity pool named "MyPool". This pool contains accounts that have not been used yet, so they are not exported.
Export-AcctIdentityPool -IdentityPoolName MyPool

{"IdentityPoolName":"MyPool","NamingScheme":"Acc###","NamingSchemeType":2,"StartCount":7,"OU":"","Domain":"MyDomain.com","Lock":false,"TenantId":null,"ResourceLocationId":null,"ZoneUid":null,"WorkgroupMachine":false,"IdentityType":"ActiveDirectory","IdentityContent":null,"DeviceManagementType":"None","Accounts":[]}

EXAMPLE 2

Exports the identity pool named "MyPool". This pool contains accounts that have been used, so they are exported.
Export-AcctIdentityPool -IdentityPoolName MyPool
          
{"IdentityPoolName":"MyPool","NamingScheme":"Acc###","NamingSchemeType":2,"StartCount":3,"OU":"","Domain":"MyDomain.com","Lock":false,"TenantId":null,"ResourceLocationId":"59e9d28d-f46b-434a-97c2-995da9e120d7","ZoneUid":"c5282cd0-6526-4f83-b1bd-6ea2d46a7c59","WorkgroupMachine":false,"IdentityType":"ActiveDirectory","IdentityContent":null,"DeviceManagementType":"None","Accounts":[{"AccountSid":"S-1-5-21-4215727520-1727542857-3748865654-1404","AccountGuid":"85a82962-cbb2-4c74-aa2c-9502890e554b","Domain":"MyDomain.com","State":2,"AccountName":"MyDomain\\Acc001$","DomainControllerName":"v2_bnMtZGMubmljaG9sYXNzdS5sb2NhbDo1OWU5ZDI4ZC1mNDZiLTQzNGEtOTdjMi05OTVkYTllMTIwZDc=","TimeCreated":"2022-10-20T16:48:04.55"},{"AccountSid":"S-1-5-21-4215727520-1727542857-3748865654-1405","AccountGuid":"984a0fb8-ef0d-49d3-8720-3602878bc843","Domain":"MyDomain.com","State":2,"AccountName":"MyDomain\\ExportAcc002$","DomainControllerName":"v2_bnMtZGMubmljaG9sYXNzdS5sb2NhbDo1OWU5ZDI4ZC1mNDZiLTQzNGEtOTdjMi05OTVkYTllMTIwZDc=","TimeCreated":"2022-10-20T16:48:05.58"}]}

Parameters

-IdentityPoolUid

The unique identifier for the identity pool.
Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: True

-IdentityPoolName

The name of the identity pool.
Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 1 to 64

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can't pipe objects to this cmdlet.

Outputs

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 Citrix Virtual Apps and Desktops logs.