Restore-IscsiVirtualDisk
Restores a virtual disk from a snapshot.
Syntax
SnapshotId (Default)
Restore-IscsiVirtualDisk
[-SnapshotId] <String>
[-ComputerName <String>]
[-Credential <PSCredential>]
[<CommonParameters>]
InputObject
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.
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 |
-InputObject
Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline.
Parameter properties
| Type: | IscsiVirtualDiskSnapshot |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SnapshotId
Specifies the identifier (ID) for the snapshot.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SnapshotId
| 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.