Citrix Virtual Apps and Desktops SDK

Set-ProvImageVersion

March 11, 2024

Contributed by:

Changes the parameter values for a image version.

Syntax

Set-ProvImageVersion
   [-PreparedImageVersionUid] <Guid>
   [-Description <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ProvImageVersion
   -PreparedImageDefinitionName <String>
   -PreparedImageVersionNumber <String>
   [-Description <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to update the parameters of an existing image version.

The following parameters are allowed to be updated:

The description of the image version.

Examples

EXAMPLE 1

Update a image definition description with image definition name “MyImage” and image version number “1”.

Set-ProvImageVersion -PreparedImageDefinitionName MyImage -PreparedImageVersionNumber 1 -Description "Windows image"

CreateTime                       : 5/19/2022 3:20:23 AM
Description                      : Windows image
DiskSize                         : 32
Error                            :
HostingUnitUid                   : b86b4442-6ecb-4b73-a655-7ca7170e19e5
ImageRuntimeInfo                 :
ImageStatus                      : Prepared
ImageVersionMetadata             : {}
MasterImageId                    : hu-dev-testing-rg/hu-dev-tsvda-snapshot
MasterImageVM                    : /East US.region/image.folder/hu-dev-testing-rg.resourcegroup/hu-dev-tsvda-snapshot.snapshot
PageFileSettings                 : D:\pagefile.sys 0 0
PreparedImageDefinitionName      : MyImage
PreparedImageDefinitionUid       : 6d67c0a5-6ecc-4c46-8404-156205635cf4
PreparedImageReplicas            : {57fc60c3-eb9b-4d38-8646-0afceec85335}
PreparedImageSchemeUid           : 57ce7bbc-7193-47df-95d4-d4999c720cac
PreparedImageVersionNumber       : 2
PreparedImageVersionUid          : d366d140-1ec0-464f-aea0-77b706e94580
UpdatePageFileSettings           : False
VMMetadata                       :
Warnings                         : {}
WriteBackCacheDiskIndex          : 0
WriteBackCacheDiskSize           : 0
WriteBackCacheMemorySize         : 0
<!--NeedCopy-->

Parameters

-PreparedImageVersionUid

The identifier of the image version to be updated.

Type:	Guid
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PreparedImageDefinitionName

The name of the image definition to be updated.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PreparedImageVersionNumber

The version number of the image version to be updated.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

The description of the image version to be updated.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.MachineCreation.Sdk.ImageDefinition

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

CreateTime <DateTime>

The date and time when the image version was created.

Description <string>

The description of the image version.

DiskSize <int>

The disk size (in GB) that will be used to create VMs.

Error <string>

Error state that has occurred with this image version.

HostingUnitUid <Guid>

The unique identifier of the hosting unit being used by this image scheme.

ImageRuntimeInfo <string>

The image runtime information like operating system info, VDA components, etc.

ImageStatus <string>

The status of the provisioning scheme image.

ImageVersionMetadata <string>

The metadata associated with this image version.

MasterImageId <string>

The unique identifier of the snapshot, as assigned by the hosting unit.

MasterImageVM <string>

The inventory path to the VM snapshot copy used by this provisioning scheme.

PageFileSettings <string>

The page file settings to meet hypervisor-specific features demands.

PreparedImageDefinitionName <string>

The name of the image definition which is used for this image version.

PreparedImageDefinitionUid <Guid>

The unique identifier of the image definition which is used for this image version.

PreparedImageReplicas

Image replication information for this image version.

PreparedImageSchemeUid <Guid>

The unique identifier of the image scheme which is used for this image version.

PreparedImageVersionNumber <string>

The version number of the image version.

PreparedImageVersionUid <Guid>

The unique identifier for the image version.

UpdatePageFileSettings <bool>

Whether to update page file settings for write back cache

VMMetadata <char[]>

The metadata that will be used to created VMs in a plain text format.

Warnings <Citrix.MachineCreation.Sdk.ProvSchemeWarning[]>

Warning states that have occurred with this provisioning scheme.

WriteBackCacheDiskIndex <int>

The disk index for the write-back cache disk. Specify only when UseWriteBackCache is true.

WriteBackCacheDiskSize <int>

The size of the write-back cache disk to be used in GB. Specify only when UseWriteBackCache is true.

WriteBackCacheMemorySize <int>

The size of the write-back memory cache in MB. Specify only when UseWriteBackCache is true.

Notes

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

Error Codes

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.

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

Set-ProvImageVersion

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Set-ProvImageVersion

Syntax

Description

Examples

EXAMPLE 1

Parameters

-PreparedImageVersionUid

-PreparedImageDefinitionName

-PreparedImageVersionNumber

-Description

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.ImageDefinition

Notes

Related Links

In this article