Get-ProvImageDefinition

Last published : Oct 31, 2026
Gets the list of image definitions.
Related information
about_ProvMachineCreationSnapIn

Syntax

Get-ProvImageDefinition
   [-ImageDefinitionUid <Guid>]
   [[-ImageDefinitionName] <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Lets you retrieve the list of defined image definitions.

Examples

EXAMPLE 1

Returns all of the available image definitions.
Get-ProvImageDefinition

        CreationTime           : 1/1/2022 12:00:00
        Description            : Windows image
        OsType                 : Windows
        VDASessionSupport      : MultiSession
        ImageDefinitionName    : Image1
        ImageDefinitionUid     : 7585f0de-192e-4847-a6d8-22713c3a2f42
        Metadata               :
        LatestVersion          : 2
        VersionsCount          : 2

        CreationTime           : 1/1/2022 12:00:00
        Description            : Linux image
        OsType                 : Linux
        VDASessionSupport      : MultiSession
        ImageDefinitionName    : Image2
        ImageDefinitionUid     : b5a55401-ad36-4f53-b0e0-dbb6a5bdf6fd
        Metadata               :
        LatestVersion          : 3
        VersionsCount          : 2

EXAMPLE 2

Returns all of the image definitions that have the name 'Image0' or 'Image1'.
Get-ProvImageDefinition -ImageDefinitionName Image[0-1]

        CreationTime           : 1/1/2022 12:00:00
        Description            : Windows image
        OsType                 : Windows
        VDASessionSupport      : MultiSession
        ImageDefinitionName    : Image1
        ImageDefinitionUid     : 7585f0de-192e-4847-a6d8-22713c3a2f42
        Metadata               :
        LatestVersion          : 3
        VersionsCount          : 2

Parameters

-ImageDefinitionName

The name of the image definition.
Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-ImageDefinitionUid

The unique identifier of the image definition.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-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

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 definition and contains the following information:
CreationTime \&lt;DateTime\>
The date and time when the image definition was created.
Description \&lt;string\>
The description of the image definition.
OsType \&lt;string\>
The OS type for the image versions in this image definition.
VDASessionSupport \&lt;string\>
The Session support of VDA for this image definition.
ImageDefinitionName \&lt;string\>
The name of the image definition.
ImageDefinitionUid \&lt;Guid\>
The unique identifier for the image definition.
Metadata \&lt;System.Collections.Generic.Dictionary\[string, string\];\>
The metadata to apply to the image definition, if specified.
LatestVersion \&lt;int\>
The latest version number in this definition.
VersionsCount \&lt;int\>
The total versions count in this definition.

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.