All available Rubrik SLA domain names dynamically populated in standard vRA IaaS Request Forms

Anyone familiar with Rubrik? Rubrik Cloud Data Management delivers automated backup, instant recovery, offsite replication, and data archival in a simple, scale out platform built for hybrid cloud. For more information go to https://www.rubrik.com/product/overview/

My current customer is using Rubrik as a backup solution for their vSphere managed virtual machines. They are also using vRealize Automation 7.x as their preferred private cloud solution.

With vRA 7 they automated the deployment of their Windows and Linux virtual servers. As part of their deployment process, they needed an automated integration with Rubrik. They asked me to dynamically populate a drop-down list on a vRA 7 request form with all available SLA domain names from their Rubrik environment. These SLA domain names must be based on actual “live” information. One of the good things about Rubrik, is that it ships with a REST API. This blog reveals how I full-filled my customer use case.

To start the integration with Rubrik into vRealize Automation, I downloaded the latest version of vRealize Orchestrator package for Rubrik. This package is compatible for Rubrik v3.0 API calls. You can download this package from the following location: https://github.com/rubrikinc/vRO-Workflow/releases/tag/3.0.0
Now import this vRO package into your vRO environment. It contains the following workflows and actions, a configuration element and a rubrik logo.
To configure the Rubrik integration into vRealize Orchestrator, you have to run the vRO workflow “Rubrik Add Cluster Instance”. This will add a the Rubrik appliance as a REST Host to the vRO Inventory section and will also store the required Rubrik information in a vRO configuration element.
To address my customer requirements, I needed to create a vRO action that combined a couple of the Rubrik library actions including a slightly modified Rubrik library action. On top of this I needed to remove any input requirements for these vRO actions to simplify the integration into vRealize Automation. The populated vRO configuration element with all the required Rubrik information was very helpful for this challenge.
I created a copy of the Rubrik Library action “rubrikGetSLAID” and named it “rubrikGetAllSLA”. Inside the “rubrikGetAllSLA” action, I stored the values of the required Rubrik configuration element attributes into local variables to feed the inputs of the called out Rubrik Library actions “rubrikGetToken” and “base64Encode_1”. As a result of this, I was able to run the modified Rubrik Library action “rubrikGetSLAID” which returns an array of strings containing the available Rubrik SLA domain names.

The contents of the vRO action “rubrikGetAllSLA” is shown below.

// Read Attribute Values from Rubrik configurationElement
var category = Server.getConfigurationElementCategoryWithPath("Library/Rubrik");
var elements = category.configurationElements;
 
System.log("category : "+category);
System.log("elements : "+elements);
 
for each(var ce in elements)
{
if(ce.name == "Rubrik")
                {
                               rubrikHost = ce.getAttributeWithKey("rubrikHost").value;
                               api_url = ce.getAttributeWithKey("api_url").value;
                               query_limit = ce.getAttributeWithKey("query_limit").value;
                               username = ce.getAttributeWithKey("username").value;
                               password = ce.getAttributeWithKey("password").value;
                }
}
 
// Re-used vRO Action rubrikGetToken from package com.rubrik.library.rest.package
token = System.getModule("com.rubrik.library.rest").rubrikGetToken(rubrikHost,username,password,query_limit,api_url) ;
// Re-used vRO Action base64Encode_1 from package com.rubrik.library.rest.package
tokenBase64 = System.getModule("com.rubrik.library.rest").base64Encode_1(token) ;
 
// Modified vRO Action rubrikGetSLAID from package com.rubrik.library.rest.package
//
// NAME             - TYPE                - DESCRIPTION
// ----------------------------------------------------
// <INPUT PARAMETERS>
// tokenBase64      - string              - Rubrik authentication token
// rubrikHost       - REST:REST Host      - Rubrik REST host
// slaDomainName    - string              - SLA Domain Name
// query_limit                   - number                                              - Query limit
// api_url                                            - string                                   - API URL
//
// <RETURN VALUE>
// N/A              - string              - SLA Domain ID
 
//Construct REST call
var method = "GET";
var url = api_url + "sla_domain?limit=" + query_limit;
var content = null;
var request = rubrikHost.createRequest(method, url, content);
var token2 = ("Basic " + tokenBase64);
request.contentType = "application\/json";
request.setHeader("Accept", "application/json");
request.setHeader("Authorization", token2);
 
