Citrix Virtual Apps and Desktops SDK


Changes the parameter values for a image definition.


Rename-ProvImageDefinition [-PreparedImageDefinitionUid] <Guid> -PreparedImageDefinitionName <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]


Detailed Description

Provides the ability to rename an existing image definition.


Name Description Required? Pipeline Input Default Value
PreparedImageDefinitionUid The identifier of the image definition to be updated. true false  
PreparedImageDefinitionName A value indicating the image definition name. 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 user 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


This object provides details of the image definitions and contains the following information:

  • CreateTime <DateTime> The date and time when the image definition was created. CustomProperties <string> Properties of the image definition which that are specific to the target hosting infrastructure. (See about_ProvCustomProperties) Description <string> The description for this image definition. HostingUnitName <string> The name of the hosting unit being used by this image definition. HostingUnitUid <Guid> The unique identifier of the hosting unit being used by this image definition. OsType <string> The OS type for this image definition. PreparedImageDefinitionName <string> The name of this image definition. PreparedImageDefinitionUid <Guid> The unique identifier for this image definition. UseWriteBackCache <bool> Whether to use WriteBackCache of this image definition.


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

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

  • UnsupportedByServer: The requested operation is not supported by this version of the service.


Example 1

c:\PS>Rename-ProvImageDefinition -PreparedImageDefinitionUid 7585f0de-192e-4847-a6d8-22713c3a2f42 -PreparedImageDefinitionName MyImage

          CreateTime                     : 1/1/2022 12:00:00

          CustomProperties               :

          Description                    : Windows image

          HostingUnitName                : Hu

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

          OsType                         : Windows

          PreparedImageDefinitionName    : MyImage

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

          UseWriteBackCache              : False



Update a image definition name with uid “7585f0de-192e-4847-a6d8-22713c3a2f42”.