-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
-
Get-ProvImageDefinition
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-ProvImageDefinition
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.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.