Skip to content
Was this article helpful?

New-HypVMSnapshot

Creates a new snapshot for the specified VM item path.

Syntax

New-HypVMSnapshot [-LiteralPath] <String> [-SnapshotName] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [[-SnapshotDescription] <String>] [<CommonParameters>]

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.

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: <drive>:\Connections\<Connection Name>\<Item Path of VM object> or <drive>:\Connections\{<connection Uid>\<Item Path of VM object>}
  • or &lt;drive&gt; :\HostingUnits\<HostingUnit Name>\<Item Path of VM object> or <drive>:\HostingUnits\{<hostingUnit Uid>\<Item Path of VM object>} | 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 | | | TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | | | TraceState | Specifies the trace state assigned for internal diagnostic tracing use | 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.

  • 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

Description

This command creates a snapshot of a VM called 'MyVm.vm' within a hypervisor connection called 'MyConnection'.

Was this article helpful?