Citrix Virtual Apps and Desktops SDK

Rename-Provscheme

August 3, 2023

Contributed by:

Renames a provisioning scheme.

Syntax

Rename-ProvScheme [-ProvisioningSchemeName] <String> [-NewProvisioningSchemeName] <String> [-PassThru] [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Rename-ProvScheme -ProvisioningSchemeUid <Guid> [-NewProvisioningSchemeName] <String> [-PassThru] [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Provides the ability to change the name of an existing provisioning scheme. The unique identifier for the provisioning scheme never changes after it has been created so, regardless of any name changes, the provisioning scheme can always be identified by its unique identifier.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeName	The current name of the provisioning scheme.	true	false
ProvisioningSchemeUid	The identifier for the provisioning scheme that is to be renamed.	true	false
NewProvisioningSchemeName	The new name for the provisioning scheme. This must be a name that is not being used by an existing provisioning scheme, and it must not contain any of the following characters \/;:#.*?=<>	”“’	true	false
PassThru	Defines whether or not the command returns a result showing the new state of the updated identity pool.	false	false	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
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.Machinecreation.Sdk.Provisioningscheme

This object provides details of the provisioning scheme and contains the following information:
ProvisioningSchemeUid
The unique identifier for the provisioning scheme.
ProvisioningSchemeName
The name of the provisioning scheme.
CpuCount
The numer of processors that VMs will be created with when using this scheme.
MemoryMB
The maximum amount of memory that VMs will be created with when using this scheme.
MasterImageVM
The path within the hosting unit provider to the VM or snapshot of which the scheme is currently using a copy.
MasterImageVMDate
The date and time that the copy of the VM image was made for the scheme.
IdentityPoolUid
The unique identifier of the identity pool (from the ADIdentity PowerShell snap-in) that the scheme uses.
IdentityPoolName
The name of the identity pool (from the ADIdentity PowerShell snap-in) that the scheme uses.
HostingUnitUid
The unique identifier of the hosting unit (from the Hosting Unit PowerShell snap-in) that the new provisioning scheme will use.
HostingUnitName
The name of the hosting unit (from the Hosting Unit PowerShell snap-in) that the new provisioning scheme will use.
CleanOnBoot
Indicates whether the VMs created are to be reset to a clean state on each boot.
TaskId
The identifier of any current task that is running for the provisioning scheme.
Metadata
The metadata for the provisioning scheme.

Notes

In the case of failure, the following errors can result.
Error Codes
———–
ProvisioningSchemeNotFound
The specified provisioning scheme could not be located.
ProvisioningSchemeNameAlreadyExists
A provisioning scheme with the same name as the new provisioning scheme name already exists.
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.
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
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-ProvScheme -provisioningSchemeName CurrentName -NewProvisioningSchemeName NewName
<!--NeedCopy-->

Description

Renames a provisioning scheme from “currentName” to “NewName”.

Example 2

C:\PS>Rename-ProvScheme -provisioningSchemeName CurrentName -NewProvisioningSchemeName NewName -PassThru

ProvisioningSchemeUid  : 7585f0de-192e-4847-a6d8-22713c3a2f42

ProvisioningSchemeName : NewName

CpuCount               : 1

MemoryMB               : 1024

MasterImageVM          : /Base.vm

MasterImageVMDate      : 17/05/2010 08:27:50

IdentityPoolUid        : 03743136-e43b-4a87-af74-ab71686b3c16

IdentityPoolName       : IdPool1

HostingUnitUid         : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

HostingUnitName        : XenHU

CleanOnBoot            : True

TaskId                 :

Metadata               : {}
<!--NeedCopy-->

Description

Renames a provisioning scheme from “currentName” to “NewName” and displays the resulting state.

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

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Rename-Provscheme

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Machinecreation.Sdk.Provisioningscheme

Notes

Examples

Example 1

Description

Example 2

Description

In this article