Restore-SmBackup

09/17/2024 Contributors

Restores a backup.

Syntax

Restore-SmBackup [-PluginCode]  <PluginCode>  [-AppObjectId]  <String>  [-BackupId]  <String>  [-BackupName]  <String>  [-LogRestoreType]  <SmSqlLogRestoreType>  [-RestoreWhenOnline]  <>  [-RetainReplicationSettings]  <>  [-CreateTransactionLog]  <>  [-FailOnTransactionLogBackupFailure]  <>  [-RecoveryModel]  <SmSqlRecoveryModel>  [-UndoLogDirectory]  <String>  [-Archive]  <Hashtable[]>  [-AuxiliaryDestination]  <String>  [-LogArchive]  <Hashtable[]>  [-AlternatePath]  <Hashtable[]>  [-LogCount]  <Int32>  [-LogCutOffDateTime]  <DateTime>  [-FailOnLogBackupFailure]  <>  [-SceRecoveryModel]  <SCERecoveryModel>  [-ExistingFiles]  <>  [-TargetHost]  <String>  [-NoVerify]  <>  [-IsRecoverMount]  <>  [-PreScriptCommand]  <String>  [-PreScriptArguments]  <String>  [-SQLInstanceName]  <String>  [-DatabaseName]  <String>  [-CustomLogDirectory]  <String>  [-RecoveryTypeHanaRecoveryType]  <HanaRecoveryType>  [-RecovertimezoneString]  <>  [-TenantDatabaseNameString]  <String>  [-VolumeRevertSwitchParameter]  <>  [-PostScriptCommand]  <String>  [-PostScriptArguments]  <String>  [-ScriptTimeOut]  <Int32>  [-OracleControlFileRestore]  <>  [-OracleFullRestore]  <>  [-OracleSkipRecovery]  <>  [-OracleUntilScn]  <Int64>  [-OracleTablespaces]  <String>  [-OracleChangeState]  <>  [-OraclePluggableDatabases]  <String>  [-AlternateArchiveLogsPath]  <String>  [-OracleOpenDatabaseAfterRecovery]  <>  [-OracleUntilTime]  <DateTime>  [-RestoreLastBackup]  <Int32>  [-RestoreOnClusterHost]  <String>  [-RestoreOracleRedoLogFile]  <>  [-OracleOpenPluggableDatabasesAfterRecovery]  <>  [-OracleOpenTablespacesAfterRecovery]  <>  [-ForceInplaceRestore]  <>  [-PluginCreatorCustomRestoreParams]  <Hashtable>  [-EnableEmail]  <>  [-EmailPreference]  <SmEmailNotificationPreference>

Detailed Description

Restores a backup. You can specify whether to restore log files or not, and the types of log files. You can restore databases even if existing databases are online.

Parameters