//Log REST Call Info
System.log("token = " + token2);
System.log("REST URL = " + request.fullUrl);
System.log("REST Content = " + content);
 
//Execute REST Call
try {
                var response = request.execute();
}
catch (ex) {
                System.error("REST call failed");
                throw "Stopping Execution";
}
 
//Evaluate REST Response
var statusCode = response.statusCode;
if (statusCode == 200) {
                System.log("REST Execution Successful");
}
else {
                System.log("ERROR Executing REST operation");
                System.error("Status Code = " + statusCode);
                throw "Stopping Execution";
}
 
//Loop Through SLA Domains to populate array with all available SLA Domains
var json = (JSON.parse(response.contentAsString)).data;
var slaDomainNames = Array();
 
for(var i = 0; i < json.length; i++) {
                var obj = json[i];
                System.log("slaDomainName = "+obj.name);
                slaDomainNames.push(obj.name);
}
 
return slaDomainNames;

// Read Attribute Values from Rubrik configurationElement

var category = Server.getConfigurationElementCategoryWithPath("Library/Rubrik");

var elements = category.configurationElements;

System.log("category : "+category);

System.log("elements : "+elements);

for each(var ce in elements)

{

if(ce.name == "Rubrik")

{

rubrikHost = ce.getAttributeWithKey("rubrikHost").value;

api_url = ce.getAttributeWithKey("api_url").value;

query_limit = ce.getAttributeWithKey("query_limit").value;

username = ce.getAttributeWithKey("username").value;

password = ce.getAttributeWithKey("password").value;

}

// Re-used vRO Action rubrikGetToken from package com.rubrik.library.rest.package

token = System.getModule("com.rubrik.library.rest").rubrikGetToken(rubrikHost,username,password,query_limit,api_url) ;

// Re-used vRO Action base64Encode_1 from package com.rubrik.library.rest.package

tokenBase64 = System.getModule("com.rubrik.library.rest").base64Encode_1(token) ;

// Modified vRO Action rubrikGetSLAID from package com.rubrik.library.rest.package

// NAME - TYPE - DESCRIPTION

// ----------------------------------------------------

// <INPUT PARAMETERS>

// tokenBase64 - string - Rubrik authentication token

// rubrikHost - REST:REST Host - Rubrik REST host

// slaDomainName - string - SLA Domain Name

// query_limit - number - Query limit

// api_url - string - API URL

// <RETURN VALUE>

// N/A - string - SLA Domain ID

//Construct REST call

var method = "GET";

var url = api_url + "sla_domain?limit=" + query_limit;

var content = null;

var request = rubrikHost.createRequest(method, url, content);

var token2 = ("Basic " + tokenBase64);

request.contentType = "application\/json";

request.setHeader("Accept", "application/json");

request.setHeader("Authorization", token2);

//Log REST Call Info

System.log("token = " + token2);

System.log("REST URL = " + request.fullUrl);

System.log("REST Content = " + content);

//Execute REST Call

try {

var response = request.execute();

}

catch (ex) {

System.error("REST call failed");

throw "Stopping Execution";

}

//Evaluate REST Response

var statusCode = response.statusCode;

if (statusCode == 200) {

System.log("REST Execution Successful");

}

else {

System.log("ERROR Executing REST operation");

System.error("Status Code = " + statusCode);

throw "Stopping Execution";

}

//Loop Through SLA Domains to populate array with all available SLA Domains

var json = (JSON.parse(response.contentAsString)).data;

var slaDomainNames = Array();

for(var i = 0; i < json.length; i++) {

var obj = json[i];

System.log("slaDomainName = "+obj.name);

slaDomainNames.push(obj.name);

}

return slaDomainNames;

The result of the vRO action “rubrikGetAllSLA” is shown below.
To dynamically populate a drop-down list in a vRA 7 standard IaaS request form with all available Rubrik SLA domain names, I needed to create a custom property with the name “Vm.RubrikSLADomain” on the standard IaaS blueprints for the Windows and Linux deployments. Secondly I needed to create a vRA property definition based on an external value, which is in fact the vRO action that I created before. Below is my example of this vRA property definition.
Finally, when I request a new virtual machine with vRealize Automation 7.x, it looks like the screenshot below. (The below example is based on a deployment for a Linux virtual machine).
Enjoy using vRA, vRO and Rubrik 😉