Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-VirtualDiskSnapshot

New-VirtualDiskSnapshot

virtualdisk.cdxml

Synopsis

Creates a new snapshot of the specified virtual disk.

Syntax

New-VirtualDiskSnapshot [-AsJob] [-CimSession] [-TargetStoragePoolName] [-ThrottleLimit] [-FriendlyName] [-VirtualDiskUniqueId] [<CommonParameters>]

New-VirtualDiskSnapshot [-AsJob] [-CimSession] [-TargetStoragePoolName] [-ThrottleLimit] [-FriendlyName] [-VirtualDiskName] [<CommonParameters>]

New-VirtualDiskSnapshot [-AsJob] [-CimSession] [-TargetStoragePoolName] [-ThrottleLimit] [-FriendlyName] [-InputObject] [<CommonParameters>]

New-VirtualDiskSnapshot [-VirtualDiskFriendlyName] [-AsJob] [-CimSession] [-TargetStoragePoolName] [-ThrottleLimit] [-FriendlyName] [<CommonParameters>]

Detailed Description

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

This cmdlet is not needed when using the Storage Spaces subsystem.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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

Input Type

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

Return Type

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

Notes

None

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"

Online Version
Get-VirtualDisk