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-ProvVM
Removes virtual machines created by Machine Creation Services.
Syntax
Remove-ProvVM
[-ProvisioningSchemeName] <String>
-VMName <String[]>
[-PurgeDBOnly]
[-ForgetVM]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Remove-ProvVM
[-ProvisioningSchemeUid] <Guid>
-VMName <String[]>
[-PurgeDBOnly]
[-ForgetVM]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Allows you to remove VMs from the Machine Creation Services and hypervisor.
Examples
EXAMPLE 1
Remove all VMs from provisioning scheme XenPS
,(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-->
Parameters
-ProvisioningSchemeName
The name of the provisioning scheme from which VMs will be removed.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ProvisioningSchemeUid
The unique identifier of the provisioning scheme from which VMs will be removed.
| Type: | Guid |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMName
List of VM names that will be removed from the provisioning scheme.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-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”.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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”.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Citrix.MachineCreation.Sdk.ProvisionedVirtualMachine
You can pipe an object containing parameters called ‘VMName’ and ‘ProvisioningSchemeName’ to Remove-ProvVM.
Outputs
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.
Error Codes
ProvisioningSchemeNotFound
The specified provisioning scheme could not be located.
ProvisioningSchemeNotReady
The specified provisioning scheme is not in Ready state.
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.
Related Links
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.