RSCReporting

1.1.2

Functions/Mutations/Start-RSCVMwareVMLiveMount.ps1

                                ################################################

# Function - Start-RSCVMwareVMLiveMount - Requests a live mount for an VMware VM 

################################################

Function Start-RSCVMwareVMLiveMount {

<#

.SYNOPSIS

Requests a live mount for a VMware VM using either the targethostID or targetclusterID

.DESCRIPTION

The user has to specify the source VM ID, target VMware host or cluster ID on which to mount, and the target VM name which is the name of the VM to create (make sure it's unique otherwise the mount will fail)

.LINK

GraphQL schema reference: https://rubrikinc.github.io/rubrik-api-documentation/schema/reference

.PARAMETER VMID

The ID of the database to be live mounted, use Get-RSCVMwareVMs to get a valid VMID, can also use the ObjectID of the VM (same thing).

.PARAMETER TargetHostID

The ID of a valid ESXi host to mount the VM database to, use Get-RSCVMwareHosts for a list of all available.

.PARAMETER TargetClusterID

The ID of a valid ESXi host cluster to mount the VM database to, use Get-RSCVMwareClusters for a list of all available. 

.PARAMETER TargetVMName

The name for the VM when mounted on the target host ID, make sure it's unique otherwise the vCenter will fail to mount the database and the job will fail.

.EXAMPLE

Start-RSCVMwareVMLiveMount -VMID "71c0820a-3fbd-5e91-878f-42da723aa371" -TargetHostID "b9aa64d6-5967-5c4c-80aa-938db39857f0" -TargetVMName "DemoLiveMount"

.NOTES

Author: Joshua Stenhouse

Date: 10/23/2023

#>

################################################

# Paramater Config

################################################

[CmdletBinding()]

    Param (

        [Parameter(Mandatory=$true)]

        $VMID,

        [Parameter(Mandatory=$false)]

        $TargetHostID,

        [Parameter(Mandatory=$false)]

        $TargetClusterID,

        [Parameter(Mandatory=$false)]

        [string]$TargetVMName,

        [Parameter(Mandatory=$false)]

        $SnapshotID

    )

################################################

# Importing Module & Running Required Functions

################################################

# Importing module

Import-Module RSCReporting

# Checking connectivity, exiting function with error if not

Test-RSCConnection

# Getting list VMware hosts, clusters and VMs

$VMwareHosts = Get-RSCVMwareHosts

$VMwareClusters = Get-RSCVMwareClusters

$VMwareVMs = Get-RSCVMwareVMs

################################################

# Requesting Live Mount IF Valid Settings

################################################

# Logging

Write-Host "Verifying IDs.."

# Checking VM ID

$VMIDCheck = $VMwareVMs | Where-Object {$_.VMID -eq $VMID} | Select-Object -First 1

IF($VMIDCheck -eq $null){$VMIDCheck = $FALSE}ELSE{$VMIDCheck = $TRUE}

# Getting VM name

$VMName = $VMIDCheck | Select-Object -ExpandProperty VM

# Checking Host ID if not null

$VMHostIDCheck = $VMwareHosts | Where-Object {$_.HostID -eq $TargetHostID}

IF($VMHostIDCheck -eq $null){$VMHostIDCheck = $FALSE}ELSE{$VMHostIDCheck = $TRUE}

# Checking Cluster ID if not null

$VMClusterIDCheck = $VMwareClusters | Where-Object {$_.ClusterID -eq $TargetClusterID}

IF($VMClusterIDCheck -eq $null){$VMClusterIDCheck = $FALSE}ELSE{$VMClusterIDCheck = $TRUE}

# Getting the original VM host ID if both null

IF(($VMHostIDCheck -eq $False) -and ($VMClusterIDCheck -eq $FLASE))

{

$TargetHostID = $VMwareVMs | Where-Object {$_.VMID -eq $VMID} | Select-Object -ExpandProperty VMHostID

IF($TargetHostID -eq $null){$VMHostIDCheck = $FALSE}ELSE{$VMHostIDCheck = $TRUE}

}

# Getting Snapshot ID

IF($SnapshotID -eq $null){$SnapshotID = Get-RSCObjectSnapshots -ObjectID $VMID -MaxSnapshots 1 | Select-Object -ExpandProperty SnapshotID}

IF($SnapshotID -eq $null){$SnapshotIDCheck = $FALSE}ELSE{$SnapshotIDCheck = $TRUE}

# Logging

Write-Host "VMIDCheck: $VMIDCheck

HostIDCheck: $VMHostIDCheck

ClusterIDCheck: $VMClusterIDCheck

SnapshotIDCheck: $SnapshotIDCheck"

# Exiting if any requirements are null, needs a valid VMID, at least a host or cluster, and a valid snapshot ID to work

IF($VMIDCheck -eq $False){Break}

IF(($VMHostIDCheck -eq $False) -and ($VMClusterIDCheck -eq $FLASE)){Break}

IF($SnapshotIDCheck -eq $False){Break}

# Logging

Write-Host "Checks passed. Processing live mount.."

Start-Sleep 2

################################################

# Performing Live Mount

################################################

# Building GraphQL query

$RSCGraphQL = @{"operationName" = "vSphereLiveMountMutation";

"variables" = @{

        "snapshotFid" = "$SnapshotID"

        "snappableId" = "$VMID"

        "keepMacAddresses" = $false

        "powerOn" = $true

        "removeNetworkDevices" = $false

        "shouldRecoverTags" = $false

        "shouldMigrateImmediately" = $false

};

"query" = "mutation vSphereLiveMountMutation(`$snappableId: String!, `$hostId: String, `$clusterId: String, `$resourcePoolId: String, `$snapshotFid: String, `$shouldRecoverTags: Boolean!, `$keepMacAddresses: Boolean!, `$powerOn: Boolean!, `$removeNetworkDevices: Boolean!, `$vmName: String, `$recoveryPoint: DateTime, `$shouldMigrateImmediately: Boolean!) {

  vsphereVmInitiateLiveMountV2(

    input: {id: `$snappableId, config: {hostId: `$hostId, resourcePoolId: `$resourcePoolId, clusterId: `$clusterId, shouldRecoverTags: `$shouldRecoverTags, requiredRecoveryParameters: {snapshotId: `$snapshotFid, recoveryPoint: `$recoveryPoint}, mountExportSnapshotJobCommonOptionsV2: {keepMacAddresses: `$keepMacAddresses, powerOn: `$powerOn, removeNetworkDevices: `$removeNetworkDevices, vmName: `$vmName}, shouldMigrateImmediately: `$shouldMigrateImmediately}}

  ) {

    status

    __typename

  }

}"

}

