Restore-FileSystemSnapshot
SYNOPSIS
Restores a file system from a snapshot.
SYNTAX
Restore-FileSystemSnapshot [-Cluster] <Cluster> [-Id] <String> [-BackupSnapshotName <String>] [-Confirm]
[-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Restores a file system from the given snapshot. Optionally a backup snapshot of the file system can be created before the restore operation occurs.
EXAMPLES
Example 1
PS C:\> Restore-FileSystemSnapshot -Cluster $cluster -Id de81f766-498f-4126-961d-bcab8bce35a4
Where $cluster is a PowerStore cluster. Restores a file system from its snapshot with ID de81f766-498f-4126-961d-bcab8bce35a4.
Example 2
PS C:\> Restore-FileSystemSnapshot -Cluster $cluster -Id de81f766-498f-4126-961d-bcab8bce35a4 -BackupSnapshotName backup-snap1
Where $cluster is a PowerStore cluster. Restores a file system from its snapshot with ID de81f766-498f-4126-961d-bcab8bce35a4 and a backup snapshot will be created with name backup-snap1.
PARAMETERS
-Cluster
The PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Id
The file system snapshot ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-BackupSnapshotName
Name of the backup snap to be created before the restore operation occurs. If no name is specified no backup copy will be made.
Type: String
Parameter Sets: (All)
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 restoring the file system.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Return the file system snapshot instance that was used to restore from.
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.