Get-ProvImageVersionSpecInstance

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2603
Get a list of image version specs instances.
Related information
about_ProvMachineCreationSnapIn

Syntax

Get-ProvImageVersionSpecInstance
   [[-ImageVersionSpecUid] <Guid>]
   [-StorageId <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Allows you to retrieve the list of defined image version spec instances.

Examples

EXAMPLE 1

Get an image version spec instance with the specified unique identifier.
Get-ProvImageVersionSpecInstance -ImageVersionSpecUid f80ede4d-4c43-4acc-8181-468af5f014f7

Context                   :                    
HostingUnitUid            : ff2b3c9e-1e2a-4f7c-8b1d-3c3e4f5a6b7c
ImageVersionSpecUid       : f80ede4d-4c43-4acc-8181-468af5f014f7
ImageInstanceUid          : 0f0d18cf-bbdf-4741-9c3a-452fbaa6bcef
OsDiskId                  : base_disk.vmdk
StorageId                 : datastore1

Parameters

-StorageId

Filter by the identifier of the storage location.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ReturnTotalRecordCount

See about_Prov_Filtering for details.
Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxRecordCount

See about_Prov_Filtering for details.
Type: Int32
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

See about_Prov_Filtering for details.
Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

See about_Prov_Filtering for details.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

See about_Prov_Filtering for details.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-FilterScope

Gets only results allowed by the specified scope id.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ImageVersionSpecUid

Filter by the identifier of the image version specification.
Type: Guid
Position: 2
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.Host.DataModel.ImageInstance

This object provides details of the image version spec instance and contains the following information:
ImageInstanceUid \&lt;Guid\> The unique identifier of the image version spec instance. ImageVersionSpecUid \&lt;Guid\> The unique identifier of the image version spec. HostingUnitUid \&lt;Guid\> The unique identifier of the hosting unit. HypervisorConnectionUid \&lt;Guid\> The unique identifier of hypervisor connection. StorageId \&lt;string\> The storage id associated with the image version spec instance. OsDiskId \&lt;string\> The disk id of the replicated image.

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.