Supported Target Version
Qumulo Core 5.3.1

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
1.1.1
  • Added code support for Get Target Response command for each native type.
  • On demand latest snapshot support and Activity logger changes.
1.1.0Changed the Resource Type from Other to File System for the nativeTypes Qumulo NFS Export and Qumulo SMB Share.
1.0.0Initial resource discovery and monitoring implementations.

Introduction

Qumulo Core is a high-performance file data platform designed to store, manage and create workflows and applications with data in its native file form at a massive scale across hybrid cloud environments. With Qumulo you can easily manage the full data lifecycle from ingestion, transformation, publishing and archiving with cost-effective capacity, dynamic scalability, automatic encryption, real-time analytics and an advanced API that enables customers to easily integrate Qumulo into their technology ecosystem and workflows.

Key Use cases

Discovery Use cases

  • It discovers the Qumulo 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..
  • Concern alerts will be generated for each metric to notify the administrator regarding the issue with the resource

Prerequisites

  • Classic gateway version should be 14.0.0 and above.
  • Nextgen gateway version should be 14.0.0 and above.
  • Use Administrator role user or create a custom role user with observer role privileges as well as the following additional privileges:
  • PRIVILEGE_METRICS_READ
  • PRIVILEGE_ACCESS_TOKENS_WRITE
  • PRIVILEGE_ACCESS_TOKENS_READ Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Hierarchy of Qumulo

          · Qumulo Cluster
                  · Qumulo Node
                        · Qumulo Cluster Disk
                  · Qumulo Quota
                  · Qumulo SMB Share
                  · Qumulo NFS Export

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
Qumulo Clusterqumulo_cluster_fs_capacity_bytesQumulo Cluster Filesystem Capacity BytesBytes1.0.0Qumulo cluster filesystem capacity in bytes
qumulo_cluster_fs_directory_tree_entriesQumulo Cluster Filesystem Directory Tree Entriescount1.0.0Qumulo cluster filesystem directory tree entries
qumulo_cluster_fs_directory_used_bytesQumulo Cluster Filesystem Directory Used BytesBytes1.0.0Qumulo cluster filesystem directory used bytes
qumulo_cluster_fs_free_bytesQumulo Cluster Filesystem Free BytesBytes1.0.0Qumulo cluster filesystem free bytes
qumulo_cluster_fs_snapshotsQumulo Cluster Filesystem Snapshotscount1.0.0Qumulo cluster filesystem snapshots
qumulo_cluster_ldap_operation_errors_TotalQumulo Cluster Ldap Operation Errors Totalcount1.0.0Qumulo cluster Ldap operation total errors
qumulo_cluster_ldap_operation_latency_countQumulo Cluster Ldap Operation Latency Counts1.0.0Qumulo cluster Ldap operation latency count
qumulo_cluster_ldap_operation_latency_SumQumulo Cluster Ldap Operation Latency Sums1.0.0Qumulo cluster Ldap operation latency sum
qumulo_cluster_ldap_operation_latency_BucketQumulo Cluster Ldap Operation Latency Buckets1.0.0Qumulo cluster Ldap operation latency bucket
qumulo_cluster_ldap_operation_referrals_TotalQumulo Cluster Ldap Operation Referrals Totalcount1.0.0Qumulo cluster Ldap operation referrals total
qumulo_cluster_ldap_operations_TotalQumulo Cluster Ldap Operations Totalcount1.0.0Qumulo cluster Ldap total operations
qumulo_cluster_protocol_clientconnectionsTotalQumulo Cluster Protocol Client Connections Totalcount1.0.0Qumulo cluster protocol client connections total
qumulo_cluster_protocol_clientDisconnectionsTotalQumulo Cluster Protocol Client Disconnections Totalcount1.0.0Qumulo cluster protocol client disconnections
qumulo_cluster_protocol_operationbytesTotalQumulo Cluster Protocol Operation Bytes TotalBytes1.0.0Qumulo cluster protocol operation total bytes
qumulo_cluster_protocol_operationlatency_CountQumulo Cluster Protocol Operation Latency Counts1.0.0Qumulo cluster protocol operation latency count
qumulo_cluster_protocol_operationlatency_SumQumulo Cluster Protocol Operation Latency Sums1.0.0Qumulo cluster protocol operation latency sum
qumulo_cluster_protocol_operationlatency_BucketQumulo Cluster Protocol Operation Latency Buckets1.0.0Qumulo cluster protocol operation latency bucket
qumulo_cluster_protocol_operations_readTotalQumulo Cluster Protocol Operations Read Totalcount1.0.0Qumulo cluster protocol operations read total
qumulo_cluster_protocol_operations_writeTotalQumulo Cluster Protocol Operations Write Totalcount1.0.0Qumulo cluster protocol operations write total
Qumulo Nodequmulo_node_StatusQumulo Node Status1.0.0Qumulo node status. Possible values are - online :0 , other :1
qumulo_node_psuStatusQumulo Node PSU Status1.0.0Qumulo node power supply unit status. Possible values are - GOOD :0 , MISSING :1, NO AC :2, UNKNOWN : 3
qumulo_node_cpu_temperatureQumulo Node CPU TemperatureC1.0.0Qumulo node cpu temperature
qumulo_node_memory_correctable_ecc_errors_totalQumulo Node Memory Correctable Ecc Errors Totalcount1.0.0Qumulo node memory correctable Ecc errors
qumulo_node_networkinterface_isDownQumulo Node Network Interface IsDown1.0.0Qumulo node network interface status. Possible values are - 0 : false, 1 : true
qumulo_node_networkinterface_linkSpeedQumulo Node NetworkInterface LinkSpeedbps1.0.0Qumulo node network interface link speed
qumulo_node_networkinterface_receiveerrorsTotalQumulo Node NetworkInterface ReceiveErrors Totalcount1.0.0Qumulo node network interface total receive errors.
qumulo_node_networkinterface_receivedbytesTotalQumulo Node NetworkInterface ReceivedBytes TotalBytes1.0.0Qumulo node network interface total received bytes
qumulo_node_networkinterface_receivedpacketsTotalQumulo Node NetworkInterface ReceivedPackets Totalcount1.0.0Qumulo node network interface total received packets.
qumulo_node_networkinterface_transmiterrorsTotalQumulo Node NetworkInterface TransmitErrors Totalcount1.0.0Qumulo node network interface total transmit errors.
qumulo_node_networkinterface_transmittedbytesTotalQumulo Node NetworkInterface TransmittedBytes TotalBytes1.0.0Qumulo node network interface total transmitted bytes
qumulo_node_networkinterface_transmittedpacketsTotalQumulo Node NetworkInterface TransmittedPackets Totalcount1.0.0Qumulo node network interface total transmitted packets.
Qumulo Cluster Diskqumulo_cluster_disk_StateQumulo Cluster Disk State1.0.0Qumulo cluster disk state. Possible values are - dead : 0, empty :1 , missing : 2, wrong_cluster :3, wrong_node :4, wrong_version : 5, healthy : 6
qumulo_cluster_disk_enduranceQumulo Cluster Disk Endurance1.0.0Qumulo cluster disk endurance.
qumulo_cluster_disk_isUnhealthyQumulo Cluster Disk isUnhealthy1.0.0Qumulo cluster disk health status. Possible values are - 0 : false, 1:true
qumulo_cluster_disk_operationLatencyCountQumulo Cluster Disk Operation Latency Counts1.0.0Qumulo cluster disk operation latency count
qumulo_cluster_disk_operationLatencySumQumulo Cluster Disk Operation Latency Sums1.0.0Qumulo cluster disk operation latency sum
qumulo_cluster_disk_operationLatencyBucketQumulo Cluster Disk Operation Latency Buckets1.0.0Qumulo cluster disk operation latency bucket.
Qumulo Quotaqumulo_quota_capcityUsageQumulo Quota Capacity UsageBytes1.0.0Qumulo quota capacity usage.

