Edit

Share via

Restore-IscsiVirtualDisk

  • Reference
Module:
IscsiTarget

Restores a virtual disk from a snapshot.

Syntax

Restore-IscsiVirtualDisk
       [-SnapshotId] <String>
       [-ComputerName <String>]
       [-Credential <PSCredential>]
       [<CommonParameters>]
Restore-IscsiVirtualDisk
       -InputObject <IscsiVirtualDiskSnapshot>
       [-ComputerName <String>]
       [-Credential <PSCredential>]
       [<CommonParameters>]

Description

The Restore-IscsiVirtualDisk cmdlet restores an iSCSI virtual disk using its snapshot.

Examples

Example 1: Restore a snapshot by using its ID

PS C:\> Restore-IscsiVirtualDisk -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}"

This example restores a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40}.

Example 2: Restore a snapshot hosted on another computer

PS C:\> Restore-IscsiVirtualDisk -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -ComputerName "fs1.contoso.com"

This example restores a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40} hosted on a computer named fs1.contoso.com.

Example 3: Restore a snapshot by using an input object

PS C:\> Restore-IscsiVirtualDisk -InputObject $vhd1snapshot

This example uses the Get-IscsiVirtualDiskSnapshot cmdlet to retrieve a snapshot, and then assigns the snapshot object to a variable named $vhd1snapshot, and finally passes it to this cmdlet to restore the virtual disk.

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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Credential

Specifies the credentials when connecting to a remote computer.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline.

Type:IscsiVirtualDiskSnapshot
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SnapshotId

Specifies the identifier (ID) for the snapshot.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot

Outputs

None