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

Copy-AcctIdentityPool

August 3, 2023
Contributed by: 
C

Copies an identity pool and any contained accounts to a new identity pool

Syntax


Copy-AcctIdentityPool [-IdentityPoolName] <String> [-NewIdentityPoolName] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Copy-AcctIdentityPool -IdentityPoolUid <Guid> [-NewIdentityPoolName] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to copy an identity pool.

The new identity pool will contain all the accounts that were in the original pool and will have the same domain and OU set. The naming scheme will be unset and the StartCount will be set to 1.

Parameters

Name Description Required? Pipeline Input Default Value
IdentityPoolName The name of the identity pool that is to be copied. true true (ByPropertyName)  
IdentityPoolUid The unique identifier for the identity pool that is to be copied. true false  
NewIdentityPoolName The name of the new identity pool. true 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 The address of a Citrix Virtual Apps and Desktops 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:

  • AvailableAccounts <int> The number of existing accounts (AcctADAccount objects) in the ‘Available’ state (not in ‘InUse’, ‘Tainted’, or ‘Error’).

  • DeviceManagementType <string> The device management type. Can be Intune, IntuneWithCitrixTags, or None by default.

  • Domain <string> The Active Directory domain (in FQDN format) that accounts in the pool belong to.

  • ErrorAccounts <int> The number of existing AD accounts in the ‘Error’ state.

  • IdentityContent <string> JSON formatted metadata containing Azure AD tenant and Azure AD security group information associated with this identity pool.

  • IdentityPoolName <string> The name of the identity pool.

  • IdentityPoolUid <GUID> The unique identifier for the identity pool.

  • IdentityType <string> The identity type.

  • InUseAccounts <int> The number of existing AD accounts in the ‘InUse’ state.

  • Lock <bool> Indicates if the identity pool is locked.

  • MetadataMap <IDictionary[string, string];> The metadata associated with this identity pool arranged in key value pairs.

  • NamingScheme <string> The naming scheme for the identity pool.

  • NamingSchemeType <string> 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

  • OU <string> The Active Directory distinguished name for the OU in which accounts for this identity pool will be created.

  • ResourceLocationId <GUID> The UID that corresponds to the resource location (DaaS only).

  • StartCount <int> The next index to be used when creating an account in the identity pool.

  • TaintedAccounts <int> The number of existing AD accounts in the ‘Tainted’ state.

  • WorkgroupMachine <bool> If this is true, the identity pool can have an IdentityType of ‘AzureAD’ or ‘Workgroup’. If this is false, the identity pool can have an IdentityType of ‘ActiveDirectory’ or ‘HybridAzureAD’.

  • ZoneUid <GUID> The UID that corresponds to the Zone in which AD accounts are created.

  • Scopes <Citrix.ADIdentity.Sdk.ScopeReference[]> The administration scopes associated with this identity pool.

  • TenantId <GUID> Identity of the Citrix tenant associated with this identity pool. Not applicable (always blank) in non-multitenant sites.

Notes

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

  • IdentityPoolDuplicateObjectExists: An identity pool with the same name exists already.

  • IdentityPoolObjectNotFound: The identity pool to be modified could not be located.

  • 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

  • DatabaseError: An error occurred in the service while attempting a database operation.

  • DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.

  • ServiceStatusInvalidDb: An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.

  • CommunicationError: An error occurred while communicating with the service.

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

Examples

Example 1 


c:\PS>Copy-AcctIdentityPool -IdentityPoolName MyPool -NewIdentityPoolName NewPool

AvailableAccounts    : 0

DeviceManagementType : None

Domain               : MyDomain.com

ErrorAccounts        : 0

IdentityContent      :

IdentityPoolName     : NewPool

IdentityPoolUid      : 2c94daf3-bf67-4e67-a7a2-d402e8f04e73

IdentityType         : ActiveDirectory

InUseAccounts        : 0

Lock                 : False

MetadataMap          : {}

NamingScheme         :

NamingSchemeType     : None

OU                   :

ResourceLocationId   :

StartCount           : 1

TaintedAccounts      : 0

WorkgroupMachine     : False

ZoneUid              :

Scopes               :

TenantId             :

<!--NeedCopy-->

Description

Copies the identity pool named “MyPool” to a new pool named “NewPool”. Note that the NamingScheme is empty and the StartCount is set to 1.

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