New-Virtual Disk Snapshot

Module:
storage
Creates a new snapshot of the specified virtual disk.

Syntax 

New-VirtualDiskSnapshot
   -VirtualDiskUniqueId <String[]>
   -FriendlyName <String>
   [-TargetStoragePoolName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
New-VirtualDiskSnapshot
   [-VirtualDiskFriendlyName] <String[]>
   -FriendlyName <String>
   [-TargetStoragePoolName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
New-VirtualDiskSnapshot
   -VirtualDiskName <String[]>
   -FriendlyName <String>
   [-TargetStoragePoolName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
New-VirtualDiskSnapshot
   -InputObject <CimInstance[]>
   -FriendlyName <String>
   [-TargetStoragePoolName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

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

ps_storage_spacesubsystem_not_remark

Examples

EXAMPLE 1 

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

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

Required Parameters

-FriendlyName

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

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VirtualDiskFriendlyName

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

Type: String[]
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-VirtualDiskName

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.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-VirtualDiskUniqueId

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

Type: String[]
Aliases: VirtualDiskId
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TargetStoragePoolName

Specifiess the name of the target storage pool.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Inputs

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

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.