Cohesity.PowerShell

1.9.0

Scripts/View/restore-cohesitybackuptoview.ps1

function Restore-CohesityBackupToView {
    <#
        .SYNOPSIS
        Recovers a backup to a view.
        .DESCRIPTION
        Recovers a backup to a view.
        .NOTES
        Published by Cohesity
        .LINK
        https://cohesity.github.io/cohesity-powershell-module/#/README
        .EXAMPLE
        Restore-CohesityBackupToView -ProtectionJobName job-nas -TargetViewName nas-view -QOSPolicy "TestAndDev High"
    #>
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory = $false)]
        # The source name.
        $SourceName=$null,
        [Parameter(Mandatory = $true)]
        # Target view name where the backedup objects gets cloned.
        [String]$TargetViewName,
        [Parameter(Mandatory = $false)]
        [ValidateSet("Backup Target High","Backup Target Low","TestAndDev High","TestAndDev Low","Backup Target SSD","Backup Target Commvault")]
        # QOS policy, one of the following, "Backup Target High","Backup Target Low","TestAndDev High","TestAndDev Low","Backup Target SSD","Backup Target Commvault".
        [String]$QOSPolicy="TestAndDev High",
        [Parameter(Mandatory = $true)]
        # Specifies a protection job name.
        [String]$ProtectionJobName
    )
    Begin {
    }

    Process {
        $random = Get-Date -Format "dddd-MM-dd-yyyy-HH-mm-ss"

        $url = '/irisservices/api/v1/public/restore/objects?search=' + $ProtectionJobName

        $resp = Invoke-RestApi -Method 'Get' -Uri $url
        if ($resp.objectSnapshotInfo.length -eq 0) {
            Write-Output "There are no objects available for restoration, protected by " $ProtectionJobName
            return
        }
        $searchSuccess = $false
        $jobId = $null
        $jobRunId = $null
        $protectionSourceId = $null
        $startedTimeUsecs = $null
        $errorMessage = $null
        foreach ($item in $resp.objectSnapshotInfo) {
            if($item.snapshottedSource.environment -ne "kGenericNas" -AND $item.snapshottedSource.environment -ne "kNetapp" -AND $item.snapshottedSource.environment -ne "kIsilon") {
                $errorMessage = "None of the NAS environment found"
                continue
            }
            if ($item.snapshottedSource.environment -eq "kGenericNas" -AND $item.snapshottedSource.nasProtectionSource.protocol -ne "kNfs3" -AND $item.snapshottedSource.nasProtectionSource.protocol -ne "kCifs1") {
                $errorMessage = "Incompatible protocol for kGenericNas"
                continue
            }

            if($item.jobName -eq $ProtectionJobName -AND $item.versions.length -gt 0) {
                $jobId  = $item.jobId
                $jobRunId = $item.versions[0].jobRunId
                $protectionSourceId = $item.snapshottedSource.id
                $startedTimeUsecs = $item.versions[0].startedTimeUsecs
                if($null -eq $SourceName) {
                    $searchSuccess = $true
                    break
                }
                if ($item.snapshottedSource.name -eq $SourceName) {
                    $searchSuccess = $true
                    break
                }
                $errorMessage = "Source name '$SourceName' not found"
            }
        }
        if($searchSuccess -eq $false) {
            Write-Output "Could not find NAS source, protected by job '$ProtectionJobName', Error : $errorMessage"
            return
        }

        $object = @{
            jobId=$jobId
            jobRunId=$jobRunId
            protectionSourceId=$protectionSourceId
            sourceName=$SourceName
            startedTimeUsecs=$startedTimeUsecs
        }

        $payload = @{
            name="Recover-nas-to-view-"+$random.ToString()
            continueOnError=$true
            objects=@($object)
            type="kMountFileVolume"
            restoreViewParameters=@{
                description="Restore operation for nas backup using powershell cmdlete"
                enableNfsViewDiscovery=$true
                protocolAccess="kAll"
                qos= @{
                    principalName= $QOSPolicy
                }
            }
            viewName=$TargetViewName
        }
        $payloadJson = $payload | ConvertTo-Json
        Write-Output $payloadJson

        $url = '/irisservices/api/v1/public/restore/recover'

        $resp = Invoke-RestApi -Method 'Post' -Uri $url -Body $payloadJson
        if($resp.fullViewName -eq $TargetViewName) {
            Write-Output "Successfully restored from NAS backup to a view, " $TargetViewName
        } else {
            $errorMsg = $resp | ConvertTo-Json
            Write-Output ("Failed to complete the task " + $errorMsg)
        }
    }
    End {
    }
}