Name	Description	Required?	Pipeline Input
PluginCode	Specifies the plug-in code of the resource to be restored. Valid plug-in codes are SCW and SCSQL.	true	false
AppObjectId	Specifies the ID of the application object.	true	false
BackupId	Specifies the ID of the backup to use for restore.	false	false
BackupName	Specifies the name of the backup to use for restore.	false	false
LogRestoreType	Specifies the log restore type. User can choose to apply no logs, all logs or specific logs.	false	false
RestoreWhenOnline	Restore databases even if existing databases are online.	false	false
RetainReplicationSettings	Retain SQL database replication settings.	false	false
CreateTransactionLog	Create transaction log backup before restore.	false	false
FailOnTransactionLogBackupFailure	Quit restore if transaction log backup fails before restore.	false	false
RecoveryModel	Specifies the SQL recovery model for applying logs.	false	false
UndoLogDirectory	Specifies a location where the standby files are created, so that the recovery effects can be reversed.	false	false
Archive	Specifies the secondary storage system details for restore.	false	false
AlternatePath	Specifies an alternate location to restore the database.	false	false
LogCount	Specifies the number of logs to apply.	false	false
AuxiliaryDestination	Auxiliary destination on the database host required to perform Oracle point in time recovery.	false	false
LogArchive	Specify the archive location of the archive logs from where the Oracle database resource is to be restored	false	false
LogCutOffDateTime	Specifies the cutoff time to restore the database. If the server and plug-in host are in different time zones, the input must be as per the plug-in host time zone.	false	false
FailOnLogBackupFailure		false	false
SceRecoveryModel		false	false
ExistingFiles	Restore from Existing files specified in AlternatePath.	false	false
TargetHost		false	false
NoVerify		false	false
IsRecoverMount		false	false
PreScriptCommand	Specifies commands that get executed before the restore operation.	false	true (ByPropertyName)
PreScriptArguments	Specifies arguments to the prescript command.	false	true (ByPropertyName)
SQLInstanceName	Specifies the SQL Server instance to which the database is restored in an alternate path scenario.	false	false
DatabaseName	Specifies the new database name when restoring the database to an alternate path.	false	false
CustomLogDirectory	This parameter is required for specifying a custom path, either a network share path or a drive path, where you have stored the logs. This parameter is used for restore operations from both primary and secondary copies.	false	false
RecoveryType	Specifies the recovery type for HANA resources.	false	false
Recovertimezone	Timezone of the client. This parameter is applicable to HANA plug-in resource when the RecoveryType specified is 'RecoverUntilDateTime'. Acceptable format: GMT+HH:MM or GMT-HH:MM.	false	false
TenantDatabaseName	Name of the HANA tenant database to be restored. This parameter is applicable to MultiTenant Database Containers resources. No recovery will be performed for the specified tenant database.	false	false
VolumeRevert	Enables file system restore in case of Complete Restore for Auto-discovered resources. This parameter is used mainly for auto-discovered resource backups and this option can be used to prevent volume based restore and cleaning up of later backups if an older backup is selected for restore.	false	false
PostScriptCommand	Specifies the commands that get executed after the restore operation.	false	true (ByPropertyName)
PostScriptArguments	Specifies the arguments to the postscript command.	false	true (ByPropertyName)
ScriptTimeOut	Specifies the maximum timeout to wait for the script to complete.	false	true (ByPropertyName)
OracleControlFileRestore	Indicates that you want to restore the Oracle control file.	false	false
OracleFullRestore	Indicates that you want to perform a full Oracle database restore.	false	false
OracleSkipRecovery	Indicates that you want to skip Oracle database recovery.	false	false
OracleUntilScn	Indicates that you want to restore to a specific System Change Number.	false	false
OracleTablespaces	Indicates the Pluggable database (PDB) tablespaces to be restored.	false	false
OracleChangeState	Indicates that the database state should be changed to the state required to perform restore and recovery operations.The states of a database from higher to lower are open, mounted, started, and shutdown.	false	false
OraclePluggableDatabases	Indicates the Pluggable databases to be restored.	false	false
AlternateArchiveLogsPath	Indicates an alternate archive logs path.	false	false
OracleOpenDatabaseAfterRecovery	Specifies that the databases must be opened after recovery is performed.	false	false
OracleUntilTime		false	false
RestoreLastBackup	Restore the Nth Backup of a resource with provided AppObjectId. For example, value entered as 5 with AppObjectId "testResource", it will restore the 5th backup for resource found with AppObjectId "testResource" provided that at least 5 backups are available.	false	false
RestoreOnClusterHost	Specifies the cluster node on which the restore operation must be performed. You must specify this option only for an Oracle RAC database. If this option is not specified, restore operation is performed on the node where the backup was created.	false	false
RestoreOracleRedoLogFile	Indicates that you want to restore Oracle redo log files. Redo log file restore is only supported for Data Guard and Active Data Guard standby database.	false	false
OracleOpenPluggableDatabasesAfterRecovery	Specifies that the pluggable databases must be opened after recovery is performed.	false	false
OracleOpenTablespacesAfterRecovery	Specifies that the tablespaces must be opened after recovery is performed.	false	false
ForceInplaceRestore	Indicates that you want to perform in-place restore and bypass all restore validations.	false	false
PluginCreatorCustomRestoreParams		false	false
EnableEmail	Enables e-mail.	false	false
EmailPreference	Specifies when you will receive e-mail notifications.Possible values: Always, Never, OnError, OnErrorOrWarning.	false	false
EmailFrom	Specifies the sender's e-mail address.	true	true (ByPropertyName)
EmailTo	Specifies the recipient's e-mail address.	true	true (ByPropertyName)
EmailSubject	Specifies the e-mail subject.	true	true (ByPropertyName)
EnableEmailAttachment	Enables email attachments.	false	true (ByPropertyName)