Default Monitoring Configurations

Qumulo has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. Users can customize these default monitoring configurations as per their business use cases by cloning respective global templates and global Device Management Policies. OpsRamp recommends doing this activity before installing the app to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for each Native Type of Qumulo. 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: qumulo Qumulo Cluster - 1 (i.e, appName = qumulo , nativeType = Qumulo Cluster , version = 1)

  2. Default Global Templates

    OpsRamp has a Global template for each Native Type of Qumulo. 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: qumulo Qumulo Cluster Template - 1 (i.e, appName = qumulo , nativeType = Qumulo 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: Qumulo Cluster Monitor qumulo Qumulo Cluster 1(i.e, monitorKey = Qumulo Cluster Monitor , appName = qumulo, nativeType = Qumulo Cluster , version = 1)

Configure and Install the Qumulo Integration

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed. Note: If there are no installed applications, it will navigate to the ADD APP 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: You can even search for the application using the search option available. Also you can use the All Categories option to search.
Qumulo
  1. Click ADD in the Qumulo application.
    Note: Select the version from the drop down menu.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned Basic Information:
FunctionalityDescription
NameEnter the name for the configuration.
IP Address/Host Name of Qumulo ResourceIP address/host name of the target.
API PortAPI Port details

Note: By default 443 is displayed.
Qumulo CredentialSelect the Credential from the drop-down list.

(Optional): Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
  • Name: Credential name.
  • Description: Brief description of the credential.
  • User Name: User name.
  • Password: Password.
  • Confirm Password: Confirm password

Notes

  • By default the Is Secure checkbox is selected.
  • Host Name/IP Address and Port should be accessible from Gateway.
  • Select the following:
    • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect the value from the drop down list box.

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).

  1. 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.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:

    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

