Scripts/Restore/restore-cohesityoracledatabase.ps1
|
function Restore-CohesityOracleDatabase { <# .SYNOPSIS From cluster restores the specified Oracle database from a previous backup. .DESCRIPTION From cluster restores the specified Oracle database from a previous backup. .NOTES Published by Cohesity .LINK https://cohesity.github.io/cohesity-powershell-module/#/README .EXAMPLE Restore-CohesityOracleDatabase -SourceName "x.x.x.x" -TargetSourceId 123 -JobId 456 -SourceDatabaseName "database_1" -OracleHome "/u01/app/oracle/product/19c/db_1" -OracleBase "/u01/app/oracle" -DatabaseFileDestination "/u01/app/oracle/product" -NewDatabaseName "database_new" Restore oracle database "database_1" with latest snapshot in specified database file destination in the target oracle source with an id 123 .EXAMPLE Restore-CohesityOracleDatabase -SourceName "x.x.x.x" -TargetSourceId 123 -JobId 456 -SourceDatabaseName "database_1" -OracleHome "/u01/app/oracle/product/19c/db_1" -OracleBase "/u01/app/oracle" -NewDatabaseName "database_new" -JobRunId 789 Restore oracle database "database_1" with mentioned job run id, in the target oracle source with an id 123 .EXAMPLE Restore-CohesityOracleDatabase -SourceName "x.x.x.x" -TargetSourceId 1 -JobId 456 -SourceDatabaseName "database_1" -OracleHome "/u01/app/oracle/product/19c/db_1" -OracleBase "/u01/app/oracle" Restore oracle database "database_1" to an original location .EXAMPLE Restore-CohesityOracleDatabase -SourceName "x.x.x.x" -TargetSourceId 123 -JobId 456 -SourceDatabaseName "database_1" -OracleHome "/u01/app/oracle/product/19c/db_1" -OracleBase "/u01/app/oracle" -NewDatabaseName "database_new" -JobRunId 789 -NumRedoLogGroup 2 -RedoLogSizeInMb 21 -RedoLogMemberPath /u01,/u01/app -RedoLogMemberPrefix "test" -NumTempFiles 5 Restore oracle database "database_1" with mentioned job run id, in the target oracle source with an id 123 with specified redo log group settings #> [CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $True, ConfirmImpact = "High")] Param( [Parameter(Mandatory = $false)] # Specifies the name of the restore task. [string]$TaskName = "Restore-Oracle-Object-" + (Get-Date -Format "dddd-MM-dd-yyyy-HH-mm-ss").ToString(), [Parameter(Mandatory = $true)] # Specifies the source name of the Oracle database to restore. This can be obtained using Get-CohesityProtectionSource -Environments kOracle. [string]$SourceName, [Parameter(Mandatory = $true)] # Specifies a name of the database to recover. [string]$SourceDatabaseName, [Parameter(Mandatory = $true)] # Specifies the Oracle home directory path. [string]$OracleHome, [Parameter(Mandatory = $true)] # Specifies the Oracle base directory path. [string]$OracleBase, [Parameter(Mandatory = $false)] # Location to put the database files(datafiles, logfiles etc.). [string]$DatabaseFileDestination, [Parameter(Mandatory = $true)] # Specifies the id of Oracle source id to restore the database. [long]$TargetSourceId, [Parameter(Mandatory = $true)] [ValidateRange(1, [long]::MaxValue)] # Specifies the job id that backed up this Oracle instance and will be used for this restore. [long]$JobId, [Parameter(Mandatory = $false)] [ValidateRange(1, [long]::MaxValue)] # Specifies the job run id that captured the snapshot for this Oracle instance. If not specified the latest run is used. # This field must be set if restoring to a different target host. [long]$JobRunId, [Parameter(Mandatory = $false)] # Specifies if the tail logs are to be captured before the restore operation. # This is only applicable if restoring the database to its hosting Protection Source and the database is not being renamed. [string]$CaptureTailLogs, [Parameter(Mandatory = $false)] # Specifies a new name for the restored database. [string]$NewDatabaseName, [Parameter(Mandatory = $false)] [ValidateRange(2, [long]::MaxValue)] # Number of redo log groups. [long]$NumRedoLogGroup, [Parameter(Mandatory = $false)] # List of members of this redo log group. [string[]]$RedoLogMemberPath, [Parameter(Mandatory = $false)] # Log member name prefix. [string]$RedoLogMemberPrefix, [Parameter(Mandatory = $false)] [ValidateRange(1, [long]::MaxValue)] # Size of the member in MB. [long]$RedoLogSizeInMb, [Parameter(Mandatory = $false)] [ValidateRange(1, [long]::MaxValue)] # Specifies no. of tempfiles to be used for the recovered database. [long]$NumTempFiles ) Begin { } Process { # Validate provided oracle source $psObject = Get-CohesityProtectionSource -Name $SourceName if ($null -eq $psObject) { write-output ("Source " + $SourceName + " is not available") return } # Collect the oracle source id $SourceId = $psObject.rootNode.id if ($PSCmdlet.ShouldProcess($SourceId)) { # Validate provided protection job $job = Get-CohesityProtectionJob -Ids $JobId if (-not $job) { Write-Output "Cannot proceed, the job id '$JobId' is invalid" return } # Validate provided target oracle source $psTargetObject = Get-CohesityProtectionSource -Id $TargetSourceId if ($psTargetObject.id -ne $TargetSourceId) { Write-Output "Cannot proceed, the target host id '$TargetSourceId' is invalid" return } # Collect the oracle database details required for restore $searchDatabaseDetails = $null $searchURL = '/irisservices/api/v1/searchvms?entityTypes=kOracle&jobIds=' + $JobId + '&vmName=' + $SourceDatabaseName $searchResult = Invoke-RestApi -Method Get -Uri $searchURL if ($Global:CohesityAPIStatus.StatusCode -ne 200) { Write-Output "Could not search oracle database with the job id $JobId" return } $searchDatabaseDetails = $searchResult.vms | Where-Object { ($_.vmDocument.objectAliases -contains $SourceName) } if ($null -eq $searchDatabaseDetails) { write-output "Failed to fetch oracle database details" return } # If snapshot details(JobRunId & StartTime) not provided, then fetch the latest snapshot details of provided job id if (-not $JobRunId -or -not $StartTime) { $snapshotURL = '/irisservices/api/v1/public/restore/objects?search=' + $SourceDatabaseName + '&jobIds=' + $JobId $snapshotResult = Invoke-RestApi -Method Get -Uri $snapshotURL if ($Global:CohesityAPIStatus.StatusCode -ne 200) { Write-Output "Could not search snapshot information for oracle database $SourceDatabaseName" return } if ($snapshotResult -and $snapshotResult.totalCount -ne 0) { $snapshotDetail = $null $snapshotDetail = $snapshotResult.objectSnapshotInfo | Where-Object {$_.SnapshottedSource.ParentId -eq $SourceId -and $_.SnapshottedSource.name -eq $SourceDatabaseName} if ($null -ne $snapshotDetail){ if (-not $JobRunId){ $JobRunId = $snapshotDetail.versions[0].jobRunId $StartTime = $snapshotDetail.versions[0].startedTimeUsecs } if (-not $StartTime){ $versionDetail = $snapshotDetail.versions | Where-Object {$_.jobRunId -eq $JobRunId} if ($null -ne $versionDetail){ $StartTime = $versionDetail.startedTimeUsecs } else { Write-Output "Could not find the snapshot details for the database $SourceDatabaseName with job run id $JobRunId" return } } } else { Write-Output "Could not find the snapshot details for the database $SourceDatabaseName" return } } } $OracleDbConfig = @{ controlFilePathVec = @() enableArchiveLogMode = $True numTempfiles = $NumTempFiles redoLogConf = @{ groupMemberVec = @($RedoLogMemberPath) memberPrefix = $RedoLogMemberPrefix numGroups = $NumRedoLogGroup sizeMb = if ($RedoLogSizeInMb) { $RedoLogSizeInMb } else { 20 } } fraSizeMb = $fraSizeMb } if (-not $NewDatabaseName) { $NewDatabaseName = $SourceDatabaseName } $jobUid = $searchDatabaseDetails.vmDocument.objectId.jobUid $oracleRestoreParams = [PSCustomObject]@{ captureTailLogs = $true } # Required restore parameters for restoring database to alternate location $restoreParams = [PSCustomObject]@{} $alternateLocationParams = $null if (($SourceId -ne $TargetSourceId) -or ($NewDatabaseName -ne $SourceDatabaseName)) { Write-Output "Restoring database '$SourceDatabaseName' to an alternate location." $dbfileDest = if ($DatabaseFileDestination) { $DatabaseFileDestination } else { $OracleHome } $alternateLocationParams = [PSCustomObject]@{} $alternateLocationParams | add-member -type noteproperty -name newDatabaseName -value $NewDatabaseName $alternateLocationParams | add-member -type noteproperty -name homeDir -value $OracleHome $alternateLocationParams | add-member -type noteproperty -name baseDir -value $OracleBase $alternateLocationParams | add-member -type noteproperty -name oracleDbConfig -value $OracleDbConfig $alternateLocationParams | add-member -type noteproperty -name databaseFileDestination -value $dbfileDest $restoreParams | Add-Member -name targetHost -Type NoteProperty -Value @{ id = $TargetSourceId } } else { Write-Output "Restoring database '$SourceDatabaseName' to an original location." } $oracleRestoreParams | Add-Member -Name alternateLocationParams -value $alternateLocationParams -memberType NoteProperty $restoreParams | Add-member -type noteproperty -name oracleRestoreParams -value $oracleRestoreParams $restoreAppObject = [PSCustomObject]@{ appEntity = [PSCustomObject]$searchDatabaseDetails.vmDocument.objectId.entity restoreParams = [PSCustomObject]$restoreParams } # Initialize variable required for restore $ORACLE_OBJECT_RESTORE_TYPE = 19 $payload = [PSCustomObject]@{ action = "kRecoverApp" name = $TaskName restoreAppParams = @{ type = $ORACLE_OBJECT_RESTORE_TYPE ownerRestoreInfo = @{ ownerObject = @{ jobUid = $jobUid jobId = $JobId jobInstanceId = $JobRunId startTimeUsecs = $StartTime entity = @{ id = $SourceId } } ownerRestoreParams = @{ action = "kRecoverVMs" powerStateConfig = @{} } performRestore = $false } restoreAppObjectVec = @($restoreAppObject) } } $url = '/irisservices/api/v1/recoverApplication' $payloadJson = $payload | ConvertTo-Json -Depth 100 $resp = Invoke-RestApi -Method 'Post' -Uri $url -Body $payloadJson if ($Global:CohesityAPIStatus.StatusCode -eq 200) { $taskId = $resp.restoreTask.performRestoreTaskState.base.taskId if ($taskId) { $resp = Get-CohesityRestoreTask -Ids $taskId $errorMsg = "Successfully created restore task " + $taskName } else { $errorMsg = "Failed to create restore task " + $taskName } Write-Output $errorMsg CSLog -Message $errorMsg } else { $errorMsg = $Global:CohesityAPIStatus.ErrorMessage + ", Oracle Object : Failed to recover." Write-Output $errorMsg CSLog -Message $errorMsg } } } End { } } |