Citrix Virtual Apps and Desktops SDK

Get-ProvImageVersion

March 11, 2024

Contributed by:

Get a list of image versions.

Syntax

Get-ProvImageVersion [[-PreparedImageVersionNumber] <String>] [-PreparedImageVersionUid <Guid>] [-PreparedImageDefinitionUid <Guid>] [-PreparedImageDefinitionName <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Allows you to retrieve the list of defined image versions.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
PreparedImageVersionNumber	The image version number to retrieve.	false	false
PreparedImageVersionUid	The image version identifier to retrieve.	false	false
PreparedImageDefinitionUid	The identifier of image definition where image versions are contained.	false	false
PreparedImageDefinitionName	The name of image definition where image versions are contained.	false	false
ReturnTotalRecordCount	See about_Prov_Filtering for details.	false	false	false
MaxRecordCount	See about_Prov_Filtering for details.	false	false	false
Skip	See about_Prov_Filtering for details.	false	false	0
SortBy	See about_Prov_Filtering for details.	false	false
Filter	See about_Prov_Filtering for details.	false	false
FilterScope	Gets only results allowed by the specified scope id.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of 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	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. When a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Citrix.Machinecreation.Sdk.Imageversion

This object provides details of the image version 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 is used to create VMs.
Error <string> Error state that has occurred with this image version.
HostingUnitUid <Guid> The unique identifier of the hosting unit (from the Hosting Unit PowerShell snap-in) that the definition uses.
ImageRuntimeInfo <string> The image runtime information like operating system info, VDA components, etc.
ImageStatus <string> The status of the image version.
ImageVersionMetadata <string> The metadata associated with this image version.
MasterImageId <string> The hypervisor Id of master image used in this image version.
MasterImageVM <string> The inventory path to the VM snapshot copy used in this image version.
PageFileSettings <string> The page file settings to meet hypervisor-specific features demands.
PreparedImageDefinitionName <string> The name of image definition used in this image version.
PreparedImageDefinitionUid <Guid> The unique identifier of image definition used in this image version.
PreparedImageReplicas <Citrix.MachineCreation.Sdk.ImageReplica[]> Image replication information for this image version.
PreparedImageSchemeUid <Guid> The unique identifier of image scheme used in 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 <string> 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 image version.
WriteBackCacheDiskIndex <int> The disk index that the hypervisor reported as the actual disk index attachment point for the write back cache at image preparation time.
WriteBackCacheMemorySize <int> The memory size in MB of write back cache in this image version.
WriteBackCacheDiskSize <int> The disk size in MB of write back cache in this image version.

Notes

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.

Examples

Example 1

c:\PS>Get-ProvImageVersion

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

Description                              :

DiskSize                                 : 32

Error                                    :

HostingUnitUid                           : 0be23759-e276-4657-b863-e958a716cb6e

ImageRuntimeInfo                         :

ImageStatus                              : Prepared

ImageVersionMetadata                     :

MasterImageId                            : hu-dev-testing-rg/hu-dev-tsvda-snapshot

MasterImageVM                            : XDHyp:\HostingUnits\East US.region\image.folder\hu-dev-testing-rg.resourcegroup\hu-dev-tsvda-snapshot.snapshot

PageFileSettings                         : D:\pagefile.sys 0 0

PreparedImageDefinitionName              : myImage

PreparedImageDefinitionUid               : 42bd09f5-3fac-44a6-8b1c-7c09f1079cc0

PreparedImageReplicas                    :

PreparedImageSchemeUid                   : 53ed79c3-c771-4114-ba05-b999a62a836f

PreparedImageVersionNumber               : 1

PreparedImageVersionUid                  : b1c7602c-b080-4a63-846b-9d2429d54bd1

UpdatePageFileSettings                   : False

VMMetadata                               :

Warnings                                 : {}

WriteBackCacheDiskIndex                  : 0

WriteBackCacheDiskSize                   : 0

WriteBackCacheMemorySize                 : 0

<!--NeedCopy-->

Description

Returns all of the available image versions.

Example 2

c:\PS>Get-ProvImageVersion -PreparedImageDefinitionName myImage

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

Description                              :

DiskSize                                 : 32

Error                                    :

HostingUnitUid                           : 0be23759-e276-4657-b863-e958a716cb6e

ImageRuntimeInfo                         :

ImageStatus                              : Prepared

ImageVersionMetadata                     :

MasterImageId                            : hu-dev-testing-rg/hu-dev-tsvda-snapshot

MasterImageVM                            : XDHyp:\HostingUnits\East US.region\image.folder\hu-dev-testing-rg.resourcegroup\hu-dev-tsvda-snapshot.snapshot

PageFileSettings                         : D:\pagefile.sys 0 0

PreparedImageDefinitionName              : myImage

PreparedImageDefinitionUid               : 42bd09f5-3fac-44a6-8b1c-7c09f1079cc0

PreparedImageReplicas                    :

PreparedImageSchemeUid                   : 53ed79c3-c771-4114-ba05-b999a62a836f

PreparedImageVersionNumber               : 1

PreparedImageVersionUid                  : b1c7602c-b080-4a63-846b-9d2429d54bd1

UpdatePageFileSettings                   : False

VMMetadata                               :

Warnings                                 : {}

WriteBackCacheDiskIndex                  : 0

WriteBackCacheDiskSize                   : 0

WriteBackCacheMemorySize                 : 0

<!--NeedCopy-->

Description

Returns all of the available image versions for image definition “myImage”.

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

Get-ProvImageVersion

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-ProvImageVersion

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Machinecreation.Sdk.Imageversion

Notes

Examples

Example 1

Description

Example 2

Description

In this article