Restore-Volume
SYNOPSIS
Restores a volume from one of its immediate snapshots.
SYNTAX
ByNameSnapshotName (Default)
Restore-Volume [-Cluster] <Cluster> [-Name] <String> -SnapshotName <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByNameSnapshotId
Restore-Volume [-Cluster] <Cluster> [-Name] <String> -SnapshotId <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByIdSnapshotName
Restore-Volume [-Cluster] <Cluster> -Id <String> -SnapshotName <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByIdSnapshotId
Restore-Volume [-Cluster] <Cluster> -Id <String> -SnapshotId <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Restores the contents of a primary or clone volume from one of its immediate snapshots. Creates a backup snapshot of the volume before restore by default. Use BackupSnapshotName to create a snaphot with name of choice, otherwise system generated name will be used. Use SkipBackupSnapshot if no backup snapshot is required.
EXAMPLES
Example 1
PS C:\> Restore-Volume -Cluster $cluster -Id volume1 -SnapshotId snapshot1
Where $cluster is a PowerStore cluster instance. Restores volume with Id volume1 from snapshot with Id snapshot1 and backup snapshot will be created using a system generated timestamp.
Example 2
PS C:\> Restore-Volume -Cluster $cluster -Name volume1 -SnapshotId snapshot1 -BackupSnapshotName snapshot2
Where $cluster is a PowerStore cluster instance. Restores volume volume1 from snapshot with Id snapshot1 and backup snapshot will be created with name snapshot2.
Example 3
PS C:\> Restore-Volume -Cluster $cluster -Name volume1 -SnapshotName snapshot1 -SkipBackupSnapshot
Where $cluster is a PowerStore cluster instance. Restores volume volume1 from snapshot snapshot1 and no backup snapshot will be created before the restore operation.
PARAMETERS
-Cluster
A PowerStore Cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Name of volume to restore.
Type: String
Parameter Sets: ByNameSnapshotId, ByNameSnapshotName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
Id of volume to restore.
Type: String
Parameter Sets: ByIdSnapshotId, ByIdSnapshotName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SnapshotName
Name of snapshot to restore from.
Type: String
Parameter Sets: ByNameSnapshotName, ByIdSnapshotName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SnapshotId
Id of snapshot to restore from.
Type: String
Parameter Sets: ByNameSnapshotId, ByIdSnapshotId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SkipBackupSnapshot
Set if no backup snapshot is required.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BackupSnapshotName
Backup snapshot name.
Type: String
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BackupSnapshotDescription
Backup snapshot description.
Type: String
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force
Suppress confirmation prompt before restore.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns restored volume instance.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.