Supported Versions
Cisco Hyperflex Data Platform: 4.0(2d)
Gateway: 9.0 and above

Cisco HyperFlex integration uses REST APIs to enable hyper-converged infrastructure (HCI) platform components monitoring.

Category: Compute

Step 1: Create a credential

  1. Select a client from the All Clients list.
  2. Go to Setup > Accounts > Clients.
  3. On the client Credentials tab, add the credential information.

Step 2: Configure the integration

  1. From All Clients, select a client.

  2. Go to Setup > Integrations > Integrations.

  3. From Available Integrations, select Compute > Cisco HyperFlex.

  4. Enter:

    PropertyDescription
    NameName for the integration. (required)
    IP addressLocation of the installation. (required)
    CredentialsCredential for the integration. (required)
  5. Click Install.

Step 3: Add a discovery profile

  1. From the Cisco Hyperflex integration, click Add.

  2. Enter:

    PropertyOptionDescription
    Profile details (required)Profile nameName of the profile.
    Host nameName of host.
    Select Management ProfileDrop down list of available management profiles.
    Filter criteria (optional)Smart FiltersAction used to filter resources based on the resources types. All Resources is used to discover all resource types. Virtual Machines is used to discover VMs; deselect if you do not want to discover VMs.
    Resource FiltersAction used to filter resources based on resource attributes.
    Perform actions (optional)Manage DeviceAction used to manage the resource.
    Discovery schedule (optional)Recurrence PatternAction used to schedule the discovery process. Discovery triggers are based on the scheduled time. Newly resources types are automatically discovered and managed.
  3. Click Save. Optionally, scan for the resource with the following steps:

  4. Go to the Discovery Profiles section.

  5. Select the profile.

  6. Click Scan Now.

Supported templates

The gateway is the collector type for the following supported HyperFlex metrics:

NameDescription
HyperflexAlarmTemplateMonitors HyperflexAlarmMonitor metrics
HyperflexClusterEventsTemplateMonitors HyperflexClusterEventsMonitor metrics
HyperflexClusterPerformanceTemplateMonitors HyperflexClusterPerformanceMonitor metrics
HyperflexClusterTemplateMonitors HyperflexClusterMonitor metrics
HyperflexControllerVmTemplateMonitors HyperflexControllerVMMonitor metrics
HyperflexDatastoreTemplateMonitors HyperflexDatastoreMonitor metrics
HyperflexHostPerformanceTemplateMonitors HyperflexHostPerformanceMonitor metrics
HyperflexNodeDiskTemplateMonitors HyperflexNodeDiskMonitor metrics
HyperflexNodeTemplateMonitors HyperflexNodeMonitor metrics
HyperflexVirtualMachineTemplateMonitors HyperflexVirtualMachineMonitor metrics

Event processing

Event data is collected from the configured Hyperflex cluster and posted directly to alerts. The following templates do data collection and post alerts:

  • CI-HyperflexAlarmTemplate
  • CI-HyperflexClusterEventsTemplate

These templates do not have metric graphs or the latest snapshot data.

Next steps

After creating the discovery profile, you can continue with the following actions.

Assign monitoring templates to the resource

  1. Go to Infrastructure > Resources.
  2. From the Cisco HyperFlex resources page, click the resource name and go to the resource details.
  3. Go to Monitors > Template.
  4. From the Templates screen, click +Assign Templates.
  5. From the Apply Templates screen, go to Select Templates > Available templates and select the templates.
  6. Click Assign.

Validation the resource is successfully added

The gateway monitors the application using the assigned templates and displays the results in a graphical format.

To confirm that the device is being monitored, review the following:

  • The graph plotted for each metric in the template.
  • Alerts generated for metrics in the template by giving thresholds.

Supported metrics

