Citrix Virtual Apps and Desktops SDK

Remove-ProvVM

August 3, 2023

Contributed by:

Removes virtual machines created by Machine Creation Services.

Syntax

Remove-ProvVM [-ProvisioningSchemeName] <String> -VMName <String[]> [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-ProvVM [-ProvisioningSchemeUid] <Guid> -VMName <String[]> [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Allows you to remove VMs from the Machine Creation Services and hypervisor.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeName	The name of the provisioning scheme from which VMs will be removed.	true	true (ByPropertyName)
ProvisioningSchemeUid	The unique identifier of the provisioning scheme from which VMs will be removed.	true	false
VMName	List of VM names that will be removed from the provisioning scheme.	true	true (ByValue, ByPropertyName)
ForgetVM	If this option is specified, this command will only remove VM objects from the Machine Creation Services database; however, the VMs and hard disk copies still remain in the hypervisor. The hypervisor administrator can remove the VMs and hard disk images using the tools provided by the hypervisor itself. If not specified, the VMs and hard disk copies are also removed from hypervisor storage.	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. When a value is provided by any cmdlet, this value becomes the default.

Input Type

Citrix.Machinecreation.Sdk.Provisionedvirtualmachine

You can pipe an object containing parameters called ‘VMName’ and ‘ProvisioningSchemeName’ to Remove-ProvVM.

Return Values

System.Guid

When the RunAsynchronously identifier is specified, this GUID is returned and provides the task identifier.

Notes

The cmdlet is associated with a task of type RemoveVirtualMachine, and while active will move through the following operations (CurrentOperation field) ValidatingInputs RemovingVirtualMachines Only one long-running task for each provisioning scheme can be processed at a time. This task still operates if the hosting unit or VMs in the hypervisor are missing. This removes the data from the Citrix Machine Creation Services, but the VMs remain in the hypervisor. In the case of failure, the following errors can result.

JobCreationFailed The requested task could not be started.
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.
WorkflowHostUnavailable The task could not be started because the database connection is inactive.
CommunicationError An error occurred while communicating with the service.
InvalidParameterCombination Both PurgeJobOnSuccess and RunAsynchronously were specified. When running asynchronously, the cmdlet terminates before the job does, so it cannot clean up the completed job.
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.

Examples

Example 1

c:\PS>,(Get-ProvVM -ProvisioningSchemeName XenPS) | Remove-ProvVM XenPS

TaskId                       : cfb506a5-cc7e-4a49-ac7b-dd960029d0d3

Active                       : False

Host                         : DDC

DateStarted                  : 10/10/2021 16:39:45

Metadata                     : {}

CurrentOperation             :

TaskProgress                 : 100

LastUpdatedTime              : 10/10/2021 16:39:50

ActiveElapsedTime            : 5

DateFinished                 : 10/10/2021 16:39:50

TerminatingError             :

Type                         : RemoveVirtualMachine

Status                       : Finished

ForgetVM                     : False

RemovedVirtualMachines       : {XD\IP0001$, XD\IP0002$}

FailedVirtualMachines        : {}

ProvisioningSchemeName       : XenPS

ProvisioningSchemeUid        : e1afc8fb-3f52-42ea-9a17-305fdb0b6ee4

TaskState                    : Finished

TaskStateInformation         :

WorkflowStatus               : Completed

TaskExpectedCompletion       : 10/10/2021 16:39:50

<!--NeedCopy-->

Description

Remove all VMs from provisioning scheme XenPS

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

Remove-ProvVM

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Remove-ProvVM

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Machinecreation.Sdk.Provisionedvirtualmachine

Return Values

System.Guid

Notes

Examples

Example 1

Description

In this article