Cisco HyperFlex Monitoring

Last updated on 17 March, 2023


Cisco HyperFlex is a hyper-converged infrastructure platform. With LogicMonitor’s Cisco HyperFlex package, which leverages the Cisco HyperFlex REST API, you can monitor a large number of HyperFlex operations, as outlined in the LogicModules in Package section of this support article.


LogicMonitor’s Cisco HyperFlex package is compatible with all Cisco HyperFlex products/services that comply with the following prerequisites:

  • At minimum, version 2.5 of the HyperFlex Data Platform is required (LogicMonitor has verified compatibility through version 4.0, but it is likely that later versions are also compatible; contact us if you have any questions about a particular version’s coverage)
  • Valid credentials for HyperFlex Connect
  • HyperFlex Connect or Cluster Management IP address is required

Setup Requirements

Add Devices Into Monitoring

Add your Cisco HyperFlex resources into monitoring if they have not yet been added. For more information on adding resources into monitoring, see Adding Devices.

Assign Properties to Resources

LogicMonitor must be able to provide API credentials in order to successfully access the resource. As such, several custom properties must be set on the Cisco HyperFlex resource within LogicMonitor. For more information on setting properties, see Resource and Instance Properties.

Property Value Required?
esx.user Cisco HyperFlex REST API username Required
esx.pass Cisco HyperFlex REST API password (NOT token) Required
system.categories CiscoHyperFlex Optional. If SNMP is not configured for the Cisco HyperFlex resource, then the value of "CiscoHyperFlex" will need to be manually added to the system.categories property for the resource. If SNMP is configured, this manual entry is not necessary as the addCategory_CiscoHyperFlex PropertySource, which relies on SNMP access, will then be able to automatically assign this value.

Import LogicModules

From the LogicMonitor repository, import all Cisco HyperFlex LogicModules, which are listed in the LogicModules in Package section of this support article. If these LogicModules are already present, ensure you have the most recent versions. Once the LogicModules are imported (assuming all previous setup requirements have been met), data collection will automatically commence.


DataSources will print error messages to the console when present. These errors can be seen in the output when manually polling data (from the Raw Data tab that displays from the Resources page for each DataSource). DataSources are designed to handle errors gracefully and will attempt to grab any available data even when errors occur.

LogicModules in Package

LogicMonitor’s package for Cisco HyperFlex consists of the following LogicModules. For full coverage, please ensure that all of these LogicModules are imported into your LogicMonitor platform.

Display Name Type Description
addCategory_CiscoHyperFlex PropertySource Discovers Cisco HyperFlex hosts and adds a system category of "CiscoHyperFlex". This PropertySource requires SNMP access to perform this function; if SNMP access is not configured for the HyperFlex resource, manually add "CiscoHyperFlex" as a value to the system.categories property, as discussed in the Assign Properties to Resources section of this support article.
Cisco_HyperFlex_Info PropertySource Collects various details of Cisco HyperFlex host metadata.
Cisco HyperFlex Events EventSource Captures Cisco HyperFlex warning, error, and critical events.
Uptime DataSource DataSource provides information regarding Cisco HyperFlex device uptime. Displays uptime/downtime in seconds.
Status DataSource DataSource provides information regarding Cisco HyperFlex device operational and storage platform resiliency status.
Hypervisor Controller VMS DataSource DataSource determines metrics regarding Cisco HyperFlex Hypervisor Controller Virtual Machines. Data includes the state and role of the Virtual Machine as well as the memory and disks available.
Hypervisor VMS DataSource DataSource determines metrics for Cisco HyperFlex Hypervisor Virtual Machines. Data includes the state of the Virtual Machine and the Guest OS, the overall available and consumed storage, and an indicator if the Virtual Machine was created via a template.
Nodes DataSource DataSource monitors relevant metrics for Cisco HyperFlex Nodes. Data includes various node states and a count of disks associated with the node.
Node Performance DataSource Monitors node performance metrics including IOPS, throughput, and latency.
Jobs DataSource Displays each recent job discovered on the Cisco HyperFlex device. Metrics include the job’s status, elapse time, overall step status, and associated categories.
Hypervisor Hosts DataSource Determines the health of Cisco HyperFlex Hypervisor Hosts. Data includes the host status, role, and lockdown mode.
Hypervisor Disks DataSource DataSource displays information regarding Cisco HyperFlex Hypervisor Disks including status, type, and capacity.
Statistics DataSource DataSource provides information regarding Cisco HyperFlex device operational and storage platform resiliency status.
Health DataSource DataSource provides information and data regarding Cisco HyperFlex device health status and ability of the HX storage cluster to tolerate failures.
Events DataSource DataSource provides information regarding Cisco HyperFlex cluster events, including category and severity counts.
Disks DataSource DataSource provides information about all disks in a specific Cluster ID. Monitored data includes the disk type, usage, state, total/used storage, and deny list count.
Details DataSource Reports details associated with this cluster. Information includes the cluster type, zone, number of nodes on or offline, access policy, all-flash, and auto-healing.
Datastores DataSource DataSource collects information on Cisco HyperFlex Datastores including details regarding statuses, accessibility, capacity, and mirrors.
Cluster Performance DataSource Monitors overall cluster performance metrics including IOPS, throughput, and latency
Capability DataSource DataSource provides information regarding cluster encryption and replication support.

When setting static datapoint thresholds on the various metrics tracked by this package, LogicMonitor follows the technology owner’s best practice KPI recommendations. If necessary, we encourage you to adjust these predefined thresholds to meet the unique needs of your environment. For more information on tuning datapoint thresholds, see Tuning Static Thresholds for Datapoints.

In This Article