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

Copy-AcctIdentityPool

December 4, 2024
Contributed by: 
C

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

Syntax

Copy-AcctIdentityPool
    -IdentityPoolUid <Guid>
    [-NewIdentityPoolName] <String>
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Copy-AcctIdentityPool
    [-IdentityPoolName] <String>
    [-NewIdentityPoolName] <String>
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

Parameters

-IdentityPoolUid

The unique identifier for the identity pool that is to be copied.

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-IdentityPoolName

The name of the identity pool that is to be copied.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Length range: 1 to 64

-NewIdentityPoolName

The name of the new identity pool.

Type: String
Position: 3
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Length range: 1 to 64

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

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

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

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, IntuneWithSCCM, 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.

Copy-AcctIdentityPool
December 4, 2024
Contributed by: 
C
December 4, 2024
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.