Name

Description

Required?

Pipeline Input

Default Value

PluginCode

Specifies the plug-in code of the resource to be restored. Valid plug-in codes are SCW and SCSQL.

true

false

AppObjectId

Specifies the ID of the application object.

true

false

BackupId

Specifies the ID of the backup to use for restore.

false

BackupName

Specifies the name of the backup to use for restore.

false

LogRestoreType

Specifies the log restore type. User can choose to apply no logs, all logs or specific logs.

false

RestoreWhenOnline

Restore databases even if existing databases are online.

false

RetainReplicationSettings

Retain SQL database replication settings.

false

CreateTransactionLog

Create transaction log backup before restore.

false

FailOnTransactionLogBackupFailure

Quit restore if transaction log backup fails before restore.

false

RecoveryModel

Specifies the SQL recovery model for applying logs.

false

UndoLogDirectory

Specifies a location where the standby files are created, so that the recovery effects can be reversed.

false

Examples

Example 1: Restoring from a primary backup

 PS C:\> Restore-SmBackup -PluginCode SCSQL -AppObjectId 'vise-f6\PayrollDatabase' -BackupNam
          e 'NetApp_PayrollDataset_Backup Policy_vise-f6_NetApp_08-07-2015_08.48.59.6962' -RestoreWhenOnline

This example syntax restores from a primary backup.

