Restore-IscsiVirtualDisk
Restore-IscsiVirtualDisk
Restores an iSCSI virtual disk from a snapshot.
Syntax
Parameter Set: SnapshotId
Restore-IscsiVirtualDisk [-SnapshotId] <String> [ <CommonParameters>]
Parameter Set: __AllParameterSets
Restore-IscsiVirtualDisk [-ComputerName <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Parameter Set: InputObject
Restore-IscsiVirtualDisk -InputObject <IscsiVirtualDiskSnapshot> [ <CommonParameters>]
Detailed Description
The Restore-IscsiVirtualDisk cmdlet restores an iSCSI virtual disk using its snapshot.
Parameters
-ComputerName<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the credentials when connecting to a remote computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IscsiVirtualDiskSnapshot>
Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SnapshotId<String>
Specifies the identifier (ID) for the snapshot.
Aliases |
none |
Required? |
true |
Position? |
1 |
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.Iscsi.Target.Commands.VirtualDiskSnapshot
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example restores a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40}.
PS C:\> Restore-IscsiVirtualDisk -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}"
EXAMPLE 2
This example restores a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40} hosted on a computer named fs1.contoso.com.
PS C:\> Restore-IscsiVirtualDisk -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -ComputerName "fs1.contoso.com"
EXAMPLE 3
This example uses the Get-IscsiVirtualDiskSnapshot cmdlet to retrieve a snapshot, then assigns the snapshot object to a variable named $vhd1snapshot, and finally passes it to this cmdlet to restore the virtual disk.
PS C:\> Restore-IscsiVirtualDisk -InputObject $vhd1snapshot