Edit

Share via


Checkpoint-IscsiVirtualDisk

Creates a virtual disk snapshot.

Syntax

Default (Default)

Checkpoint-IscsiVirtualDisk
    [-Description <String>]
    [-OriginalPath] <String>
    [-ComputerName <String>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Description

The Checkpoint-IscsiVirtualDisk cmdlet creates a snapshot.

Examples

Example 1: Create a snapshot of a VHD

PS C:\> Checkpoint-IscsiVirtualDisk -OriginalPath "D:\VHDs\DB.vhdx"

This example creates a snapshot of the VHD with the path D:\VHDs\DB.vhdx.

Example 2: Create a snapshot of a VHD with description

PS C:\> Checkpoint-IscsiVirtualDisk -OriginalPath "D:\VHDs\DB.vhdx" -Description "Before database merge" -ComputerName "fssvr.contoso.com"

This example creates a snapshot of the VHD with the path D:\VHDs\DB.vhdx, and gives a description of the snapshot. The operation occurs on a remote computer that has the name fssvr.contoso.com.

Parameters

-ComputerName

Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer.

Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Credential

Specifies the credentials when connecting to a remote computer.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Description

Specifies the description for the iSCSI virtual disk snapshot.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-OriginalPath

Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk to which the snapshot belongs.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Path

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot