Skip to content


Create a new image definition.


New-ProvImageDefinition [-PreparedImageDefinitionName] <String> -HostingUnitName <String> -OsType <String> [-Description <String>] [-CustomProperties <String>] [-UseWriteBackCache] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-ProvImageDefinition [-PreparedImageDefinitionName] <String> -HostingUnitUid <Guid> -OsType <String> [-Description <String>] [-CustomProperties <String>] [-UseWriteBackCache] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Lets you create a new image definition. An image definition can contain multiple image versions (See New-ProvImageVersion). The image definition defines basic information of all its image versions.


Name Description Required? Pipeline Input Default Value
PreparedImageDefinitionName The name of the image definition to be created. true false
OsType A value indicating the OS type for the image versions in this image definition. true false
HostingUnitName The name of the hosting unit used for the image definition. true false
HostingUnitUid The identifier for the hosting unit used for the image definition. true false
Description A value indicating the image description. false false
CustomProperties The properties of the image scheme that are specific to the target hosting infrastructure. false false
UseWriteBackCache Indicates whether or not write back cache is enabled for the image versions in this image definition. false 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.
Error Codes
An error occurred in the service while attempting a database operation.
The operation could not be completed because the database for the service is not configured.
An error occurred in the service while attempting a database operation - communication with the database failed for
for various reasons.
An error occurred while communicating with the service.
The user does not have administrative rights to perform this operation.
The operation could not be performed because of a configuration logging error.
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
The requested operation is not supported by this version of the service.


Example 1

c:\PS>New-ProvImageDefinition -PreparedImageDefinitionName MyImage -HostingUnitName Hu -OsType Windows -Description "Windows image"<br><br>            CreateTime                     : 1/1/2022 12:00:00<br><br>            CustomProperties               :<br><br>            Description                    : Windows image<br><br>            HostingUnitName                : Hu<br><br>            HostingUnitUid                 : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501<br><br>            OsType                         : Windows<br><br>            PreparedImageDefinitionName    : MyImage<br><br>            PreparedImageDefinitionUid     : 7585f0de-192e-4847-a6d8-22713c3a2f42<br><br>            UseWriteBackCache              : False


Create a new image definition with name "MyImage" on HostingUnit Hu.

Was this article helpful?