-
-
-
-
-
-
-
-
-
-
New-HypVMSnapshot
-
-
-
-
-
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!
New-Hypvmsnapshot
Creates a new snapshot for the specified VM item path.
Syntax
New-HypVMSnapshot [-LiteralPath] <String> [-SnapshotName] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [[-SnapshotDescription] <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Use this command to create a new snapshot of a virtual machine, for a given Host Service provider path to a VM. The resulting snapshot can then be used for operations that require a snapshot to work.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| LiteralPath | Specifies the path within a hosting unit provider to the virtual machine item for which to create a new snapshot. The path specified must be in one of the following formats: |
true | true (ByValue) | |
| SnapshotName | The name of the new snapshot. This is visible in the hypervisor management console. | true | 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 | |
| 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. Once a value is provided by any cmdlet, this value becomes the default. |
| SnapshotDescription | The description to add to the snapshot. This is visible in the hypervisor management console. | false | false |
Input Type
System.String
You Can Pipe A String That Contains A Path To Get-Hypconfigurationdataforitem
Return Values
System.String.
The provider path to the newly created snapshot.
Notes
In the case of failure, the following errors can result.
Error Codes
———–
InputHypervisorItemPathInvalid
The path provided is not to an item in a sub-directory of a connection item or a hosting unit item.
InvalidHypervisorItemPath
No item exists with the specified path.
InvalidHypervisorItem
The item specified by the path exists, but is not a VM Item.
SnapshotNameAlreadyInUse
The specified name is already in use and will cause a name resolution clash.
FailedToCreateSnapshot
The snapshot creation process failed.
HypervisorInMaintenanceMode
The hypervisor is in maintenance mode.
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.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for
various reasons.
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
SnapshotChainTooLong
Snapshot creation failed. Snapshot chain is too long.
SnapshotCreationNotAuthorized
Snapshot creation failed. User not authorized to create snapshots.
Examples
Example 1
C:\PS>New-HypVMSnapshot -LiteralPath XDHyp:\Connections\MyConnection\MyVm.vm -SnapshotName "New snapshot" -SnapshotDescription "Example snapshot"
XDHyp:\Connections\MyConnection\MyVm.vm\New snapshot.snapshot
<!--NeedCopy-->
Description
This command creates a snapshot of a VM called ‘MyVm.vm’ within a hypervisor connection called ‘MyConnection’.
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.