Citrix Virtual Apps and Desktops SDK

Rename-AcctIdentityPool

August 3, 2023

Contributed by:

Renames an identity pool.

Syntax

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

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

<!--NeedCopy-->

Detailed Description

Provides the ability to change the name of an existing identity pool.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
IdentityPoolName	The name of the identity pool to be renamed.	true	true (ByPropertyName)
IdentityPoolUid	The unique identifier for the identity pool to be renamed.	true	false
NewIdentityPoolName	The new name for the identity pool. This must be a name which is not used by an existing identity pool, and it must not contain any of the following characters \/;:#.*?=<>\|”“’	true	true (ByPropertyName)
PassThru	Defines whether or not the command returns a result showing the new state of the updated provisioning scheme.	false	true (ByPropertyName)	true
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 that the PowerShell snap-in connects 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 <string> The name of the identity pool.
IdentityPoolUid <Guid> The unique identifier for the identity pool.
NamingScheme <string> The naming scheme for the identity pool.
NamingSchemeType <Citrix.XDInterServiceTypes.ADIdentityNamingScheme> 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 <int> The next index to be used when creating an identity from the identity pool.
OU <string> The Active Directory distinguished name for the OU in which accounts created from this identity pool will be created.
Domain <string> The Active Directory domain that accounts in the pool belong to.
Lock <Boolean> Indicates if the identity pool is locked.

Notes

In the case of failure the following errors can result.

IdentityPoolObjectNotFound: The specified identity pool 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 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 XenDesktop logs.

Examples

Example 1

C:\PS>Rename-AcctIdentityPool -IdentityPoolName oldName -NewIdentityPoolName newName

<!--NeedCopy-->

Description

Renames an existing identity pool called “oldName” to be called “newName”.

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

Rename-AcctIdentityPool

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Rename-AcctIdentityPool

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Adidentity.Sdk.Identitypool

Notes

Examples

Example 1

Description

In this article