Public/Export-RubrikDatabase.ps1
|
#Requires -Version 3 function Export-RubrikDatabase { <# .SYNOPSIS Connects to Rubrik exports a database to a MSSQL instance .DESCRIPTION The Export-RubrikDatabase command will request a database export from a Rubrik Cluster to a MSSQL instance .NOTES Written by Pete Milanese for community usage Twitter: @pmilano1 GitHub: pmilano1 Modified by Mike Fal Twitter: @Mike_Fal GitHub: MikeFal .EXAMPLE Export-RubrikDatabase -id MssqlDatabase:::c5ecf3ef-248d-4bb2-8fe1-4d3c820a0e38 -targetInstanceId MssqlInstance:::0085b247-e718-4177-869f-e3ae1f7bb503 -targetDatabaseName ReportServer -finishRecovery -maxDataStreams 4 -timestampMs 1492661627000 .EXAMPLE Export-RubrikDatabase -id $db.id -recoveryDateTime (Get-Date (Get-RubrikDatabase $db).latestRecoveryPoint) -targetInstanceId $db2.instanceId -targetDatabaseName 'BAR_EXP' -targetFilePaths $targetfiles -maxDataStreams 1 Restore the $db (where $db is the outoput of a Get-RubrikDatabase call) to the most recent recovery point for that database. New file paths are in the $targetfiles array. Each individual file declaration (logicalName, exportPath,newFilename) will be a hashtable, so what gets passed to the cmdlet is an array of hashtables $targetfiles = @() $targetfiles += @{logicalName='BAR_1';exportPath='E:\SQLFiles\Data\BAREXP\'} $targetfiles += @{logicalName='BAR_LOG';exportPath='E:\SQLFiles\Log\BAREXP\'} .LINK https://github.com/rubrikinc/PowerShell-Module #> [CmdletBinding(SupportsShouldProcess = $true,ConfirmImpact = 'High')] Param( # Rubrik identifier of database to be exported [Parameter(Mandatory = $true,ValueFromPipelineByPropertyName = $true)] [String]$Id, # Number of parallel streams to copy data [int]$MaxDataStreams, # Recovery Point desired in the form of Epoch with Milliseconds [Parameter(ParameterSetName='Recovery_timestamp')] [int64]$TimestampMs, # Recovery Point desired in the form of DateTime value [Parameter(ParameterSetName='Recovery_DateTime')] [datetime]$RecoveryDateTime, # Recovery Point desired in the form of an LSN (Log Sequence Number) [Parameter(ParameterSetName='Recovery_LSN')] [string]$RecoveryLSN, # Take database out of recovery mode after export [Switch]$FinishRecovery, # Rubrik identifier of MSSQL instance to export to [string]$TargetInstanceId, # Name to give database upon export [string]$TargetDatabaseName, # Rubrik server IP or FQDN [String]$Server = $global:RubrikConnection.server, # API version [String]$api = $global:RubrikConnection.api, #Simple Mode - Data File Path [Alias('DataFilePath')] [string]$TargetDataFilePath, #Simple Mode - Data File Path [Alias('LogFilePath')] [string]$TargetLogFilePath, #Advanced Mode - Array of hash tables for file reloaction. [PSCustomObject[]] $TargetFilePaths ) Begin { # The Begin section is used to perform one-time loads of data necessary to carry out the function's purpose # If a command needs to be run with each iteration or pipeline input, place it in the Process section # Check to ensure that a session to the Rubrik cluster exists and load the needed header data for authentication Test-RubrikConnection #If recoveryDateTime, convert to epoch milliseconds if($recoveryDateTime){ $TimestampMs = ConvertTo-EpochMS -DateTimeValue $RecoveryDateTime } # API data references the name of the function # For convenience, that name is saved here to $function $function = $MyInvocation.MyCommand.Name # Retrieve all of the URI, method, body, query, result, filter, and success details for the API endpoint Write-Verbose -Message "Gather API Data for $function" $resources = Get-RubrikAPIData -endpoint $function Write-Verbose -Message "Load API data for $($resources.Function)" Write-Verbose -Message "Description: $($resources.Description)" } Process { $uri = New-URIString -server $Server -endpoint ($resources.URI) -id $Id $uri = Test-QueryParam -querykeys ($resources.Query.Keys) -parameters ((Get-Command $function).Parameters.Values) -uri $uri #region One-off Write-Verbose -Message "Build the body" $body = @{ $resources.Body.targetInstanceId = $TargetInstanceId $resources.Body.targetDatabaseName = $TargetDatabaseName $resources.Body.finishRecovery = $FinishRecovery.IsPresent recoveryPoint = @() } if($MaxDataStreams){ $body.Add($resources.Body.maxDataStreams,$MaxDataStreams) } if([string]::IsNullOrWhiteSpace($TargetFilePaths) -eq $false){ if($TargetDataFilePath -or $TargetLogFilePath) {Write-Warning 'Use of -TargetFilePaths overrides -TargetDataFilePath and -TargetLogFilePath.'} $body.Add('targetFilePaths',$TargetFilePaths) } else { if($TargetDataFilePath){ $body.Add('targetDataFilePath',$TargetDataFilePath) } if($TargetLogFilePath){ $body.Add('targetLogFilePath',$TargetLogFilePath) } } if($RecoveryLSN){ $body.recoveryPoint += @{lsnPoint=@{lsn=$RecoveryLSN}} } else { $body.recoveryPoint += @{timestampMs = $TimestampMs} } $body = ConvertTo-Json $body -Depth 10 Write-Verbose -Message "Body = $body" #endregion $result = Submit-Request -uri $uri -header $Header -method $($resources.Method) -body $body $result = Test-ReturnFormat -api $api -result $result -location $resources.Result $result = Test-FilterObject -filter ($resources.Filter) -result $result return $result } # End of process } # End of function |