Skip to content
Was this article helpful?

Get-ProvImageDefinition

Gets the list of image definitions.

Syntax

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

Detailed Description

Lets you retrieve the list of defined image definitions.

Parameters

Name Description Required? Pipeline Input Default Value
PreparedImageDefinitionName The name of the image definition. false false
PreparedImageDefinitionUid The unique identifier of the image definition. 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.Imagedefinition

This object provides details of the image definition 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 of the image definition.

  • HostingUnitName <string> The name of the hosting unit (from the Hosting Unit PowerShell snap-in) that the definition uses.

  • HostingUnitUid <Guid> The unique identifier of the hosting unit (from the Hosting Unit PowerShell snap-in) that the definition uses.

  • OsType <string> The OS type for the image versions in this image definition.

  • PreparedImageDefinitionName <string> The name of the image definition.

  • PreparedImageDefinitionUid <Guid> The unique identifier for the image definition.

  • UseWriteBackCache <bool> Whether or not to use write back cache for the image versions in this image definition.

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-ProvImageDefinition

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

CustomProperties               :

Description                    : Windows image

HostingUnitName                : Hu

HostingUnitUid                 : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

OsType                         : Windows

PreparedImageDefinitionName    : Image1

PreparedImageDefinitionUid     : 7585f0de-192e-4847-a6d8-22713c3a2f42

UseWriteBackCache              : False

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

CustomProperties               :

Description                    : Linux image

HostingUnitName                : Hu

HostingUnitUid                 : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

OsType                         : Linux

PreparedImageDefinitionName    : Image2

PreparedImageDefinitionUid     : b5a55401-ad36-4f53-b0e0-dbb6a5bdf6fd

UseWriteBackCache              : False

Description

Returns all of the available image definitions.

Example 2

C:\PS>Get-ProvImageDefinition -PreparedImageDefinitionName Image[0-1]

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

CustomProperties               :

Description                    : Windows image

HostingUnitName                : Hu

HostingUnitUid                 : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

OsType                         : Windows

PreparedImageDefinitionName    : Image1

PreparedImageDefinitionUid     : 7585f0de-192e-4847-a6d8-22713c3a2f42

UseWriteBackCache              : False

Description

Returns all of the image definitions that have the name 'Image0' or 'Image1'.

Was this article helpful?