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!
Reset-ProvVMDisk
Resets the OS disk of persistent VMs.
Syntax
Reset-ProvVMDisk [-ProvisioningSchemeName] <String> -VMName <String[]> -OS [-RunAsynchronously] [-PurgeJobOnSuccess] [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Reset-ProvVMDisk [-ProvisioningSchemeUid] <Guid> -VMName <String[]> -OS [-RunAsynchronously] [-PurgeJobOnSuccess] [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Allows you to reset the disks of persistent VMs from Machine Creation Services and hypervisor.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| ProvisioningSchemeName | The name of the provisioning scheme from which VM disks will be reset. This feature is available on VMware, Azure, AWS and Citrix hypervisor. | true | true (ByPropertyName) | |
| ProvisioningSchemeUid | The unique identifier of the provisioning scheme from which VM disks will be reset. | true | false | |
| VMName | List of VM names that will be have the OS disk reset. | true | true (ByValue, ByPropertyName) | |
| OS | Indicates that the OS disk should be reset. | true | 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 | |
| Force | Suppresses prompts for confirmation before proceeding to reset the OS disk of the specified VMs. | false | true (ByPropertyName) | |
| 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. |
| WhatIf | Shows what would happen if the cmdlet runs. The cmdlet is not run. | false | false | |
| Confirm | Prompts for confirmation before running the cmdlet. | false | false |
Input Type
Citrix.Machinecreation.Sdk.Provisionedvirtualmachine
You can pipe an object containing parameters called ‘VMName’ and ‘ProvisioningSchemeName’ to Reset-ProvVMDisk.
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 reset disk tasks, this is always “Reset-ProvVMDisk”. Status <string> Where in its lifecycle the task is. ResetVirtualMachines <Citrix.DesktopUpdateManager.SDK.VirtualMachineCreation[]> See FailedVirtualMachines for details of the object parameters. 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> 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. 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
Only one long-running task for each provisioning scheme can be processed at a time. 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.
- The: cmdlet is associated with a task of type ResetVirtualMachine, and while active will move through the following operations (CurrentOperation field) ValidatingInputs ResettingVirtualMachines
Examples
Example 1
c:\PS>,(Get-ProvVM -ProvisioningSchemeName "myProvScheme") | Reset-ProvVMDisk -ProvisioningSchemeName "myProvScheme" -OS
TaskId : 2706e50b-aff9-44c7-a3e3-8c8c7f1f4ac5
Active : False
Host : MY-DDC
DateStarted : 5/24/2022 12:02:29 PM
Metadata : {}
CurrentOperation :
TaskProgress : 100
LastUpdateTime : 5/24/2022 12:02:41 PM
ActiveElapsedTime : 10
DateFinished : 5/24/2022 12:02:41 PM
TerminatingError :
Type : ResetVM
Status : Finished
ResetVirtualMachines : {XD\machine01$, XD\machine02$}
FailedVirtualMachines : {}
ProvisioningSchemeName : myProvScheme
ProvisioningSchemeUid : 3d79b132-22c5-40d3-9a99-7cb497924f9e
TaskState : Finished
TaskStateInformation :
WorkflowStatus : Completed
TaskExpectedCompletion :
<!--NeedCopy-->
Description
Reset all VMs in provisioning scheme myProvScheme
Example 2
c:\PS>Reset-ProvVMDisk -ProvisioningSchemeName "myProvScheme" -VMName ("machine01","machine02") -OS
TaskId : 2706e50b-aff9-44c7-a3e3-8c8c7f1f4ac5
Active : False
Host : MY-DDC
DateStarted : 5/24/2022 12:02:29 PM
Metadata : {}
CurrentOperation :
TaskProgress : 100
LastUpdateTime : 5/24/2022 12:02:41 PM
ActiveElapsedTime : 10
DateFinished : 5/24/2022 12:02:41 PM
TerminatingError :
Type : ResetVM
Status : Finished
ResetVirtualMachines : {XD\machine01$, XD\machine02$}
FailedVirtualMachines : {}
ProvisioningSchemeName : myProvScheme
ProvisioningSchemeUid : 3d79b132-22c5-40d3-9a99-7cb497924f9e
TaskState : Finished
TaskStateInformation :
WorkflowStatus : Completed
TaskExpectedCompletion :
<!--NeedCopy-->
Description
Reset machine01 and machine02 in provisioning scheme myProvScheme
Example 3
c:\PS>Reset-ProvVMDisk -ProvisioningSchemeName "myProvScheme" -VMName "machine01" -OS
TaskId : 2706e50b-aff9-44c7-a3e3-8c8c7f1f4ac5
Active : False
Host : MY-DDC
DateStarted : 5/24/2022 12:02:29 PM
Metadata : {}
CurrentOperation :
TaskProgress : 100
LastUpdateTime : 5/24/2022 12:02:41 PM
ActiveElapsedTime : 10
DateFinished : 5/24/2022 12:02:41 PM
TerminatingError :
Type : ResetVM
Status : Finished
ResetVirtualMachines : {XD\machine01$}
FailedVirtualMachines : {}
ProvisioningSchemeName : myProvScheme
ProvisioningSchemeUid : 3d79b132-22c5-40d3-9a99-7cb497924f9e
TaskState : Finished
TaskStateInformation :
WorkflowStatus : Completed
TaskExpectedCompletion :
<!--NeedCopy-->
Description
Reset machine01 in provisioning scheme myProvScheme
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.