-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
-
Remove-ProvScheme
-
-
-
-
-
-
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-ProvScheme
Removes a provisioning scheme
Syntax
Remove-ProvScheme [-ProvisioningSchemeName] <String> [-PurgeDBOnly] [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Remove-ProvScheme -ProvisioningSchemeUid <Guid> [-PurgeDBOnly] [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Provides the ability to remove a provisioning Scheme. The provisioning scheme must not contain any VMs unless the ‘ForgetVM’ or ‘PurgeDBOnly’ option is specified. Use the Get-ProvTask command to monitor the progress of this task.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| ProvisioningSchemeName | The name of the provisioning scheme to be removed. | true | true (ByPropertyName) | |
| ProvisioningSchemeUid | The unique identifier of the provisioning scheme to be removed. | true | true (ByPropertyName) | |
| PurgeDBOnly | If this option is specified, this command will only remove the provisioning scheme data from the Citrix site database. However, the VMs and related resources created in the provisioning scheme still remain in the hypervisor. The hypervisor administrator can remove the VMs and 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 provisioning scheme from Citrix site database. This parameter cannot be used with “ForgetVM”. | false | false | |
| ForgetVM | If this option is specified, this command will remove the provisioning scheme data from the Citrix site database and also delete Citrix-assigned identifiers(like tags or custom-attributes) on provisioning scheme, VMs and their related resources from hypervisor. However, the VMs and related resources created in the provisioning scheme still remain in the hypervisor after removing identifiers(like tags or custom-attributes). The hypervisor administrator can remove the VMs and hard disk images using the tools provided by the hypervisor itself. This parameter is only applied to persistent VMs and 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 | |
| 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 that the PowerShell snap-in connects 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.Provisioningscheme
You can pipe an object containing a parameter called ‘ProvisioningSchemeName’ or ‘ProvisioningSchemeUid’ to Remove-ProvScheme.
Return Values
System.Guid
When the RunAsynchronously identifier is specified, this GUID is returned and provides the task identifier.
Notes
If the hosting unit referenced by the provisioning scheme no longer exists (that is, has been removed using the Hosting Unit PowerShell snap-in), the provisioning scheme data is deleted from the database without errors. However, the hard disks associated with the provisioning scheme cannot be removed and remain in the hypervisor. In the case of failure, the following errors can result.
IllegalParameter One or more parameters are illegal or are not specified.
ProvisioningSchemeNotFound The specified provisioning scheme could not be located.
UnableToRemoveProvisioningSchemeDueToAssociatedVM The provisioning scheme contained VMs and the 'ForgetVM' or 'PurgeDBOnly' parameter was not specified.
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. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.
The cmdlet is associated with a task of type DisusedImageCleanUp, and while active will move through the following operations (CurrentOperation field)
Running
Examples
Example 1
c:\PS>Remove-ProvScheme -ProvisioningSchemeName $provScheme.ProvisioningSchemeName
<!--NeedCopy-->
Description
Remove the empty provisioning scheme by name.
Example 2
c:\PS>Get-ProvScheme -ProvisioningSchemeName Catalog-1 | Remove-ProvScheme -PurgeDBOnly
TaskId : 02693f9c-8fa0-41c8-ab23-15853537fbb1
Active : False
Host : E73755-92-1
DateStarted : 8/19/2022 12:50:34 PM
Metadata :
ProvisioningSchemeName : Catalog-1
ProvisioningSchemeUid : 60851748-3476-43c7-b406-c25f1a952185
PurgeDBOnly : True
ForgetVm : False
RemovedVirtualMachines : {}
FailedVirtualMachines : {}
TaskState : Finished
TaskStateInformation :
CurrentOperation :
TaskProgress : 100
LastUpdateTime : 8/19/2022 12:50:36 PM
ActiveElapsedTime : 0
DateFinished : 8/19/2022 12:50:36 PM
TerminatingError :
Type : RemoveProvScheme
Status : Finished
WorkflowStatus : Completed
TaskExpectedCompletion :
<!--NeedCopy-->
Description
Deletes provisioning scheme ‘Catalog-1’ data from the Citrix site database
Example 3
c:\PS>Get-ProvScheme -ProvisioningSchemeName Catalog-1 | Remove-ProvScheme -ForgetVM
TaskId : 02693f9c-8fa0-41c8-ab23-15853537fbb1
Active : False
Host : E73755-92-1
DateStarted : 8/19/2022 12:50:34 PM
Metadata :
ProvisioningSchemeName : Catalog-1
ProvisioningSchemeUid : 60851748-3476-43c7-b406-c25f1a952185
PurgeDBOnly : False
ForgetVm : True
RemovedVirtualMachines : {S-1-5-21-12345678-1234567890-123456789-2345}
FailedVirtualMachines : {}
TaskState : Finished
TaskStateInformation :
CurrentOperation :
TaskProgress : 100
LastUpdateTime : 8/19/2022 12:50:36 PM
ActiveElapsedTime : 0
DateFinished : 8/19/2022 12:50:36 PM
TerminatingError :
Type : RemoveProvScheme
Status : Finished
WorkflowStatus : Completed
TaskExpectedCompletion :
<!--NeedCopy-->
Description
Removes all the Citrix-assigned identifiers(like tags or custom-attributes) on provisioning scheme, VMs and their related resources from hypervisor and also the deletes provisioning scheme ‘Catalog-1’ data from the Citrix site database.
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.