# Converting to JSON

$RSCJSON = $RSCGraphQL | ConvertTo-Json -Depth 32

# Converting back to PS object for editing of variables

$RSCJSONObject = $RSCJSON | ConvertFrom-Json

# Adding variables specified

IF($TargetVMName -ne $null){$RSCJSONObject.variables | Add-Member -MemberType NoteProperty "vmName" -Value $TargetVMName}

IF($TargetHostID -ne $null){$RSCJSONObject.variables | Add-Member -MemberType NoteProperty "hostId" -Value $TargetHostID}

IF($TargetClusterID -ne $null){$RSCJSONObject.variables | Add-Member -MemberType NoteProperty "clusterId" -Value $TargetClusterID}

# Querying API

Try

{

$RSCResponse = Invoke-RestMethod -Method POST -Uri $RSCGraphqlURL -Body $($RSCGraphQL | ConvertTo-JSON -Depth 20) -Headers $RSCSessionHeader

$RSCRequest = "SUCCESS"

}

Catch

{

$RSCRequest = "FAILED"

}

# $RequestStatus = "FAILED"

# Checking for permission errors

IF($RSCResponse.errors.message){$RequestStatus = $RSCResponse.errors.message}ELSE{$RequestStatus = "Success"}

# Getting response

$JobURL = $RSCResponse.data.vsphereVmInitiateLiveMountV2.links.href

$JobID = $RSCResponse.data.vsphereVmInitiateLiveMountV2.id

################################################

# Returing Job Info

################################################

# Adding To Array

$Object = New-Object PSObject

$Object | Add-Member -MemberType NoteProperty -Name "RSCInstance" -Value $RSCInstance

$Object | Add-Member -MemberType NoteProperty -Name "Mutation" -Value "vSphereLiveMountMutation"

$Object | Add-Member -MemberType NoteProperty -Name "RequestStatus" -Value $RSCRequest

$Object | Add-Member -MemberType NoteProperty -Name "SourceVM" -Value $VMName

$Object | Add-Member -MemberType NoteProperty -Name "SourceVMID" -Value $VMID

$Object | Add-Member -MemberType NoteProperty -Name "TargetVMName" -Value $TargetVMName

$Object | Add-Member -MemberType NoteProperty -Name "TargetHostID" -Value $TargetHostID

$Object | Add-Member -MemberType NoteProperty -Name "TargetClusterID" -Value $TargetClusterID

$Object | Add-Member -MemberType NoteProperty -Name "SnapshotID" -Value $SnapshotID

$Object | Add-Member -MemberType NoteProperty -Name "RequestStatus" -Value $RequestStatus

$Object | Add-Member -MemberType NoteProperty -Name "ErrorMessage" -Value $RSCResponse.errors.message

# Returning array

Return $Object

# End of function

}