Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Remove-Provvm

August 3, 2023
Contributed by: 
C

Removes virtual machines.

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

Lets you remove VMs from the Machine Creation Services and the hypervisor that they run on.

Parameters

Name Description Required? Pipeline Input Default Value
ProvisioningSchemeName The name of the provisioning scheme from which virtual machines will be removed. true true (ByPropertyName)  
ProvisioningSchemeUid The unique identifier for the provisioning scheme from which the virtual machines are removed. true false  
VMName List of VM names that will be removed from the provisioning scheme. true true (ByValue, ByPropertyName)  
ForgetVM The named VMs will only be removed from the provisioning scheme database, but will remain in the hypervisor. false false  
RunAsynchronously Indicates whether or not the command returns before it is complete. 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 finishes. This cannot be specified for tasks that are 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 Specifies the address of a XenDesktop 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

Return Values

System.Guid

When the RunAsynchronously identifier is specified, this GUID is returned and provides the task identifier.
System.Management.Automation.PSCustomObject
This object provides details of the task that was run and contains the following information:
TaskId <Guid>
The identifier for the task that was performed.
Active <Boolean>
Indicates whether the task is still processing or is complete.
Host <string>
The name of the host on which the task is running or was run.
DateStarted <DateTime>
The date and time that the task was initiated.
Type <Citrix.XDInterServiceTypes.JobType>
The type of task. For new remove-VM tasks, this is always “RemoveVirtualMachine”.
Metadata <Citrix.MachineCreation.Sdk.Metadata[]>
The list of metadata stored for the task. For new tasks, this is empty until metadata is added.
WorkflowStatus <System.Workflow.Runtime.WorkflowStatus>
Indicates the status of the workflow that is used to process the task.
ProvisioningSchemeName <string>
The name of the provisioning scheme that the task is for.
ProvisioningSchemeUid <Guid>
The unique identifier of the provisioning scheme that the task is for.
TaskState <Citrix.DesktopUpdateManager.SDK.ProvisionVMState>
The state of the task. This can be any of the following:
Processing
Indicates that the task is in its initial state.
LocatingResources,
Indicates that the task is locating information from other services.
HostingUnitNotFound
Indicates that the required hosting unit could not be located.
ProvisioningSchemeNotFound
Indicates that the required provisioning scheme could not be located.
Provisioning
Indicates that the task is at the provisioning stage.
IdentityPoolNotFound
Indicates that the required identity pool could not be located.
TaskAlreadyRunningForProvisioningScheme
Indicates that the provisioning scheme already has another task running.
Finalizing
Indicates that the task is finalizing.
Finished
Indicates that the task is complete.
FinishedWithErrors
Indicates that the task is complete but there were errors. Specific details of errors are included with each failed virtual machine.
Removing
Indicates that the task is removing virtual machines from the hypervisor.
Failed
Job failed for reasons specified in TaskStateInformation.
Canceled
Indicates that the task was stopped by user intervention (using Stop-ProvTask)
TaskStateInformation
Provides more detailed information about the current task state.
VirtualMachinesToRemoveCount <int>
The total number of virtual machines that the task is trying to remove.
VirtualMachinesRemovedCount <int>
The number of virtual machines that the task has removed so far. Details of the machines that have been removed are in the RemovedVirtualMachines parameter.
VirtualMachinesFailedCount <int>
The number of virtual machines that the task has failed to remove. Details of the machines that failed are in the FailedVirtualMachines parameter.
FailedVirtualMachines <Citrix.DesktopUpdateManager.SDK.VirtualMachineCreation[]>
ADAccountName <string>
The domain-qualified AD Account name of the machine.
ADAccountSid <string>
The AD account SID of the machine account.
DiagnosticInformation <Citrix.MachineCreation.Sdk.ExceptionSurrogate[]>
A collection of handled error states which caused the provisioning to fail.
ExceptionType <string>
The type of exception this object represents
Message <string>
The exception message
Details <string>
The full exception content including stack trace
InnerException <Citrix.MachineCreation.Sdk.ExceptionSurrogate>
Information relating to any contributing error state
Status <string>
StatusAdditionalInformation <string>
VMId <string>
The virtual machine identifier in the hypervisor.
VMName <string>
The display name of the virtual machine in the hypervisor.
RemovedVirtualMachines <Citrix.DesktopUpdateManager.SDK.VirtualMachineCreation[]>
See FailedVirtualMachines for details of the object parameters.
ProgressEstimator
Gives an estimate of the number of virtual machines processed, averaging over virtual machines that were both partly and completely processed.

Notes

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.
Error Codes

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. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
The cmdlet is associated with a task of type RemoveVirtualMachine, and while active will move through the following operations (CurrentOperation field)
ValidatingInputs
RemovingVirtualMachines

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/2012 16:39:45

Metadata                     : {}

WorkflowStatus               : Completed

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

ProvisioningSchemeName       : XenPS

TaskState                    : Finished

TaskStateInformation         :

VirtualMachinesToRemoveCount : 2

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

FailedVirtualMachines        : {}

VirtualMachinesRemovedCount  : 2

VirtualMachinesFailedCount   : 0

ProgressEstimator            : 2

Type                         : RemoveVirtualMachine

Status                       : Finished

CurrentOperation             :

TaskProgress                 : 100

TaskExpectedCompletion       : 10/10/2012 16:39:50

LastUpdateTime               : 10/10/2012 16:39:50

ActiveElapsedTime            : 5

DateFinished                 : 10/10/2012 16:39:50

TerminatingError             :
<!--NeedCopy-->

Description

Remove all VMs from provisioning scheme XenPS

Remove-Provvm
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.