Citrix Daas SDK

Get-ProvImageDefinition

November 28, 2023

Contributed by:

C C

Gets the list of image definitions.

Syntax

Get-ProvImageDefinition
   [-PreparedImageDefinitionUid <Guid>]
   [[-PreparedImageDefinitionName] <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Lets you retrieve the list of defined image definitions.

Examples

EXAMPLE 1

Returns all of the available image definitions.

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
<!--NeedCopy-->

EXAMPLE 2

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

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
<!--NeedCopy-->

Parameters

-PreparedImageDefinitionName

The name of the image definition.

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

-PreparedImageDefinitionUid

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:

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.

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

Get-ProvImageDefinition

November 28, 2023

Contributed by:

C C

November 28, 2023

Contributed by:

C C

Get-ProvImageDefinition

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-PreparedImageDefinitionName

-PreparedImageDefinitionUid

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.ImageDefinition

Notes

Related Links

In this article