-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
-
Remove-ProvImageVersion
-
-
-
-
-
-
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!
Remove-ProvImageVersion
Remove specified image version.
Syntax
Remove-ProvImageVersion -PreparedImageDefinitionName <String> -PreparedImageVersionNumber <String> [-PurgeDBOnly] [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Remove-ProvImageVersion -PreparedImageVersionUid <Guid> [-PurgeDBOnly] [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Provides the ability to remove an image version and its relevant hard disk image that has been prepared to provision virtual machines.
A background task will be created to remove the old hard disk copies. You can locate and monitor this task using the Get-ProvTask cmdlet.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| PreparedImageDefinitionName | The name of image definition which the image version belongs to. | true | true (ByPropertyName) | |
| PreparedImageVersionNumber | The version number of image version. | true | true (ByPropertyName) | |
| PreparedImageVersionUid | The identifier of image version. | true | true (ByPropertyName) | |
| PurgeDBOnly | If this option is specified, this command will only remove the image version data from the Citrix site database. However, the disk images created in the image version still remain in the hypervisor. The hypervisor administrator can remove hard disk images using the tools provided by the hypervisor itself. This option can also be used when you are no longer able to contact the hypervisor and you want to remove the image version from Citrix site database. This parameter cannot be used with “ForgetVM”. | false | false | |
| ForgetVM | If this option is specified, this command will remove the image version data from the Citrix site database and also delete Citrix-assigned identifiers(like tags or custom-attributes) on image version’s disk images from hypervisor. However, the disk images created in the image version still remain in the hypervisor after removing identifiers(like tags or custom-attributes). The hypervisor administrator can remove the disk images using the tools provided by the hypervisor itself. This parameter cannot be used with “PurgeDBOnly”. | false | false | |
| RunAsynchronously | Indicates whether the command returns before it completes. If this is specified, the command returns an identifier for the task that was created. This task can be monitored using the get-ProvTask command. | false | false | false |
| PurgeJobOnSuccess | Indicates that the task history is removed from the database when the task completes. This cannot be specified for tasks that run asynchronously. | false | false | |
| LoggingId | Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. | 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 | The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
Input Type
Citrix.Machinecreation.Sdk.Imageversion
Return Values
Notes
In the case of failure, the following errors can result.
-
IllegalParameter: One or more parameters are illegal or are not specified.
-
ImageVersionNotFound: The specified image version could not be located.
-
UnableToRemoveImageVersionDueToAssociatedProvisioningScheme: Unable to remove specified image version due to associated provisioning scheme.
-
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.
Examples
Example 1
c:\PS>Remove-ProvImageVersion -PreparedImageVersionUid 90e93b9d-a225-4701-ad50-fa1546af35ac
<!--NeedCopy-->
Description
Removes image version with Guid 90e93b9d-a225-4701-ad50-fa1546af35ac and its prepared master hard disk image.
Example 2
c:\PS>Remove-ProvImageVersion -PreparedImageVersionNumber 1 -PreparedImageDefinitionName image1
<!--NeedCopy-->
Description
Removes image version v1.0 in image1 and its prepared master hard disk image.
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.