Name: Restore 'vise-f6\PayrollDatabase'
Id  : 199
StartTime   : 8/7/2015 9:21:36 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 2: Restoring to an alternate path from a primary

 PS C:\> Restore-SmBackup -PluginCode SCSQL -AppObjectId 'vise-f6\PayrollDatabase' -BackupNam
          e 'NetApp_PayrollDataset_Backup Policy_vise-f6_NetApp_08-07-2015_08.48.59.6962' -AlternatePath @{Source='I:\PayrollDatab
          ase.mdf';Destination='H:\PayrollDatabase_copy_log.mdf'},@{Source='I:\PayrollDatabase_log.ldf';Destination='H:\PayrollDat
          abase_copy_log.ldf'} -SQLInstanceName 'vise-f6\BRAVEHEART' -DatabaseName 'PayrollDatabase_copy'

This example syntax restores a backup to an alternate path

Name: Restore 'vise-f6\PayrollDatabase'
Id  : 203
StartTime   : 8/7/2015 9:30:32 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 3: Restoring from a secondary backup

 PS C:\> Restore-SmBackup -PluginCode SCSQL -AppObjectId 'vise-f6\PayrollDatabase' -BackupNam
          e 'NetApp_PayrollDataset_Backup Policy_vise-f6_NetApp_08-07-2015_08.48.59.6962' -Archive @{Primary="rtp-rr1-d2.gdl.engla
          b.netapp.com:vol_src";Secondary="vs1:vs1_vol_src_vault"} -RestoreWhenOnline

This example syntax restores from a secondary backup.

Name: Restore 'vise-f6\PayrollDatabase'
Id  : 208
StartTime   : 8/7/2015 9:40:12 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 4: Removing a Run As account from a resource

 PS C:\> Restore-SmBackup -PluginCode SCSQL -AppObjectId 'vise-f6\PayrollDatabase' -BackupNam
          e 'Mycompany_PayrollDataset_Backup Policy_vise-f6_Mycompany_08-07-2015_08.48.59.6962' -Archive @{Primary="rtp-rr1-d2.gdl.mycompany.com:vol_src";Secondary="vs1:vs1_vol_src_vault"} -RestoreWhenOnline -AlternatePath @{Source='I:\PayrollDatabase.
          mdf';Destination='H:\PayrollDatabase_copy_log.mdf'},@{Source='I:\PayrollDatabase_log.ldf';Destination='H:\PayrollDatabas
          e_copy_log.ldf'} -SQLInstanceName 'vise-f6\BRAVEHEART' -DatabaseName 'PayrollDatabase_copy'

This example syntax removes a Run As account from a resource.

Name: Restore 'vise-f6\PayrollDatabase'
Id  : 210
StartTime   : 8/7/2015 9:46:54 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 5: Restore complete Resource of Custom plugin DB2 from Primary Storage

 Restore-SmBackup -PluginCode 'DB2' -AppObjectId 'sccorelinux61.sccore.test.com\DB2\NTP\DB1' -BackupId 191 -Confirm:$false -mountcommands 'sh /var/opt/mountCmd.sh' -unmountcommands 'sh /var/opt/unmountCmd.sh'

Restore complete Resource of type Database of Custom plug-in DB2 from Primary Storage with mount and umount commands

Example 6: Restore Complete custom plugin resource from Secondary storage

 Restore-SmBackup -PluginCode 'DB2' -AppObjectId 'sccorelinux61.sccore.test.com\DB2\SECONDARYSMSV1' -BackupId 198 -Confirm:$false  -customrestoreparams @{"KEY_PARAM1"="CUSTPARAM1"} -prescriptarguments 'PreScriptCommand > PreScriptCommand.txt' -prescriptcommand echo -postscriptarguments 'PostScriptCommand > PostScriptCommand.txt' -postscriptcommand echo -Archive @( @{"Primary"="vserver_scauto_primary:SMSV1_SRC_sccorelinux61_sccore_test_com";"Secondary"="vserver_scauto_primary:SMSV1_DST3_sccorelinux61_sccore_test_com"})

Restore Complete custom plug-in resource from Secondary storage with custom key-value pairs and pre-post commands

Example 7: Restore files/LUNs from Primary storage of Custom plugin resource

 Restore-SmBackup -PluginCode 'DB2' -AppObjectId 'sccorelinux61.sccore.test.com\DB2\RNVOL' -BackupId 313 -Confirm:$false  -path vserver_scauto_primary:/vol/ng_rvol1_sccorelinux61_sccore_test_com/file1,vserver_scauto_primary:/vol/ng_rvol2_sccorelinux61_sccore_test_com/file1

Restoring multiples files from multiple/single volumes can be combined together

Example 8: Restoring to a cluster host

 Restore-SmBackup -PluginCode 'SCO' -AppObjectId 'smo-suse-11g.gdl.englab.netapp.com\itdb' -BackupName 96skdb_smo-suse-11g_02-15-2017_18.11.43.3978_0   -oraclechangestate  -RestoreOnClusterHost 'clusterhost.com'

Restore to a cluster host. This is applicable only for Oracle RAC Database.

Example 9: After restore change the state of tablespaces to online

 Restore-SmBackup -PluginCode 'SCO' -AppObjectId 'scspr0198204001.gdl.englab.netapp.com\itdb' -BackupName rg1_scspr0198204001_02-15-2017_16.53.38.9804_0   -oraclechangestate  -OracleOpenTablespacesAfterRecovery  -OracleTablespaces newts -ForceInplaceRes

After restoring the database, changes the state of the tablespaces to online

Example 10: After restore change the state of PDBS to read write

 Restore-SmBackup -PluginCode 'SCO' -AppObjectId 'smo-suse-11g.gdl.englab.netapp.com\skdb' -BackupName 96skdb_smo-suse-11g_02-16-2017_17.46.09.0207_0  -oraclechangestate   -OraclePluggableDatabases 'SKPDB1','SKPDB2' -OracleOpenPluggableDatabasesAfterRecovery

After restoring the database, changes the state of the PDBS to read write.

Example 11: Restoring from existing files specified in alternate path from a primary

 PS C:\> Restore-SmBackup -PluginCode SCSQL -AppObjectId 'vise-f6\PayrollDatabase' -BackupNam
          e 'NetApp_PayrollDataset_Backup Policy_vise-f6_NetApp_08-07-2015_08.48.59.6962' -AlternatePath @{Source='I:\PayrollDatab
          ase.mdf';Destination='H:\PayrollDatabase_copy_log.mdf'},@{Source='I:\PayrollDatabase_log.ldf';Destination='H:\PayrollDat
          abase_copy_log.ldf'} -SQLInstanceName 'vise-f6\BRAVEHEART' -DatabaseName 'PayrollDatabase_copy' -ExistingFiles

This example syntax restores a backup using existing files specified alternate path

Name: Restore 'vise-f6\PayrollDatabase'
Id  : 203
StartTime   : 8/7/2015 9:30:32 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 12: Restore files/LUNs from Primary storage of Custom plugin resource using All File Restore option

 Restore-SmBackup -PluginCode 'DummyPlugin' -AppObjectId 'scclinux1.scc.test.com\DummyPlugin\RNVOL' -BackupId 313 -Confirm:$false  -AllFileRestorePath vserver_scauto_primary:/vol/ng_rvol1_scclinux1_scc_test_com

All File Restore can be performed on multiple volumes and on multiple Vservers by providing a comma separated list of volume paths from which All File Restore is to be performed

Example 13: Restore files from Primary storage of SAP HANA MultiTenant Database Container resource using All File Restore option

 Restore-SmBackup -PluginCode 'hana' -AppObjectId scspr43002.scc.test.com\hana\R01\R01 -BackupId 313 -Confirm:$false  -AllFileRestorePath vs_test:/vol/cn_p1,vs_test:/vol/cn_p2

All File Restore can be performed on multiple volumes and on multiple Vservers by providing a comma separated list of volume paths from which All File Restore is to be performed

Example 14: Restore files and LUNs from a Primary storage of SAP HANA MultiTenant Database Container resource

 Restore-SmBackup -PluginCode 'hana' -AppObjectId scspr043002.scc.test.com\hana\R01\R01 -BackupId 3 -Confirm:$false  -AllFileRestorePath vs_test:/vol/cn_p1 -Path vs_test:/vol/cn_lun_vol/cn_lun

All File Restore can be performed on multiple volumes and on multiple Vservers by providing a comma separated list of volume paths from which All File Restore is to be performed. Lun path can be provided as a value for Path parameter.

Name: Restore 'scspr043002.scc.test.com\hana\R01\R01'
Id  : 1363
StartTime   : 9/28/2019 10:22:11 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0
JobTypeId   : 1
ApisJobKey  :
ObjectId: 0
PluginCode  : SCC
PluginName  : PluginCreator
HostId  : 0
RoleId  :
JobIds  : {}

Example 15: Restore LUNs from a specific backup of SAP HANA MultiTenant Database Containers resource

 Restore-SmBackup -PluginCode 'hana' -BackupName 'schana02_gdl_englab_netapp_com_hana_MDC_R70_schana02_08-19-2019_21.07.33.2537' -AppObjectId 'schana02.gdl.englab.netapp.com\hana\MDC\R70' -RecoveryType RecoverToSpecificBackup

Restore performed to specific backup on Hana resource.

Name: Restore 'schana02.gdl.englab.netapp.com\hana\MDC\R70'
Id  : 1363
StartTime   : 9/30/2019 12:40:44 PM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0
JobTypeId   : 1
ApisJobKey  :
ObjectId: 0
PluginCode  : SCC
PluginName  : PluginCreator
HostId  : 0
RoleId  :
JobIds  : {}

Example 16: Restore the HANA resource to a specific date or time (Point in time restore)

 Restore-SmBackup -PluginCode 'hana' -AppObjectId 'AutoMTSles253\hana\MDC\MT1' -BackupId '469' -Confirm:$false -recovertimezone 'GMT+05:30' -recoveruntiltime '10/01/19 05:46:21 AM' -recoverytype RecoverUntilDateTime

Restore performed to a specific date or time on a HANA resource.

Name: Restore 'AutoMTSles253\hana\MDC\MT1'
Id  : 1371
StartTime   : 9/30/2019 12:59:42 PM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0
JobTypeId   : 1
ApisJobKey  :
ObjectId: 0
PluginCode  : SCC
PluginName  : PluginCreator
HostId  : 0
RoleId  :
JobIds  : {}

Example 17: Restoring to a custom log directory

 Restore-SmBackup -PluginCode SCSQL -AppObjectId 'RAHUL-123-123\INSTANCE2\db1' BackupName 'RAHUL-123-123_INSTANCE2_db1_SQL-123-123_06-18-2018_15.53.55.4944 -AlternatePath @{Source='F:\New folder\db1.mdf';Destination='C:\rtah\db1.mdf'},@{Source='F:\New folder\db1_log.ldf';Destination='C:\rtah\db1_log.ldf'} -SQLInstanceName 'RX200-WHQL10\INST' -DatabaseName 'DB1_RTAH' -TargetHost 'rx200-whql10.sdwdc.netapp.com' -LogRestoreType All -CustomLogDirectory "\\STAB-VM1\net share" -Archive @{Primary="RAHUL_fs1-smhv:Rahul_scsql";Secondary="RAHUL_fs.1-smhv:RAHUL_fs1_smhv_Rahul_scsql_vault"}

This example syntax specifies a custom log directory when restoring backups.

Name:   : Restore 'RAHUL-123-123\INSTANCE2\db1' to instance 'RX200-WHQL10\INST'
Id  : 48
StartTime   : 6/20/2018 1:31:25 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsVisible   : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0
JobTypeId   : 1
ApisJobKey  :
ObjectId: 0
PluginCode  : SCSQL
PluginName  : SnapCenter Plug-in for Microsoft SQL Server
HostId  : 0
RoleId  :

Example 18: Trigger file system restore without volume based restore

 Restore-SmBackup -BackupName 'vp-hana1_gdl_englab_netapp_com_hana_MDC_N92_vp-hana1_08-20-2019_22.35.52.9698' -PluginCode HANA -AppObjectId 'vp-hana1.gdl.englab.netapp.com\hana\MDC\N92'-RecoveryType SkipRecovery -VolumeRevert

This example syntax supports file system restore without volume based restore.

Name:   : Restore 'vp-hana1.gdl.englab.netapp.com\hana\MDC\N92'
Id  : 77
StartTime   : 6/22/2018 1:55:10 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsVisible   : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0
JobTypeId   : 1
ApisJobKey  :
ObjectId: 0
PluginCode  : SCC
PluginName  : hana
HostId  : 0
RoleId  :

Example 19: Trigger tenant database restore

 Restore-SmBackup -BackupName 'vp-hana1_gdl_englab_netapp_com_hana_MDC_N92_vp-hana1_08-20-2019_22.35.52.9698' -PluginCode HANA -AppObjectId 'vp-hana1.gdl.englab.netapp.com\hana\MDC\N92'-RecoveryType SkipRecovery -TenantDatabaseName N92

This example syntax restores the given tenant database.

Name:   : Restore 'vp-hana1.gdl.englab.netapp.com\hana\MDC\N92'
Id  : 78
StartTime   : 6/23/2019 1:55:10 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsVisible   : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0
JobTypeId   : 1
ApisJobKey  :
ObjectId: 0
PluginCode  : SCC
PluginName  : hana
HostId  : 0
RoleId  :

Example 20: Trigger HANA database restore with all logs

 Restore-SmBackup -PluginCode 'HANA' -AppObjectId 'R708057AFB8V1\hana\MDC\H14' -BackupName 'R708057AFB8V1_hana_MDC_H14_R708057AFB8V1_08-25-2020_03.02.03.7780' -RecoveryType RecoverToMostRecentState -InitializeLogArea

This example syntax restores the given HANA database.

Name: Restore 'R708057AFB8V1\hana\MDC\H14'
Id  : 8025
StartTime   : 8/25/2020 3:49:10 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0
JobTypeId   : 1
ApisJobKey  :
ObjectId: 0
PluginCode  : SCC
PluginName  : PluginCreator
HostId  : 0
RoleId  :
JobIds  : {}

Example 21: Oracle Tablespace point in time recovery (TSPITR)

 Restore-SmBackup -PluginCode SCO -AppObjectId 'SLES11SP4NONE.gdl.englab.netapp.com\PITNASDB' -BackupId 65 -AuxiliaryDestination '/mnt/auxDest'  -OracleTablespaces TS1 -OracleUntilScn 987450

This example syntax performs an Oracle point in time recovery for a tablespace using SCN.

Name: Restore 'SLES11SP4NONE.gdl.englab.netapp.com\PITNASDB'
Id  : 208
StartTime   : 9/11/2020 9:40:12 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 22: Oracle Pluggable database point in time recovery

 Restore-SmBackup -PluginCode SCO -AppObjectId 'SLES11SP4NONE.gdl.englab.netapp.com\PITNASDB' -BackupId 65 -AuxiliaryDestination '/mnt/auxDest' -OraclePluggableDatabases PDBUNQ -OracleUntilScn 987450

This example syntax performs an Oracle point in time recovery for a Pluggable database(PDB) using SCN.

Name: Restore 'SLES11SP4NONE.gdl.englab.netapp.com\PITNASDB'
Id  : 209
StartTime   : 9/11/2020 10:40:12 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 23: Oracle point in time recovery for tablespace of a pluggable database (TSPITR)

 Restore-SmBackup -PluginCode SCO -AppObjectId 'SLES11SP4NONE.gdl.englab.netapp.com\PITNASDB' -BackupId 65 -AuxiliaryDestination '/mnt/auxDest' -OracleTablespaces TS109 -OraclePluggableDatabases PDBUNQ --OracleUntilTime '2020-09-11 20:39:00'

This example syntax performs an Oracle point in time recovery for a tablespace belonging to a pluggable database(PDB) using time.

Name: Restore 'SLES11SP4NONE.gdl.englab.netapp.com\PITNASDB'
Id  : 210
StartTime   : 9/11/2020 10:40:12 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 24: Oracle Tablespace point in time recovery (TSPITR) from secondary

 Restore-SmBackup -PluginCode SCO -AppObjectId 'SLES11SP4NONE.gdl.englab.netapp.com\PITNASDB' -BackupId 65 -AuxiliaryDestination '/mnt/auxDest'  -OracleTablespaces TS23 -OracleUntilScn 987450 -Archive @{Primary="svm1-scc2554-263-264:R706221F756V1_NFS_DB_DB1_DATA";Secondary="hnkn_sec:R706221F756V1_NFS_DB_DB1_DATA_dst"} -LogArchive @{Primary="svm1-scc2554-263-264:R706221F756V1_NFS_DB_DB1_LOG";Secondary="hnkn_sec:R706221F756V1_NFS_DB_DB1_LOG_mirror"}

This example syntax performs an Oracle point in time recovery for a tablespace using SCN from secondary.

Name: Restore 'SLES11SP4NONE.gdl.englab.netapp.com\PITNASDB'
Id  : 232
StartTime   : 9/11/2020 11:40:12 AM
EndTime :
IsCancellable   : False
IsRestartable   : False
IsCompleted : False
IsVisible   : False
IsScheduled : False
PercentageCompleted : 0
Description :
Status  : Queued
Owner   :
Error   :
Priority: None
Tasks   : {}
ParentJobID : 0
EventId : 0

Example 25: Restoring from a primary backup for UnixFileSystems plug-in

 PS C:\> Restore-SmBackup -PluginCode UnixFileSystems -AppObjectId 'linuxfs201.gdl.englab.netapp.com\UnixFileSystems\/netapp/VGNFS1/LVM1' -BackupId 580 -Confirm:$false

This example syntax restores from a primary backup.

			Name: Restore 'linuxfs201.gdl.englab.netapp.com\UnixFileSystems\/netapp/VGNFS1/LVM1'
			Id  : 2772
			StartTime   : 12/12/2023 9:29:34 AM
			EndTime :
			IsCancellable   : False
			IsRestartable   : False
			IsCompleted : False
			IsVisible   : True
			IsScheduled : False
			PercentageCompleted : 0
			Description :
			Status  : Queued
			Owner   :
			Error   :
			Priority: None
			Tasks   : {}
			ParentJobID : 0
			EventId : 0
			JobTypeId   : 1
			ApisJobKey  :
			ObjectId: 0
			PluginCode  : SCC
			PluginName  : PluginCreator
			HostId  : 0
			RoleId  :
			JobIds  : {}
			ScsJobId:

Example 26: Restoring from a secondary backup for UnixFileSystems plug-in

 PS C:\> Restore-SmBackup -PluginCode UnixFileSystems -AppObjectId 'linuxfs201.gdl.englab.netapp.com\UnixFileSystems\/netapp/VGNFS1/LVM1' -BackupId 580 -Confirm:$false -Archive @{Primary="Dest_SVM:vol_source_dest";Secondary="Dest_SVM:vol_source_dest"}

This example syntax restores from a secondary backup.

			Name: Restore 'linuxfs201.gdl.englab.netapp.com\UnixFileSystems\/netapp/VGNFS1/LVM1'
			Id  : 2783
			StartTime   : 12/12/2023 9:58:19 AM
			EndTime :
			IsCancellable   : False
			IsRestartable   : False
			IsCompleted : False
			IsVisible   : True
			IsScheduled : False
			PercentageCompleted : 0
			Description :
			Status  : Queued
			Owner   :
			Error   :
			Priority: None
			Tasks   : {}
			ParentJobID : 0
			EventId : 0
			JobTypeId   : 1
			ApisJobKey  :
			ObjectId: 0
			PluginCode  : SCC
			PluginName  : PluginCreator
			HostId  : 0
			RoleId  :
			JobIds  : {}
			ScsJobId:

Restore-SmBackup

Creating your file...

Syntax

Detailed Description

Parameters

Examples

Example 1: Restoring from a primary backup

Example 2: Restoring to an alternate path from a primary

Example 3: Restoring from a secondary backup

Example 4: Removing a Run As account from a resource

Example 5: Restore complete Resource of Custom plugin DB2 from Primary Storage

Example 6: Restore Complete custom plugin resource from Secondary storage

Example 7: Restore files/LUNs from Primary storage of Custom plugin resource

Example 8: Restoring to a cluster host

Example 9: After restore change the state of tablespaces to online

Example 10: After restore change the state of PDBS to read write

Example 11: Restoring from existing files specified in alternate path from a primary

Example 12: Restore files/LUNs from Primary storage of Custom plugin resource using All File Restore option

Example 13: Restore files from Primary storage of SAP HANA MultiTenant Database Container resource using All File Restore option

Example 14: Restore files and LUNs from a Primary storage of SAP HANA MultiTenant Database Container resource

Example 15: Restore LUNs from a specific backup of SAP HANA MultiTenant Database Containers resource

Example 16: Restore the HANA resource to a specific date or time (Point in time restore)

Example 17: Restoring to a custom log directory

Example 18: Trigger file system restore without volume based restore

Example 19: Trigger tenant database restore

Example 20: Trigger HANA database restore with all logs

Example 21: Oracle Tablespace point in time recovery (TSPITR)

Example 22: Oracle Pluggable database point in time recovery

Example 23: Oracle point in time recovery for tablespace of a pluggable database (TSPITR)

Example 24: Oracle Tablespace point in time recovery (TSPITR) from secondary

Example 25: Restoring from a primary backup for UnixFileSystems plug-in

Example 26: Restoring from a secondary backup for UnixFileSystems plug-in