Rubrik

Application Version and Upgrade Details

Introduction

Rubrik simplifies backup and recovery for hybrid cloud environments. By combining data orchestration, catalog management, and deduplicated storage into a singular software platform, it removes the complexity of legacy backup systems. Enterprises can use Rubrik’s API-first software tool to automate automation and unlock cloud for long-term data retention or disaster recovery. Rubrik supports the top operating systems, databases, hypervisors, clouds, and SaaS apps and was made to be vendor-neutral.

Rubrik assists organizations in maintaining data integrity, provides data availability that withstands challenging circumstances, constantly tracks data risks and threats, and restores businesses with their data when infrastructure is attacked.

Key Use cases

Discovery Use cases

• It discovers the Rubrik Cluster components.
• Publishes relationships between resources to have a topological view and ease of maintenance.

Monitoring Use cases

• Provides metrics related to job scheduling time and status etc,.
• Generates alerts for each metric and notifies administrators about the issue with the resource.

Prerequisites

• OpsRamp Classic Gateway 14.0.0 and above.
• OpsRamp NextGen Gateway 14.0.0 and above.
  Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.
• Provided IpAddress/hostname, credentials should work for Rubrik REST API’s.

Hierarchy of Rubrik resources

  - Rubrik Cluster
         - Rubrik Node
                    - Rubrik Disk

Supported Metrics

Default Monitoring Configurations

Rubrik has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective Global Templates and Global Device Management Policies. OpsRamp recommends performing the below activity before installing the application to avoid noise alerts and data.

1. Default Global Device Management Policies

   OpsRamp has a Global Device Management Policy for each Native Type of Rubrik Cluster. You can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:

   {appName nativeType - version}

   Ex: rubrik Rubrik Cluster - 1 (i.e, appName = rubrik, nativeType =Rubrik Cluster, version = 1)

2. Default Global Templates

   OpsRamp has a Global template for each Native Type of Rubrik Cluster. You can find those templates at Setup > Monitoring > Templates, search with suggested names in global scope. Each template follows below naming convention:

   {appName nativeType 'Template' - version}

   Ex: rubrik StorageGRID Template - 1 (i.e, appName = rubrik , nativeType = Rubrik Cluster, version = 1)

3. Default Global Monitors

   OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:

   {monitorKey appName nativeType - version}

   Ex: Rubrik Cluster Monitor rubrik Rubrik Cluster 1 (i.e, monitorKey = Rubrik Cluster Monitor, appName = rubrik , nativeType = Rubrik Cluster, version= 1)

Configure and Install the Rubrik Integration

1. From All Clients, select a client.
2. Navigate to Setup > Account.
3. Select the Integrations and Apps tab.
4. The Installed Integrations page, where all the installed applications are displayed. If there are no installed applications, it will navigate to the Available Integrations and Apps page.
5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
   Note: Search for the application using the search option available. Alternatively, use the All Categories option to search.

6. Click ADD in the Rubrik application.
7. In the Configuration page, click + ADD. The Add Configuration page appears.
8. Enter the below mentioned BASIC INFORMATION:

Notes:

• By default the Is Secure checkbox is selected.
• Rubrik Cluster IP Address/Host Name and Rubrik REST API Port should be accessible from Gateway.
• Select the following:
  • App Failure Notifications: if enabled,
    • an alert will be sent to the registered gateway resource.
    • an alert is raised for connectivity, authentication exception,
      • Discovery - alert will be on a gateway resource that is registered with the application.
      • Monitoring - alert will be on a particular Powerflex resource.
  • Alert Configuration: enables integrating third party alerts into OpsRamp using further configurations.
• Below are the default values set for:
  • alertSeverity: provides severity alerts that get integrated out of all possible alerts.
    • Default Values: Critical, Warning.
    • Possible Values: Critical, Warning.
  • Alert Severity Mapping: enables you to map the severities between Dell PowerFlex and OpsRamp as severities are predefined values in each system.
    • Possible values of Alert Severity Mapping Filter configuration property are {“Critical”:“Critical”,“Warning”:“Warning”}
      Note: You can change it as per your business use cases at any point in time from the Configuration page.

9. Select the below mentioned Custom Attribute:

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

10. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
11. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
12. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.

13. Click Next.
14. Below are the optional steps you can perform on the Installation page.

• Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

  Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

• Click +ADD to create a new collector by providing a name or use the pre-populated name.

15. Select an existing registered profile.

16. Click FINISH.

The integration is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.

Modify the Configuration

• See Modify an Installed Integration or Application article.

  Note: Select the Rubrik application.

View the Rubrik details

