Functions/Mutations/Start-RSCOnDemandSnapshot.ps1
|
################################################ # Function - Start-RSCOnDemandSnapshot - Requesting an on demand snapshot of an RSC object ################################################ Function Start-RSCOnDemandSnapshot { <# .SYNOPSIS Requests and on-demand snapshot on the ObjectID and SLADomainID specified, ensure both are valid otherwise the request will fail. If SLADomainID is null will use the SLADomain assigned to the object. .DESCRIPTION Do not use this function for Managed Volumes (non-SLA based), use the dedicated Start/Stop, this function is used for the following object types: Mssql, VmwareVirtualMachine, OracleDatabase, HypervVirtualMachine, NutanixVirtualMachine, WindowsFileset, LinuxFileset, Db2Database, K8Namespace, ExchangeDatabase, AzureNativeVm, AzureNativeVm, Ec2Instance, AwsNativeRdsInstance, SLAManagedVolume. Not supported as of 08/16/2023: Azure SQL & o365 objects. .LINK GraphQL schema reference: https://rubrikinc.github.io/rubrik-api-documentation/schema/reference .PARAMETER ObjectID The RSC object ID (sometimes referred to as ObjectFid on the backend API, always translated to ObjectID in the PowerShell module .PARAMETER SLADomainID The RSC SLADomainID on which to assign the on-demand snapshot to, if none specified, will use the SLA Domain ID assigned to the object. .OUTPUTS Returns an array with the status of the on-demand snapshot request. .EXAMPLE Start-RSCOnDemandSnapshot - ObjectID "0a8f6bc2-dce8-53a8-8e04-6de9293b5a26" -SLADomainID "wwiefjiwjefiwjeifjweofwiefjiwef" This example prompts for the RSC URL, user ID and secret, then connects to RSC and securely stores them for subsequent use in the script directory specified. .NOTES Author: Joshua Stenhouse Date: 08/20/24 #> ################################################ # Paramater Config ################################################ [CmdletBinding()] Param ( [Parameter(ValueFromPipeline=$true)] [array]$PipelineArray, [Parameter(Mandatory=$true)] [string]$ObjectID, [Parameter(Mandatory=$false)] [string]$SLADomainID, [Parameter(Mandatory=$false)] [string]$UserNote, [Parameter(ParameterSetName="User")] [switch]$ForceOracleFull ) ################################################ # Importing Module & Running Required Functions ################################################ # IF piped the object array pulling out the ObjectID needed IF($PipelineArray -ne $null){$ObjectID = $PipelineArray | Select-Object -ExpandProperty ObjectID -First 1} # Importing module Import-Module RSCReporting # Checking connectivity, exiting function with error if not Test-RSCConnection # Validating object ID exists $RSCObjectInfo = Get-RSCObjectDetail -ObjectID $ObjectID # Breaking if not IF($RSCObjectInfo -eq $null) { Write-Error "ERROR: ObjectID specified not found, check and try again.." Break } # Getting SLA Domain ID if not already specified IF($SLADomainID -eq $null) { $SLADomainID = $RSCObjectInfo.SLADomainID $SLADomain = $RSCObjectInfo.SLADomain } ELSE { # Getting all SLA domains to validate SLA domain ID $RSCSLADomains = Get-RSCSLADomains $SLADomainInfo = $RSCSLADomains | Where-Object {$_.SLADomainID -eq $SLADomainID} $SLADomainID = $SLADomainInfo.SLADomainID $SLADomain = $SLADomainInfo.SLADomain } # Breaking if not found IF($SLADomainID -eq $null) { Write-Error "ERROR: SLADomainID specified not found, check and try again.." Break } # Getting object type, as not all objects use the generic on-demand snapshot call $ObjectType = $RSCObjectInfo.Type # IF($OverrideObjecttype -eq $TRUE){$ObjectType = "K8Namespace"} # Getting other useful info $RSCObjectName = $RSCObjectInfo.Object $RSCObjectRubrikCluster = $RSCObjectInfo.RubrikCluster $RSCObjectRubrikClusterID = $RSCObjectInfo.RubrikClusterID # Deciding if to bypass generic on demand snapshot API call as many snappables requires their own mutation $BypassGenericAPI = $FALSE # Mssql IF($ObjectType -eq "Mssql"){$BypassGenericAPI = $TRUE} # VMware IF($ObjectType -eq "VmwareVirtualMachine"){$BypassGenericAPI = $TRUE} # Oracle IF($ObjectType -eq "OracleDatabase"){$BypassGenericAPI = $TRUE} # HyperV IF($ObjectType -eq "HypervVirtualMachine"){$BypassGenericAPI = $TRUE} # NutanixVirtualMachine IF($ObjectType -eq "NutanixVirtualMachine"){$BypassGenericAPI = $TRUE} # WindowsFileset IF($ObjectType -eq "WindowsFileset"){$BypassGenericAPI = $TRUE} # LinuxFileset IF($ObjectType -eq "LinuxFileset"){$BypassGenericAPI = $TRUE} # Db2Database IF($ObjectType -eq "Db2Database"){$BypassGenericAPI = $TRUE} # K8Namespace IF($ObjectType -eq "K8Namespace"){$BypassGenericAPI = $TRUE} # ExchangeDatabase IF($ObjectType -eq "ExchangeDatabase"){$BypassGenericAPI = $TRUE} # AzureNativeVm IF($ObjectType -eq "AzureNativeVm"){$BypassGenericAPI = $TRUE} # AzureNativeVm IF($ObjectType -eq "AzureNativeVm"){$BypassGenericAPI = $TRUE} # Ec2Instance IF($ObjectType -eq "Ec2Instance"){$BypassGenericAPI = $TRUE} # AwsNativeRdsInstance IF($ObjectType -eq "AwsNativeRdsInstance"){$BypassGenericAPI = $TRUE} # ManagedVolume IF($ObjectType -eq "ManagedVolume"){$BypassGenericAPI = $TRUE} ################################################ # Requesting Generic On Demand Snapshot ################################################ # As of 08/16/23 used by the following object types: # GcpNativeGCEInstance IF($BypassGenericAPI -eq $FALSE) { # Building GraphQL query $RSCGraphQL = @{"operationName" = "TakeOnDemandSnapshot"; "variables" = @{ "input" = @{ "slaId" = "$SLADomainID" "workloadIds" = "$ObjectID" } }; "query" = "mutation TakeOnDemandSnapshot(`$input: TakeOnDemandSnapshotInput!) { takeOnDemandSnapshot(input: `$input) { errors { error workloadId } } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} } ################################################ # Requesting VmwareVirtualMachine On Demand Snapshot ################################################ IF($ObjectType -eq "VmwareVirtualMachine") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "TakeVSphereSnapshotMutation"; "variables" = @{ "input" = @{ "id" = "$ObjectID" "config" = @{ "slaId" = "$SLADomainID" } } }; "query" = "mutation TakeVSphereSnapshotMutation(`$input: VsphereOnDemandSnapshotInput!) { vsphereOnDemandSnapshot(input: `$input) { id status } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobID = $RSCResponse.data.vsphereOnDemandSnapshot.id $JobStatus = $RSCResponse.data.vsphereOnDemandSnapshot.status } ################################################ # Requesting HypervVirtualMachine On Demand Snapshot ################################################ IF($ObjectType -eq "HypervVirtualMachine") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "HypervOnDemandSnapshotMutation"; "variables" = @{ "input" = @{ "id" = "$ObjectID" "userNote" = "$UserNote" "config" = @{ "slaId" = "$SLADomainID" } } }; "query" = "mutation HypervOnDemandSnapshotMutation(`$input: HypervOnDemandSnapshotInput!) { hypervOnDemandSnapshot(input: `$input) { status } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobStatus = $RSCResponse.data.hypervOnDemandSnapshot.status } ################################################ # Requesting NutanixVirtualMachine On Demand Snapshot ################################################ IF($ObjectType -eq "NutanixVirtualMachine") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "NutanixAHVSnapshotMutation"; "variables" = @{ "input" = @{ "id" = "$ObjectID" "userNote" = "$UserNote" "config" = @{ "slaId" = "$SLADomainID" } } }; "query" = "mutation NutanixAHVSnapshotMutation(`$input: CreateOnDemandNutanixBackupInput!) { createOnDemandNutanixBackup(input: `$input) { status } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobStatus = $RSCResponse.data.createOnDemandNutanixBackup.status } ################################################ # Requesting WindowsFileset On Demand Snapshot ################################################ IF($ObjectType -eq "WindowsFileset") { # Building GraphQL query - note there's no input in the variable $RSCGraphQL = @{"operationName" = "TakeFilesetSnapshotMutation"; "variables" = @{ "id" = "$ObjectID" "userNote" = "$UserNote" "config" = @{ "slaId" = "$SLADomainID" } }; "query" = "mutation TakeFilesetSnapshotMutation(`$config: BaseOnDemandSnapshotConfigInput!, `$id: String!, `$userNote: String) { createFilesetSnapshot(input: {config: `$config, id: `$id, userNote: `$userNote}) { id status } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobStatus = $RSCResponse.data.createFilesetSnapshot.status } ################################################ # Requesting LinuxFileset On Demand Snapshot ################################################ IF($ObjectType -eq "LinuxFileset") { # Building GraphQL query - note there's no input in the variable $RSCGraphQL = @{"operationName" = "TakeFilesetSnapshotMutation"; "variables" = @{ "id" = "$ObjectID" "userNote" = "$UserNote" "config" = @{ "slaId" = "$SLADomainID" } }; "query" = "mutation TakeFilesetSnapshotMutation(`$config: BaseOnDemandSnapshotConfigInput!, `$id: String!, `$userNote: String) { createFilesetSnapshot(input: {config: `$config, id: `$id, userNote: `$userNote}) { id status } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobStatus = $RSCResponse.data.createFilesetSnapshot.status } ################################################ # Requesting Db2Database On Demand Snapshot ################################################ IF($ObjectType -eq "Db2Database") { # Building GraphQL query - note there's no input in the variable $RSCGraphQL = @{"operationName" = "Db2OnDemandSnapshotMutation"; "variables" = @{ "id" = "$ObjectID" "userNote" = "$UserNote" "config" = @{ "slaId" = "$SLADomainID" } }; "query" = "mutation Db2OnDemandSnapshotMutation(`$id: String!, `$config: BaseOnDemandSnapshotConfigInput!) { createOnDemandDb2Backup(input: {id: `$id, config: `$config}) { id } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobID = $RSCResponse.data.createOnDemandDb2Backup.id } ################################################ # Requesting K8Namespace On Demand Snapshot ################################################ IF($ObjectType -eq "K8Namespace") { # Building GraphQL query - note there's no input in the variable $RSCGraphQL = @{"operationName" = "TakeK8NamespaceSnapshotMutation"; "variables" = @{ "k8sNamespaceSnapshotRequest" = @{ "namespaceId" = "$ObjectID" "onDemandSnapshotSlaId" = "$SLADomainID" } }; "query" = "mutation TakeK8NamespaceSnapshotMutation(`$k8sNamespaceSnapshotRequest: [K8sNamespaceSnapshot!]!) { createK8sNamespaceSnapshots( input: {snapshotInput: `$k8sNamespaceSnapshotRequest} ) { taskchainId jobId } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobID = $RSCResponse.data.createK8sNamespaceSnapshots.taskchainId } ################################################ # Requesting MSSql On Demand Snapshot ################################################ IF($ObjectType -eq "Mssql") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "MssqlTakeOnDemandSnapshotMutation"; "variables" = @{ "input" = @{ "id" = "$ObjectID" "userNote" = "$UserNote" "config" = @{ "baseOnDemandSnapshotConfig" = @{ "slaId" = "$SLADomainID" } } } }; "query" = "mutation MssqlTakeOnDemandSnapshotMutation(`$input: CreateOnDemandMssqlBackupInput!) { createOnDemandMssqlBackup(input: `$input) { links { href } } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response # $JobID = $RSCResponse.data.createOnDemandMssqlBackup.id - Not on the API 08/15/23 # $JobStatus = $RSCResponse.data.createOnDemandMssqlBackup.status - Not on the API 08/15/23 # There is a link, but it returns the link of CDM? So useless... } ################################################ # Requesting OracleDatabase On Demand Snapshot ################################################ IF($ObjectType -eq "OracleDatabase") { # Getting Oracle switch IF($ForceOracleFull){$ForceOracleFull = $TRUE}ELSE{$ForceOracleFull = $FALSE} # Building GraphQL query $RSCGraphQL = @{"operationName" = "TakeOracleDatabaseBackupMutation"; "variables" = @{ "input" = @{ "id" = "$ObjectID" "config" = @{ "forceFullSnapshot" = $ForceOracleFull "baseOnDemandSnapshotConfig" = @{ "slaId" = "$SLADomainID" } } } }; "query" = "mutation TakeOracleDatabaseBackupMutation(`$input: TakeOnDemandOracleDatabaseSnapshotInput!) { takeOnDemandOracleDatabaseSnapshot(input: `$input) { links { href } } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.data.message){$RSCResponse.errors.message} # Getting response # $JobID = $RSCResponse.data.createOnDemandMssqlBackup.id - Not on the API 08/15/23 # $JobStatus = $RSCResponse.data.createOnDemandMssqlBackup.status - Not on the API 08/15/23 # There is a link, but it returns the link of CDM? So useless... } ################################################ # Requesting ExchangeDatabase On Demand Snapshot ################################################ IF($ObjectType -eq "ExchangeDatabase") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "CreateOnDemandExchangeBackupMutation"; "variables" = @{ "input" = @{ "id" = "$ObjectID" "config" = @{ "baseOnDemandSnapshotConfig" = @{ "slaId" = "$SLADomainID" } } } }; "query" = "mutation CreateOnDemandExchangeBackupMutation(`$input: CreateOnDemandExchangeDatabaseBackupInput!) { createOnDemandExchangeBackup(input: `$input) { id } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobID = $RSCResponse.data.createOnDemandExchangeBackup.id } ################################################ # Requesting AzureNativeVm On Demand Snapshot ################################################ IF($ObjectType -eq "AzureNativeVm") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "TakeAzureVMSnapshotMutation"; "variables" = @{ "input" = @{ "virtualMachineRubrikIds" = "$ObjectID" "retentionSlaId" = "$SLADomainID" } }; "query" = "mutation TakeAzureVMSnapshotMutation(`$input: StartCreateAzureNativeVirtualMachineSnapshotsJobInput!) { startCreateAzureNativeVirtualMachineSnapshotsJob(input: `$input) { jobIds { jobId } errors { error } } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobID = $RSCResponse.data.startCreateAzureNativeVirtualMachineSnapshotsJob.jobIds.jobId } ################################################ # Requesting Ec2Instance On Demand Snapshot ################################################ IF($ObjectType -eq "Ec2Instance") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "TakeEC2InstanceSnapshotMutation"; "variables" = @{ "input" = @{ "ec2InstanceIds" = "$ObjectID" "retentionSlaId" = "$SLADomainID" } }; "query" = "mutation TakeEC2InstanceSnapshotMutation(`$input: StartAwsNativeEc2InstanceSnapshotsJobInput!) { startAwsNativeEc2InstanceSnapshotsJob(input: `$input) { jobIds { rubrikObjectId jobId } errors { error } } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobID = $RSCResponse.data.startAwsNativeEc2InstanceSnapshotsJob.jobIds.jobId } ################################################ # Requesting AwsNativeRdsInstance On Demand Snapshot ################################################ IF($ObjectType -eq "AwsNativeRdsInstance") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "TakeRDSInstanceSnapshotMutation"; "variables" = @{ "input" = @{ "rdsInstanceIds" = "$ObjectID" "retentionSlaId" = "$SLADomainID" } }; "query" = "mutation TakeRDSInstanceSnapshotMutation(`$input: StartAwsNativeRdsInstanceSnapshotsJobInput!) { startAwsNativeRdsInstanceSnapshotsJob(input: `$input) { jobIds { rubrikObjectId jobId } errors { error } } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobID = $RSCResponse.data.startAwsNativeRdsInstanceSnapshotsJob.jobIds.jobId } ################################################ # Requesting ManagedVolume On Demand Snapshot ################################################ IF($ObjectType -eq "ManagedVolume") { # Building GraphQL query $RSCGraphQL = @{"operationName" = "SlaManagedVolumeOnDemandSnapshotMutation"; "variables" = @{ "input" = @{ "id" = "$ObjectID" "config" = @{ "retentionConfig" = @{ "slaId" = "$SLADomainID" } } } }; "query" = "mutation SlaManagedVolumeOnDemandSnapshotMutation(`$input: TakeManagedVolumeOnDemandSnapshotInput!) { takeManagedVolumeOnDemandSnapshot(input: `$input) { id } }" } # Querying API $RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader # Checking for permission errors IF($RSCResponse.errors.message){$RSCResponse.errors.message} # Getting response $JobID = $RSCResponse.data.takeManagedVolumeOnDemandSnapshot.id } ################################################ # Returing Job Info ################################################ # Deciding outcome if no error messages IF($RSCResponse.errors.message -eq $null){$RequestStatus = "SUCCESS"}ELSE{$RequestStatus = "FAILED"} # Adding To Array $Object = New-Object PSObject $Object | Add-Member -MemberType NoteProperty -Name "RSCInstance" -Value $RSCInstance $Object | Add-Member -MemberType NoteProperty -Name "RequestStatus" -Value $RequestStatus $Object | Add-Member -MemberType NoteProperty -Name "Object" -Value $RSCObjectName $Object | Add-Member -MemberType NoteProperty -Name "ObjectType" -Value $ObjectType $Object | Add-Member -MemberType NoteProperty -Name "ObjectID" -Value $ObjectID $Object | Add-Member -MemberType NoteProperty -Name "SLADomain" -Value $SLADomain $Object | Add-Member -MemberType NoteProperty -Name "SLADomainID" -Value $SLADomainID $Object | Add-Member -MemberType NoteProperty -Name "RubrikCluster" -Value $RSCObjectRubrikCluster $Object | Add-Member -MemberType NoteProperty -Name "RubrikClusterID" -Value $RSCObjectRubrikClusterID # $Object | Add-Member -MemberType NoteProperty -Name "JobID" -Value $JobID # $Object | Add-Member -MemberType NoteProperty -Name "JobStatus" -Value $JobStatus # $Object | Add-Member -MemberType NoteProperty -Name "JobURL" -Value $JobURL $Object | Add-Member -MemberType NoteProperty -Name "ErrorMessage" -Value $RSCResponse.errors.message # Returning array Return $Object # End of function } |