ComponentMetric NameMetric Display NameUnits
Hyperflex Clusterhyperflex_cluster_StateHyperflex Cluster State
hyperflex_cluster_SpaceStatusHyperflex Cluster SpaceStatus
hyperflex_cluster_RawCapacityHyperflex Cluster RawCapacityTerabytes (TB)
hyperflex_cluster_TotalCapacityHyperflex Cluster TotalCapacityTerabytes (TB)
hyperflex_cluster_CapacityUtilizationHyperflex Cluster CapacityUtilizationPercentage (%)
hyperflex_cluster_FreeCapacityHyperflex Cluster FreeMemoryTerabytes (TB)
hyperflex_cluster_UsedCapacityHyperflex Cluster UsedMemoryTerabytes (TB)
hyperflex_cluster_TotalSavingsHyperflex Cluster TotalSavingsPercentage (%)
hyperflex_cluster_CompressionSavingsHyperflex Cluster CompressionSavingsPercentage (%)
hyperflex_cluster_DeduplicationSavingsHyperflex DuplicationSavingsPercentage (%)
hyperflex_cluster_ResiliencyStateHyperflex ResilienceState
hyperflex_cluster_PolicyComplianceHyperflex Cluster PolicyCompliance
hyperflex_cluster_alarm_HXA-CLU-0012Hyperflex Alarm HXA CLU 0012
hyperflex_cluster_alarm_HXA-CLU-0016Hyperflex Alarm HXA CLU 0016
hyperflex_cluster_event_HXSSHAccessToggleActionSuccessHyperflex Event HXSshAccessToggleActionSuccess
hyperflex_cluster_event_AlarmTriggeredHyperflex Event AlarmTriggered
hyperflex_cluster_event_NodeUpgradeCompletedEventHyperflex Event NodeUpgradeCompletedEvent
hyperflex_cluster_event_ClusterUpgradeStartedEventHyperflex Event ClusterUpgradeStartedEvent
hyperflex_cluster_event_NodeUpgradeStartedEventHyperflex Event NodeUpgradeStartedEvent
hyperflex_cluster_Stats_Counters_NFSReads_BytesCluster Read ThroughPut
hyperflex_cluster_Stats_Counters_NFSReads_RateCluster Read IOPS
hyperflex_cluster_Stats_Counters_NFSReads_CountCluster Read Latency
hyperflex_cluster_Stats_Counters_NFSWrites_CountCluster Write Latency
hyperflex_cluster_Stats_Counters_NFSWrites_RateCluster Write IOPS
hyperflex_cluster_Stats_Counters_NFSWrites_BytesCluster Write ThroughPut
Hyperflex Nodehyperflex_cluster_node_StateHyperflex Node State
hyperflex_cluster_node_Stats_Counters_NFSReads_BytesHyperflex Host Read ThroughPut
hyperflex_cluster_node_Stats_Counters_NFSReads_RateHyperflex Host Read IOPS
hyperflex_cluster_node_Stats_Counters_NFSReads_CountHyperflex Host Read Latency
hyperflex_cluster_node_Stats_Counters_NFSWrites_CountHyperflex Host Write Latency
hyperflex_cluster_node_Stats_Counters_NFSWrites_RateHyperflex Host Write IOPS
hyperflex_cluster_node_Stats_Counters_NFSWrites_BytesHyperflex Host Write ThroughPut
Node Diskhyperflex_cluster_node_Disk_MediumHyperflex Node Disk Medium
hyperflex_cluster_node_Disk_UsageHyperflex Node Disk Usage
hyperflex_cluster_node_Disk_CapacityHyperflex Node Disk CapacityGigabytes (GB)
hyperflex_cluster_node_Disk_UsedCapacityHyperflex Node Disk UsedCapacityGigabytes (GB)
hyperflex_cluster_node_Disk_FreeCapacityHyperflex Node Disk FreeCapacityGigabytes (GB)
hyperflex_cluster_node_Disk_UtilizationHyperflex Node Disk UtilizationPercentage (%)
hyperflex_cluster_node_Disk_StateHyperflex Node Disk State<
hyperflex_cluster_node_Disk_StatusHyperflex Node Disk Status
hyperflex_cluster_node_Disk_TypeHyperflex Node Disk Type
ControllerVMhyperflex_cluster_node_controller_vm_StateHyperflex Node controllerVM State
hyperflex_cluster_node_controller_vm_Disk_CountHyperflex Node controllerVM Disk CountCount
hyperflex_cluster_node_controller_vm_ConfiguredMemoryHyperflex Node controllerVM memoryBytes
VirtualMachinehyperflex_cluster_virtualmachine_StateHyperflex Virtual Machine State
hyperflex_cluster_virtualmachine_Storage_UsedCapacityHyperflex Virtual Machine UsedCapacityGigabytes (GB)
hyperflex_cluster_virtualmachine_Storage_CapacityHyperflex Virtual Machine Storage CapacityGigabytes (GB)
hyperflex_cluster_virtualmachine_Storage_FreeCapacityHyperflex Virtual Machine FreeCapacityGigabytes (GB)
hyperflex_cluster_virtualmachine_Storage_UtlizationHyperflex Virtual Machine Storage UtilizationPercentage (%)
Datastorehyperflex_cluster_datastore_TotalCapacityHyperflex Datastore TotalCapacityTerabytes (TB)
hyperflex_cluster_datastore_FreeCapacityHyperflex Datastore FreeCapacityTerabytes (TB)
hyperflex_cluster_datastore_UsedCapacityHyperflex Datastore UsedCapacityTerabytes (TB)
hyperflex_cluster_datastore_ProvisionedCapacityHyperflex Datastore ProvisionedCapacityTerabytes (TB)
hyperflex_cluster_datastore_UnCompressedUsedHyperflex Datastore UnCompressedUsedGigabytes (GB)
hyperflex_cluster_datastore_UtlizationHyperflex Datastore UtilizationPercentage (%)
hyperflex_cluster_datastore_MirrorsHyperflex Datastore MirrorsCount
hyperflex_cluster_datastore_Num_of_StripesforLargeFilesHyperflex Datastore NumofStripesForLargeFilesCount
hyperflex_cluster_datastore_DataBlock_SizeHyperflex Datastore DataBlock SizeKilobytes (KB)
hyperflex_cluster_datastore_StatusHyperflex Datastore Status