The discovered resource(s) are displayed in Infrastructure > Resources > Server, with Native Resource Type as Rubrik Node. You can navigate to the Attributes tab to view the discovery details, and the Metrics tab to view the metric details for Rubrik Node.

Resource Type Filter Keys

Rubrik application resources are filtered and discovered based on below keys:

Risks and Limitations

Application Failure Notification

• When the user enables App Failure Notifications in the configuration, the application can handle critical and recovery failure notifications for the following cases:

  • Connectivity Exception
  • Authentication Exception

• The application will not send duplicate or repeated failure alert notifications until the existing critical alert has been recovered. This could lead to missing important repeated failure notifications during ongoing issues.

• Alerts are generated based on metrics when predefined thresholds are breached. If thresholds are set incorrectly, users may miss important alerts or be overwhelmed by unnecessary ones.

• The application cannot automatically pause or resume monitoring actions based on the generated alerts, limiting control over how the system reacts to specific failures.

• The application does not support displaying activity logs or applied times, reducing visibility into actions taken or issues logged.

• The application cannot associate a failure event with a corresponding healing event. Consequently, no automatic healing mechanism is available, requiring users to manually resolve alerts in every case.

• The application supports both Classic Gateway and NextGen Gateway environments.

Troubleshooting

Before troubleshooting Rubrik integration issues, ensure that all prerequisites are followed as per the documented setup guidelines. Cross-check the following:

• Confirm that all connectivity and authentication configurations are correct.
• Ensure the required permissions are set on both the OpsRamp platform and the Rubrik environment.
• Verify that the gateway is properly configured to communicate with the Rubrik resources.

If the Rubrik integration fails to discover or monitor resources, follow these troubleshooting steps:

• Inspect if any alerts have been generated on the Rubrik resource, the gateway, or in the vprobe error logs.

• If the alert/error is related to connectivity or authentication, check the reachability of the end device from the gateway:

  • Ping the device using the IP address provided in the configuration:

    ping <IP Address>
    

  • Check connectivity to the specific port using telnet:

    telnet <IP Address> <port>
    

• In some cases, the primary node may switch to another node, requiring an update to the app configuration. Note that when the resource changes to a new node, a new resource is created, and the old metric data may be lost as a result.

Retrieving API or SSH Command Responses from the Gateway Using GCLI Terminal

Follow the steps in the SDK App Debug GCLI Command Requests (Target API / SSH Command) and review if there are any errors.

1. Use the following sample request to prepare the request payload:

   {
     "apiVersion": "debug/v1",
     "module": "Debug",
     "app": "rubrik",
     "action": "Reachability",
     "payload": {
       "RubrikIPAddress": "<IP address or hostname>",
       "protocol": "https",
       "Port": 443,
       "requestPath": "<requestPath mention in the below table>",
       "requestMethod": "GET",
       "username": "<username>",
       "password": "<password>"
     }
   }
   

2. Encode the request payload to Base64 format.
3. Login to gateway console and connect to GCLI terminal using the following command

gcli

4. Execute the command by replacing the with the Base64-encoded request payload generated in Step 2:

  sdkappdebug base64 encoded string 

Refer to the following table for preparing the request payload for REST API :

Native Type	Discovery	Monitoring
Rubrik Cluster	v1/cluster/me	internal/stats/runway_remaining internal/stats/system_storage internal/stats/physical_ingest/time_series internal/cluster/me/system_status v1/job_monitoring/summary_by_job_type?job_monitoring_state=Success v1/job_monitoring/summary_by_job_type?job_monitoring_state=Failure v1/job_monitoring/summary_by_job_type?job_monitoring_state=Canceled v1/job_monitoring/summary_by_job_type?job_monitoring_state=Active v1/host internal/cluster/me/io_stats?range=-5min internal/report?report_type=Canned&report_template=ProtectionTasksDetails
Rubrik Node		internal/cluster/me/node internal/node/{node_id}/io_stats?range=-5min
Rubrik Disk		internal/cluster/me/disk
Event Polling	-	v1/event/latest?order_by_time=desc&before_date={from_date}&after_date={to_date}&event_series_status=Failure

For example, we want to verify the Rubrik REST API response, use the below payload:

{
  "apiVersion": "debug/v1",
  "module": "Debug",
  "app": "rubrik",
  "action": "Reachability",
  "payload": {
    "RubrikIPAddress": "11.22.33.44",
    "protocol": "https",
    "Port": 443,
    "requestPath": "v1/cluster/me",

    "requestMethod" :"GET",

    "username": "<username>",
    "password": "<password>" 

}
}