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

March 11, 2024
Contributed by: 
C

Removes virtual machines created by Machine Creation Services.

Syntax


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

Remove-ProvVM [-ProvisioningSchemeUid] <Guid> -VMName <String[]> [-PurgeDBOnly] [-ForgetVM] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <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)  
PurgeDBOnly 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. This parameter is exclusive with “ForgetVM”. false false  
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 after removing VMs’ citrix tags/identifiers. 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. This parameter is only applied to persistent VMs and exclusive 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 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.

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 <bool> 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 when the task was started.

  • Metadata <Citrix.MachineCreation.Sdk.Metadata[]> The list of metadata stored for the task. For new tasks, this is empty until metadata is added.

  • CurrentOperation <string> Operation specific phase of the overall “Running” task state.

  • TaskProgress <double> The progress of the task 0-100%.

  • LastUpdateTime <DateTime> The date and time of the last task status update.

  • ActiveElapsedTime <int> Number of seconds the task has taken for active execution.

  • DateFinished <DateTime> The date and time when the task was completed.

  • TerminatingError < Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskterminatingError> Diagnostic information if the task completely fails.

  • Type <Citrix.XDInterServiceTypes.JobType> The type of task. For new remove-VM tasks, this is always “RemoveVirtualMachine”.

  • Status <string> Where in its lifecycle the task is.

  • PurgeDBOnly <bool> Whether the named VMs are only removed from the Machine Creation Service database, but still remain in the hypervisor.

  • ForgetVm <bool> Whether the named VMs are only removed from the Machine Creation Service database, but still remain in the hypervisor after removing VMs’ citrix tags/identifiers.

  • RemovedVirtualMachines <Citrix.DesktopUpdateManager.SDK.VirtualMachineCreation[]> Object array of removed virtual machines summary information. The object properties are:

  • 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> The status of the virtual machine.

  • StatusAdditionalInformation <string> Extra information about the Status.

  • VMId <string> The virtual machine identifier in the hypervisor.

  • VMName <string> The display name of the virtual machine in the hypervisor.

  • FailedVirtualMachines <Citrix.DesktopUpdateManager.SDK.VirtualMachineCreation[]> See RemovedVirtualMachines for details of the object parameters.

  • ProvisioningSchemeName <string> The name of the provisioning scheme from which the VM was created.

  • ProvisioningSchemeUid <Guid> The unique identifier of the provisioning scheme from which the VM was created.

  • 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 <string> Provides more detailed information about the current task state.

  • WorkflowStatus <System.Workflow.Runtime.WorkflowStatus> Indicates the status of the workflow that is used to process the task.

  • TaskExpectedCompletion <DateTime> The date and time at which the task is expected to complete.

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

            PurgeDBOnly                  : False

            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

Remove-ProvVM
March 11, 2024
Contributed by: 
C
March 11, 2024
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.