New-VirtualDiskSnapshot

New-VirtualDiskSnapshot

Creates a new snapshot of the specified virtual disk.

Syntax

Parameter Set: ByFriendlyName
New-VirtualDiskSnapshot [-VirtualDiskFriendlyName] <String[]> -FriendlyName <String> [-AsJob] [-CimSession <CimSession[]> ] [-TargetStoragePoolName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByName
New-VirtualDiskSnapshot -FriendlyName <String> -VirtualDiskName <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-TargetStoragePoolName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByUniqueId
New-VirtualDiskSnapshot -FriendlyName <String> -VirtualDiskUniqueId <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-TargetStoragePoolName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
New-VirtualDiskSnapshot -FriendlyName <String> -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-TargetStoragePoolName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The New-VirtualDiskSnapshot cmdlet creates a new snapshot of the specified virtual disk.

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases	Session
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-FriendlyName<String>

Specifies a friendly name for a disk. The friendly name may be defined by a user and is not guaranteed to be unique.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InputObject<CimInstance[]>

Accepts an object from the pipeline as input.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-TargetStoragePoolName<String>

Specifiess the name of the target storage pool.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VirtualDiskFriendlyName<String[]>

Specifies the friendly name of the virtual disk to be snapshot. The friendly name may be defined by a user.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-VirtualDiskName<String[]>

Specifies the name of the virtual disk. This parameter is typically read-only. This parameter is not equivalent to the VirtualDiskFriendlyName parameter that can be set by a user.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-VirtualDiskUniqueId<String[]>

Specifies the unique ID of the virtual disk to be snapshot.

Aliases	VirtualDiskId
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

EXAMPLE 1

This example creates a snapshot of the Virtual Disk object. The cmdlet returns the resultant snapshot as a new Virtual Disk object.

PS C:\> New-VirtualDiskSnapshot -VirtualDiskFriendlyName "SQLData5" -TargetStoragePoolName "Snapshots"

Related topics

Get-VirtualDisk