Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restore Oracle Database with additional parameter. #238

Merged
merged 5 commits into from
Feb 8, 2024
Merged

Restore Oracle Database with additional parameter. #238

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4be23a8
Included additional parameter to add redo log config and temp file co…
KavishreeShanmugam11 Feb 1, 2024
3a1ee4b
with PR changes
KavishreeShanmugam11 Feb 6, 2024
cb90246
Modified restore oracle function to get the latest job run id, if not…
KavishreeShanmugam11 Feb 7, 2024
2a68e42
Updated document for restore oracle commandlet.
KavishreeShanmugam11 Feb 7, 2024
cb0b6d1
With PR changes.
KavishreeShanmugam11 Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
141 changes: 101 additions & 40 deletions src/Cohesity.Powershell/Scripts/Restore/restore-cohesityoracledatabase.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ function Restore-CohesityOracleDatabase {
.LINK
https://cohesity.github.io/cohesity-powershell-module/#/README
.EXAMPLE
Restore-CohesityOracleDatabase -SourceName 10.2.14.31 -TargetSourceId 1277 -JobId 31520 -TargetHostId 770 -NewDatabaseName CohesityDB_r1
Restore Oracle database from cluster with database id 1279 , database instance id 1277 and job id as 31520
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
#>

[CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $True, ConfirmImpact = "High")]
Expand All @@ -30,6 +33,9 @@ function Restore-CohesityOracleDatabase {
[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)]
KavishreeShanmugam11 marked this conversation as resolved.
Show resolved Hide resolved
# Specifies the id of Oracle source id to restore the database.
[long]$TargetSourceId,
Expand All @@ -48,68 +54,121 @@ function Restore-CohesityOracleDatabase {
[string]$CaptureTailLogs,
[Parameter(Mandatory = $false)]
# Specifies a new name for the restored database.
[string]$NewDatabaseName
[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)]
KavishreeShanmugam11 marked this conversation as resolved.
Show resolved Hide resolved
# 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 {
$resp = Get-CohesityProtectionSource -Name $SourceName
if ($resp -eq $null) {
# Validate provided oracle source
$psObject = Get-CohesityProtectionSource -Name $SourceName
if ($null -eq $psObject) {
write-output ("Source " + $SourceName + " is not available")
return
}

write-output $resp | convertto-json -depth 100
write-output $resp.rootNode.id

$SourceId = $resp.rootNode.id
# 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
}

$protectionSourceObject = Get-CohesityProtectionSource -Id $TargetSourceId
if ($protectionSourceObject.id -ne $TargetSourceId) {
# 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
}
$ORACLE_OBJECT_RESTORE_TYPE = 19
$searchedVMDetails = $null

# Collect the oracle database details required for restore
$searchDatabaseDetails = $null
$searchURL = '/irisservices/api/v1/searchvms?entityTypes=kOracle&jobIds=' + $JobId + '&vmName=' + $SourceDatabaseName
Write-Output $searchURL
$searchResult = Invoke-RestApi -Method Get -Uri $searchURL

if ($Global:CohesityAPIStatus.StatusCode -ne 200) {
Write-Output "Could not search Oracle objects with the job id $JobId"
Write-Output "Could not search oracle database with the job id $JobId"
return
}
$searchedVMDetails = $searchResult.vms | Where-Object { ($_.vmDocument.objectAliases -contains $SourceName) }
write-output $searchResult.vms[0].vmDocument.objectAliases
if ($searchedVMDetails -eq $null) {
write-output "Failed to fetch VM details of source"

$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) {
# $runs = Get-CohesityProtectionJobRun -JobId $JobId -ExcludeErrorRuns:$true
KavishreeShanmugam11 marked this conversation as resolved.
Show resolved Hide resolved
# foreach ($run in $runs) {
# if ($run.backupRun.status -eq "kSuccess") {
# $JobRunId = $run.backupRun.jobRunId
# $StartTime = $run.backupRun.stats.startTimeUsecs
# }
# }
$snapshotURL = '/irisservices/api/v1/public/restore/objects?search=' + $SourceDatabaseName + '&jobIds=' + $JobId
$snapshotResult = Invoke-RestApi -Method Get -Uri $snapshotURL

if (-not $JobRunId) {
$runs = Get-CohesityProtectionJobRun -JobId $JobId -ExcludeErrorRuns:$true
foreach ($run in $runs) {
if ($run.backupRun.status -eq "kSuccess") {
$JobRunId = $run.backupRun.jobRunId
$StartTime = $run.backupRun.stats.startTimeUsecs
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}
KavishreeShanmugam11 marked this conversation as resolved.
Show resolved Hide resolved

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 = @()
memberPrefix = "redo"
groupMemberVec = @($RedoLogMemberPath)
memberPrefix = $RedoLogMemberPrefix
numGroups = $NumRedoLogGroup
sizeMb = 20
}
fraSizeMb = $fraSizeMb
Expand All @@ -118,21 +177,22 @@ function Restore-CohesityOracleDatabase {
if (-not $NewDatabaseName) {
$NewDatabaseName = $SourceDatabaseName
}
$jobUid = $searchedVMDetails.vmDocument.objectId.jobUid
write-output $searchedVMDetails
$jobUid = $searchDatabaseDetails.vmDocument.objectId.jobUid

$oracleRestoreParams = [PSCustomObject]@{
captureTailLogs = $true
}
$restoreParams = [PSCustomObject]@{}
$alternateLocationParams = $null
if (($SourceId -ne $TargetSourceId) -or ($NewDatabaseName -ne $SourceDatabaseName)) {
$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 $OracleHome
$alternateLocationParams | add-member -type noteproperty -name databaseFileDestination -value $dbfileDest

#$oracleRestoreParams | Add-Member -Name alternateLocationParams -value $alternateLocationParams -memberType NoteProperty

Expand All @@ -147,20 +207,21 @@ function Restore-CohesityOracleDatabase {

$oracleRestoreParams | Add-Member -Name alternateLocationParams -value $alternateLocationParams -memberType NoteProperty
$restoreParams | add-member -type noteproperty -name oracleRestoreParams -value $oracleRestoreParams
write-output $oracleRestoreParams | ConvertTo-Json -Depth 100

write-output $oracleRestoreParams | ConvertTo-Json -Depth 100
write-output $restoreParams | ConvertTo-Json -Depth 100
write-output (($SourceId -ne $TargetSourceId) -or ($NewDatabaseName -ne $SourceDatabaseName))

# write-output $oracleRestoreParams | ConvertTo-Json -Depth 100
# write-output $restoreParams | ConvertTo-Json -Depth 100
# write-output (($SourceId -ne $TargetSourceId) -or ($NewDatabaseName -ne $SourceDatabaseName))

$restoreAppObject = [PSCustomObject]@{
appEntity = [PSCustomObject]$searchedVMDetails.vmDocument.objectId.entity
appEntity = [PSCustomObject]$searchDatabaseDetails.vmDocument.objectId.entity
restoreParams = [PSCustomObject] $restoreParams

}
write-output $restoreAppObject | ConvertTo-Json -Depth 100
write-output $restoreParams | ConvertTo-Json -Depth 100
# write-output $restoreAppObject | ConvertTo-Json -Depth 100
# write-output $restoreParams | ConvertTo-Json -Depth 100

# Initialize variable required for restore
$ORACLE_OBJECT_RESTORE_TYPE = 19

$payload = [PSCustomObject]@{
action = "kRecoverApp"
Expand Down