Qumulo

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.

  1. 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.

  2. Click NEXT.

  3. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

Veeam
  1. Select an existing registered profile.
Veeam
  1. Click FINISH.

The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

View the Qumulo Details

To discover resources for Qumulo.

  1. Navigate to Infrastructure > Search > Servers and VMs > Qumulo.
  2. The Qumulo page is displayed, select the application name.
  3. The RESOURCE page appears from the right.
  4. Click the ellipsis () on the top right and select View details.
  5. Navigate to the Attributes tab to view the discovery details.
Qumulo
  1. Click the Metrics 2.0 tab to view the metric details for Qumulo.
Qumulo

Resource Filter Input keys

Qumulo Resources are filtered and discovered based on below keys:

Click here to view the Supported Input Keys
Resource TypeSupported Input Keys
All TypesresourceName
hostName
aliasName
dnsName
ipAddress
macAddress
os
make
model
serialNumber
Qumulo ClusterBuild Date
Build ID
Version
Qumulo ServerNode ID
Qumulo QuotaLimit
Qumulo SMB ShareDefault Directory Create Mode
Default File Create Mode
Qumulo NFS ExportFileSystem Path
Read Only
Require Privileged Port
User Mapping
Qumulo Cluster DiskDisk Type
Drive Bay
Node ID
Slot
Slot Type

Supported Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alerts based on customisation.

Supported macros keys:

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.mac}

                                ${resource.aliasname}

                                ${resource.os}

                                ${resource.type}

                                ${resource.dnsname}

                                ${resource.alternateip}

                                ${resource.make}

                                ${resource.model}

                                ${resource.serialnumber}

                                ${resource.systemId}

                                ${parent.resource.name}

                                    ${Custom attributes on the resource}

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables “App Failure Notifications” in configuration.
    • Connectivity Exception
    • Authentication Exception
  • Application will send any duplicate/repeat failure alert notification for every 6 hours.
  • Using metrics for monitoring the resources and generating alerts when the threshold values are breached.
  • Application cannot control monitoring pause/resume actions based on above alerts.
  • This application supports only Classic Gateway and NextGen Gateway. Not supported with Cluster Gateway.
  • Component level thresholds can be configured on each resource level.
  • No support of showing activity logs.
  • The Template Applied Time will only be displayed if the collector profile (Classic and NextGen Gateway) is version 18.1.0 or higher.
  • Latest snapshot metric support from Gateway 14.0.0.