Download full document:



Rename-Acctidentitypool

Renames an identity pool.

Syntax

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

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

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

Description

Renames an existing identity pool called "oldName" to be called "newName".