Supported Target Versions
Validated on VMware 6.0.0, 6.5.0, 7.0.0, and 8.0.0

Note: Not all Metrics are supported,
see VMware Recommended templates for more details.

Introduction

VMware is a virtualization and cloud computing software that distributes the work of a given virtual server across multiple physical hosts. VMware also enables each physical host to run multiple virtual server instances.

Prerequisites

  • Dell RecoverPoint for Virtual Machines (RP4VM) should integrated with vSphere

  • vCenter read-only access is necessary for resource identification and monitoring.

    • The bare minimum role must have the checkbox for Propagate to children enabled and be Read-Only.

      Steps for vCenter user creation with required discovery and monitoring permissions.
      1. Go to Menu and select Administration.
      NetApp Solidfire
      1. Under Single Sign On, click Users and Groups.
      2. Select the required domain from the Domain list box and click Add User.
      NetApp Solidfire
      1. Enter the required details and click Add.
      NetApp Solidfire
      1. Under Groups, select a group from the Group Name and add members by clicking ADD MEMBERS.
        Note: Click ADD GROUP to add a new group.
      NetApp Solidfire
      NetApp Solidfire
      1. Search for the user in the Add Member and click SAVE.
      NetApp Solidfire
      1. Under Access Control, click Global Permissions.
      NetApp Solidfire
      1. Select the user and click +.
      NetApp Solidfire
      1. Search for the user and select the role from the Role list.
      NetApp Solidfire
      1. Select Propagate to children checkbox and click OK.
      NetApp Solidfire

      Note: Username of the vCenter is <name of the user>@<domain name>

  • For vCenter appliance monitoring:

    • Apply SSH credentials to the vCenter server.

    • Users must have the appropriate privilege to execute commands on the vCenter appliance command prompt. For example, the privilege to execute commands such as shell and help api list.

      Steps to create SSH user for appliance monitoring.
      1. Once a user with the super administrator role successfully logged into vCenter using ssh.
        Note: The default user with a super administrator role is root.

      2. Create a local user account for the vCenter appliance, i.e., admin or super admin using the command localaccounts.user.add --role (admin/superadmin) --username(test) --password,.
        Example: localaccounts.user.add --role admin --username TestUser --password

      3. When prompted, enter and verify the new local user’s password.

      NetApp Solidfire
      1. To set appliance shell as the default shell run chsh -s /bin/appliancesh <new-username> in the vCenter.
        Enter below two commands
        shell
        Note: if the above command does not work we recomment using
        bash
      2. Exit the shell first, then the vCenter appliance.
      NetApp Solidfire
      1. Login to the created new user role with ssh and we can execute the command service-control --status will work in the new user role directly.
      NetApp Solidfire

      See Create a Local User Account in the vCenter Server Appliance and Enable Access to the VCSA Bash shell or Appliance Shell for more information.

  • For ESXi hardware metrics, enable CIM APIs and open port 5989 on individual ESXi servers and use the template VMware ESXi Hardware Status for monitoring.

  • The user accounts configured for VMware integration must have privileges to access CIM APIs. Configure CIM and CIM Interaction permissions to access the host hardware metrics. Refer to Host CIM Privileges in the VMware documentation.

  • Enable default port 443 on vCenter.

    Steps to assign CIM permissions to users. 1. vCenter User should have Host CIM and CIM interaction privileges.
    2. Click Menu and then select Administration.
    3. In the Administration section, click Roles.
    4. Select the role assigned to the user.
    5. On the right-hand side of the screen, click Privileges.
    6. Check to see if the privileges listed are the ones that should be assigned to the user.
      
    NetApp Solidfire
    1. Alternatively, grant the rights by taking the following actions:

      • Click Edit role action and select the provider.
      NetApp Solidfire
      • On the Edit Role page, check box the CIM and CIM interaction.
      • Click NEXT.
      NetApp Solidfire
    2. The VMware Host should have the CIM Service functioning.

      NetApp Solidfire
    3. Enable gateway IPAddress access to 5989,5988 port.

      NetApp Solidfire
    4. CIM Secure Server and CIM Server services should be in running state.

      NetApp Solidfire
    5. Able to telnet from the gateway to 5989 port.
      For example: telnet <vmware-host-IP> 5989
      Notes:

      • If you assign CIM privileges to vCenter Account then it will allow you to perform host hardware monitoring or else create and assign.
      • CIM credentials on each host Steps to assign CIM permissions to vCenter Account (yet to work).

Classic Gateway

  • Allow port 443 between (vCenter or ESXi host) and OpsRamp Gateway
  • Allow port 5989 between (vCenter or ESXi host) and OpsRamp Gateway for CIM based monitoring

NextGen Gateway

  • Allow port 443 between (vCenter or ESXi host) and (nodes, load balancers)
  • Allow port 5989 between (vCenter or ESXi host) and (nodes, load balancers) for CIM based monitoring

Hierarchy of vCentre

Compute

  — Compute
    — Datacenter
      — Cluster
        — Host
          — Virtual Machine

Storage

  — Storage
    — Datastore

Install the 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.
  6. Search for the application using the search option available. Alternatively, use the All Categories option to search.
NetApp Solidfire
  1. Click ADD on the VMware.
  2. The Configuration page is displayed, enter the below information:
    • Name: Configuration name.
    • IP Address: IP Address of the vCenter.
    • CredentialSet: You can select a credential from the list or add a credential.
      Note: To add a credential:
      • Click + ADD available in the CredentialSet dropdown. The ADD CREDENTIAL page is displayed. Enter the following information:
        • Name: Credential name.
        • Description: Brief description of the credential.
        • User Name: User name. If you use a domain account to access vCenter, specify the domain with the username in the format <name of the user>@<domain name>.
        • Password: Password of the vCenter
        • Confirm Password: Confirm password
        • Port: Port of the vCenter. Set 443 for a secure connection.
        • Secure: Select the Secure checkbox for encryption.
        • Connection Timeout (ms): Timeout in milliseconds.
      • Click ADD to add the credential to the credential list.
NetApp Solidfire
  • vCenter Plug-ins Configurations: Enable the vSAN or VxRail check box and enter VxRail manager IP Address.
    Note:
    • For VxRail Components discovery and monitoring, Virtual Machine Discovery is mandatory.
    • For vSAN components discovery and monitoring, VMware Cluster discovery is Mandatory.
  1. Event Schedule: Enable the Event Schedule checkbox.
    Notes:
    • Event Schedule option is displayed if and only if Discovery Schedule option is enabled.
    • VMware Inventory begins when following events are identified at Vcenter: VmClonedEvent, VmDeployedEvent, VmCreatedEvent, VmRemovedEvent, VmRestartedOnAlternateHostEvent, VmRelocatedEvent, VmMigratedEvent, DrsVmMigratedEvent.
  2. FILTER BY RESOURCE TAG: Click Any or All of the rules below to match any one or all of the conditions you define for filtering.
  3. Enter/select the values in the Key, Operator, and Value fields for filtering the resources.
  4. FILTER BY RESOURCE TYPE:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  5. PERFORM ACTION: Select the Manage Device checkbox, if you want the discovered devices to be managed.
  6. Discovery Schedule: Discovery is triggered based on the scheduled time. New resources added to the environment are automatically discovered. Choose one of the following Recurrence Patterns:
    • Hourly
    • Daily
    • Weekly
    • Monthly
    • None (On-demand discovery)
  7. Click NEXT.
NetApp Solidfire
  1. In the Installation page, select an existing registered gateway profile, and click FINISH.
    Note: The selected gateway should be up and running.
NetApp Solidfire
  1. The VMware integration is installed and displayed on the INSTALLED INTEGRATIONS page.

View VMware details

The discovered resource(s) are displayed in Infrastructure > Resources >VMware, with Native Resource Type as VMWareHost. You can navigate to the Attributes tab to view the discovery details.

NetApp Solidfire

Assign Monitoring templates to the resource

  1. Go to Infrastructure > Resources > VMware.
  2. On the Resources page of VMware, click resource name > resource Details > Monitors > Template.
  3. On the Templates screen, click +Assign Templates.
NetApp Solidfire
  1. In the Apply Templates section, AssignTemplates > Available templates, select the templates and click the > button.
  2. Click Assign. The Templates screen displays the selected templates.
NetApp Solidfire

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

While applying a template to a resource, you can customize the default configuration parameters applied to that template.

Configuration ParameterDescription
Connection Time-outMaximum time to connect to the application. The driver waits for the specified time before timing out due to connection failure. The default time is 10000 milliseconds(ms).
VMware API PortPort number where VMware is running. The connection is made to the specified port if you specify the port and the resource name. The default port is 443.
VMware Events Include SecurityEvents triggered from gateway to cloud while applying a vCenter event template. The different events available are:
  • info
  • warning
  • error
  • user

To confirm the monitoring of VMware resource, review the following:

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

The Metrics tab to view the metric details for VMware.

NetApp Solidfire

The recommended templates for VMware in each entity level

EntityTemplateMetric NameVMware Supported VersionGateway Supported VersionDescription
vCenterVMware vCenter Performance - v5vmware.vcResources.physicalmemusage.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Physical memory used by vCenter.
vmware.vcenter.disk.freeCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of free capacity in the vCenter.
vmware.vcenter.disk.usedCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of used capacity of the hosts in the vCenter.
vmware.vcenter.api.service.respons-time6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0VMware vCenter API service response time.
vmware.vcenter.disk.capacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of the capacity of the hosts in the vCenter.
vmware.vcResources.systemcpuusage.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Total system CPU used on the system where vCenter Server is running.
vmware.vcenter.disk.usedCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of used capacity in the vCenter.
vmware.vcenter.disk.freeCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of the free capacity of the hosts in the vCenter.
VMware vCenter Appliance Performance - v2com.vmware.appliance.version1.resources.system.stats.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance System Stats.
com.vmware.appliance.version1.resources.system.health.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance System Health State.
com.vmware.appliance.version1.resources.mem.health.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance Memory Health State.
com.vmware.appliance.version1.resources.mem.stats.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance Memory Stats.
com.vmware.appliance.version1.resources.load.stats.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance Load Stats.
com.vmware.appliance.version1.resources.storage.health.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance Storage Health State.
com.vmware.appliance.version1.networking.interfaces.list6.0.0, 6.5.0, and 7.0.014.1.0It will monitor the VMWare vCenter Appliance Network Interfaces Status, It will work with gateway 12.0.0 or above.
com.vmware.appliance.version1.resources.load.health.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance Load Health State.
com.vmware.appliance.version1.resources.swap.health.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance Swap Health State.
com.vmware.appliance.version1.resources.softwarepackages.health.get6.0.0, 6.5.0, and 7.0.014.1.0VMware vCenter Appliance SoftwarePackages Health State.
Gateway - VMware vCenter Appliance Service Statusvmware_vcenter_appliance_service_Status6.0.0, 6.5.0, and 7.0.014.1.0Monitors VMware vCenter appliance Service(s) status. Service Running: Graph Value - 0, Alert Severity - Ok Service Stopped: Graph Value - 2, Alert Severity - Critical Service Unknown: Reasons for unknown could be any of these: 1. The service could be changing from running to stopped or stopped to running 2. Service name could be invalid.
Gateway - VMware VCenter Appliance Service Status - v2com.vmware.appliance.version1.service.status6.0.0, 6.5.0, and 7.0.014.1.0Monitors VMware vCenter Service(s) status. It collects service status information by executing this command "service-control --status" from appliance shell.
Gateway - VMware vCenter Appliance Certificates Expiry - v2vmware_vcenter_appliance_certificates_expiry_inDays6.0.0, 6.5.0, and 7.0.014.1.0It monitors VMware vCenter appliance certificates expiry in days.
ClusterVMware Cluster Performance - v6vmware.cluster.disk.capacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of Maximum capacity of the datastores.
vmware.cluster.status.availability6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0General health of the cluster.
vmware.clusterServices.effectivecpu.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Total available CPU resources of all hosts within a cluster.
vmware.cluster.disk.freeCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of free capacity in the cluster.
vmware.vmop.numSVMotion.latest6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Number of migrations with Storage vMotion (datastore change operations for powered-on VMs).
vmware.cluster.mem.utilization6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Amount of host machine memory used by all powered on virtual machines in the cluster.
vmware.cluster.mem.capacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Total amount of machine memory of all hosts in the cluster that is available for virtual machine memory (physical memory for use by the Guest OS) and virtual machine overhead memory.
vmware.cpu.totalmhz.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Total number of CPU resources of all hosts in the clusterThe maximum value is equal to the frequency of the processors multiplied by the number of cores.
vmware.cluster.cpu.capacity.ghz6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0VMware Cluster CPU Capacity in GHz.
vmware.cluster.disk.usedCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of used capacity of the datastores.
vmware.vmop.numVMotion.latest6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Number of migrations with vMotion (host change operations for powered-on VMs).
vmware.clusterServices.effectivemem.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Cluster services effective mem average.
vmware.cluster.disk.freeCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of available space of the datastores.
vmware.cluster.disk.usedCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of used capacity in the cluster.
Virtual MachineVMware VirtualMachine Performance - v7vmware.vm.power.state6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0This metric defines the power state for a virtual machine. The possible metrics values are, poweredOff(0), poweredOn(1), suspended(2)
vmware.mem.usage.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of physical memory that has been consumed by the Virtual Machine.
vmware.vm.status.availability6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0This metric shows the state of connectivity i.e,whether the server(ESXi/VCenter) has access to the virtual machine or not. The possible metric values are, 1-Connected, 0-disconnected, inaccessible, invalid, orphaned
vmware.disk.write.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Average number of kilobytes written to disk each second during the collection interval.
vmware.cpu.ready.summation6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Time the virtual machine is ready to run, but is not running because it has reached its maximum CPU limit setting.
vmware.cpu.usage.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0CPU usage as a percentage during the interval.
vmware.cpu.capacity.demand.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0The amount of CPU resources a virtual machine would use if there were no CPU contention or CPU limit.
vmware.vm.disk.usedSpaceInPercentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Used space of each disk in the virtual machine in percentage.
vmware.mem.entitlement.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Amount of host physical memory the virtual machine is entitled to, as determined by the ESX scheduler.
vmware.virtualDisk.numberReadAveraged.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Average number of read commands issued per second to the virtual disk during the collection interval.
vmware.disk.read.average6.0.0, 6.5.0, and 7.0.014.1.0Average number of kilobytes read from the disk each second during the collection interval.
vmware.vm.disk.usedCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Total storage space, committed to this virtual machine across all datastores.
vmware.mem.active.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Amount of guest “physical” memory actively used in VM.
vmware.cpu.entitlement.latest6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Amount of CPU resources allocated to the virtual machine based on the total cluster capacity and the resource configuration (reservations, shares, and limits) of the resource hierarchy.
vmware.datastore.totalWriteLatency.average6.0.0, 6.5.0, and 7.0.014.1.0Datastore Write latency.
vmware.cpu.ready.summation.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0It displays the CPU ready summation in percentage.
vmware.net.transmitted.average6.0.0, 6.5.0, and 7.0.014.1.0Average rate at which data was transmitted during the interval.
vmware.vm.disk.freeCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Additional storage space, in bytes, potentially used by this virtual machine on all datastores.
vmware.cpu.latency.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percent of time the virtual machine is unable to run because it is contending for access to the physical CPU(s).
vmware.vm.disk.freeCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0It displays the available disk space of Virtual Machine in percentage.
vmware.virtualDisk.totalWriteLatency.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0The average time a write to the virtual disk takes.
vmware.virtualDisk.numberWriteAveraged.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Average number of write commands issued per second to the virtual disk during the collection interval.
vmware.cpu.maxlimited.summation6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Time the virtual machine is ready to run, but is not running because it has reached its maximum CPU limit setting.
vmware.vm.disk.usedCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0The percentage of total storage space,committed to this virtual machine across all datastores.
vmware.vm.disk.capacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Additional storage space, in bytes, potentially used by this virtual machine on all datastores.
vmware.mem.granted.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Amount of host physical memory or physical memory that is mapped for a virtual machine or a host.
vmware.virtualDisk.totalReadLatency.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0The average time a read from the virtual disk takes.
vmware.mem.latency.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of time the virtual machine is waiting to access swapped or compressed memory.
vmware.disk.numberRead.summation6.0.0, 6.5.0, and 7.0.014.1.0Number of disk reads during the collection interval.
vmware.datastore.totalReadLatency.average6.0.0, 6.5.0, and 7.0.014.1.0Average amount of time for a read operation from the datastore.
vmware.vm.cpu.demandToEntitlementRatio6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0CPU resource entitlement to CPU demand ratio (in percents).
vmware.net.usage.average6.0.0, 6.5.0, and 7.0.014.1.0Network utilization (combined transmit-rates and receive-rates) during the interval.
vmware.disk.numberWrite.summation6.0.0, 6.5.0, and 7.0.014.1.0Number of disk writes during the collection interval.
vmware.cpu.costop.summation6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Time the virtual machine is ready to run, but is unable to run due to co-scheduling constraints.
vmware.net.received.average6.0.0, 6.5.0, and 7.0.014.1.0Average rate at which data was received during the interval. This represents the bandwidth of the network. VM: The rate at which data is received across the virtual machine's vNIC (virtual network interface controller). Host: The rate at which data is received across each physical NIC instance on the host.
HostSystemVMware Host Performance - v6vmware.host.status.availability6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0General health of the host.
vmware.datastore.totalReadLatency.average6.0.0, 6.5.0, and 7.0.014.1.0Average amount of time for a read operation from the datastore.
vmware.mem.usage.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of physical memory that has been consumed by the host.
vmware.disk.usage.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Average data I/O rate across all virtual disks on the host.
vmware.disk.write.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Average number of kilobytes written to disk each second during the collection interval.
vmware.host.disk.freeCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of free capacity in the host.
vmware.cpu.ready.summation6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Time the virtual machine is ready to run, but is not running because it has reached its maximum CPU limit setting.
vmware.vm.poweroff.count6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Count of number of VMs powered off on a host.
vmware.vm.suspended.count6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Count of number of VMs suspended on a host.
vmware.datastore.datastoreIops.average6.0.0, 6.5.0, and 7.0.014.1.0Storage I/O Control aggregate IOPS.
vmware.host.cpu.capacity.ghz6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of the MHz for all the individual cores on the host.
vmware.net.usage.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Network utilization (combined transmit-rates and receive-rates) during the interval.
vmware.disk.numberRead.summation6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Number of disk reads during the collection interval.
vmware.cpu.usage.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0CPU usage as a percentage during the interval.
vmware.host.mem.capacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Total amount of physical memory on the host in bytes.
vmware.host.disk.usedCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of used capacity of the datastores.
vmware.vm.poweron.count6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Count of number of VMs powered on.
vmware.host.cpu.utilization.ghz6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Aggregated CPU usage across all cores on the host in GHz. This is only available if the host is connected.
vmware.host.disk.capacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of the capacity of the datastores.
vmware.datastore.maxTotalLatency.latest6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Highest latency value across all datastores used by the host.
vmware.cpu.ready.summation.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0It displays the CPU ready summation in percentage.
vmware.datastore.totalWriteLatency.average6.0.0, 6.5.0, and 7.0.014.1.0Average amount of time for a write operation from the datastore.
vmware.host.disk.usedCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Percentage of used capacity in the host.
vmware.host.mem.utilization6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Physical memory usage on the host in GB. This is only available if the host is connected.
vmware.host.disk.freeCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Sum of free capacity of the datastores.
vmware.disk.read.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Average number of kilobytes read from the disk each second during the collection interval.
vmware.disk.numberWrite.summation6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0VMware disk number write summation.
VMware Host Hardware Health Status - v3vmware.host.hardware.battery-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Battery Health Status.
vmware.host.hardware.memory-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Memory Health Status.
vmware.host.hardware.power-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Power Health Status.
vmware.host.hardware.temperature-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Temperature Health Status.
vmware.host.hardware.other.health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Other Health Status.
vmware.host.hardware.system-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware System Health Status.
vmware.host.hardware.processor-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Processor Health Status.
vmware.host.hardware.storage-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Storage Health Status.
vmware.host.hardware.watchdog-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Watchdog Health Status.
vmware.host.hardware.fan-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Fan Health Status.
vmware.host.hardware.voltage-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Voltage Health Status.
vmware.host.hardware.cableinterconnect-health.status6.0.0, 6.5.0, and 7.0.014.1.0Host Hardware Cable InterConnect Health Status.
DatastoreVMware Datastore Performance - v5vmware.datastore.numberReadAveraged.average6.0.0, 6.5.0, and 7.0.014.1.0Average number of read commands issued per second to the datastore during the collection interval.
vmware.disk.provisioned.latest6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Amount of storage set aside for use by a datastore or a virtual machine.
vmware.datastore.disk.capacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Maximum capacity of the datastore.
vmware.disk.used.latest6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Amount of space actually used by the virtual machine or the datastore.
vmware.datastore.disk.usedCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Used capacity of the datastore.
vmware.datastore.numberWriteAveraged.average6.0.0, 6.5.0, and 7.0.014.1.0Average number of write commands issued per second to the datastore during the collection interval.
vmware.datastore.disk.usedCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0The percentage of used capacity of the datastore.
vmware.disk.capacity.latest6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Configured size of the datastore.
vmware.datastore.disk.freeCapacity6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Available space of the datastore.
vmware.datastore.disk.freeCapacity.percentage6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0The percentage of available space of the datastore.
vmware.datastore.status.availability6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0VMware Datastore Status Availability.
VMware DataStore - Disk Performance - v2vmware.disk.numberWriteAveraged.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Average number of write commands issued per second to the datastore during the collection interval.
vvmware.disk.numberReadAveraged.average6.0.0, 6.5.0, 7.0.0, and 8.0.014.1.0Average number of read commands issued per second to the datastore during the collection interval.

VMware Alarms Document

Create custom alarm metrics

  1. Navigate to Setup > Monitoring > Events.
  2. Click +Add at the right top corner.
  3. For Adapter Type, select VMware.
  4. In the name field, the metric name should be added as below:
  • For user defined alarms, the sysname is null. In that case, we should add a metric name in the format below:
    • Format: “vmware_vcenter_alarm_”+alarmName
      Note: alarmName should not have any spaces.
    • Example:If a user defined an alarm with name “memory Limit Alarm”.
    • Then the metric name should be created like “vmware_vcenter_alarm_memoryLimitAlarm”.

Key Use Case

We have recently updated the VMware events and alarms to provide comprehensive details on how these alarms and events are generated. Below outlines the current design for events and alarms:

Retrieving all alarms and events on vCenter

When an alarm or event template is assigned to vCenter, all alerts pertaining to vCenter, Data Centers, DataStores, Hosts, and VMs are mapped to the vCenter.

Configuration parameters

Configuration ParameterDescription
vmware.vcenter.alarm.policyIf "vmware.vcenter.alarm.policy" is set to "all," OpsRamp will currently monitor all alarms.

If "vmware.vcenter.alarm.policy" is set to "include", it will only track the alarms that are used as metrics.

Note:
  • The default value of this parameter is set as “include”.
  • When the parameter is set to "all" , the metric names will be with dotted notation in the alerts
  • When customer changes the parameter from “all” to “include”. If an alarm is previously alerted with dotted notation metric in the “all” option and again it is present in the include list with under score notation, a new alert with underscore metric will be generated and the old alarm created with dotted notation will not heal.the customer should suppress them manually
  • When customer changes the parameter from “include” to “all”. If an alarm is previously alerted with underscore notation metric in the “include” option. When the customer changes the parameter from “include” to “all” , The alarm will be alerted again with dotted notation and the old alert with underscore metric will not heal.the customer should suppress them manually
vmware.vcenter.alarm.exclude.entity.listIf an alert's severity type is added to the "vmware.vcenter.alarm.exclude.entity.list" configuration parameter in comma-separated format, our tool will skip that alarm type.

Possible values of this parameter are:

VirtualMachine,Template, Datacenter, Folder, HostSystem, VirtualApp, ResourcePool, ComputeResource, ClusterComputeResource, DistributedVirtualSwitch, DistributedVirtualPortgroup, Datastore, Network, StoragePod, Datacenters.
vmware.vcenter.alarm.exclude.severity.listIf a specific severity type is supplied in comma separated format to the "vmware.vcenter.alarm.exclude.severity.list" configuration parameter, our tool will skip alerts with that severity.
vmware.vcenter.alarm.receive.child.alarmsOnly after applying the template to the vCenter Entity are child alarms monitored.

If “vmware.vcenter.alarm.receive.child.alarms” config param value is set to “no” then our tool will not process the child alarms and this parameter is applicable for vCenter entity only.

Note: The default value of this parameter is “yes”.
vmware.alarms.regex.matchWhen a regular expression is given as input to the "vmware.alarms.regex.match" pattern, the alarm will be processed if its alarm name or sys name matches the regular expression.

Here, the "vmware.vcenter.alarm.policy" should be set to "all".

Note: The default value of this parameter is set as "None".

Deprecated Parameters

The following two configuration options are being deprecated starting with the 14.1.0 gateway version:

  • Vmware.vcenter.process.native.alarms
  • Vmware.vcenter.process.thirdparty.alarms

Supported alarms

Currently OpsRamp supports the below alarms

Metric NameDescription
vmware.vcenter.alarm.ApplmgmtHealthAlarmMonitors the health status of the Appliance Management Service.
vmware.vcenter.alarm.BatteryHealthAlarmMonitors the battery status of hosts.
vmware.vcenter.alarm.BMCHealthAlarmMonitors the status of the Baseboard Management Controller.
vmware.vcenter.alarm.CertificateStatusAlarmMonitors the certificate status of an ESXi host.
vmware.vcenter.alarm.ComponentMgrHealthAlarmMonitors Component Manager Service Health
vmware.vcenter.alarm.ConsistencyGroupViolationDatastore cluster has datastores that belong to different SRM consistency groups.
vmware.vcenter.alarm.ContentLibraryServiceHealthAlarmMonitors the health status of the VMware Content Library Service.
vmware.vcenter.alarm.DatastoreDiskUsageAlarmMonitors datastore disk usage.
vmware.vcenter.alarm.DatastoreInMultipleDatacentersMonitors whether a datastore in a datastore cluster is visible in more than one data center.
vmware.vcenter.alarm.DatastoreStorageComplianceAlarmMonitors whether the virtual disk on the datastore complies with the object-based storage.
vmware.vcenter.alarm.DBHealthAlarm
vmware.vcenter.alarm.DSHealthAlarmMonitors the health status of the Data Service.
vmware.vcenter.alarm.EAMHealthAlarmMonitors the health status of the ESX Agent Manager.
vmware.vcenter.alarm.ExitStandbyErrorAlarmMonitors whether a host cannot exit standby mode.
vmware.vcenter.alarm.FailoverFailedAlarm
vmware.vcenter.alarm.FanHealthAlarmMonitors host fans.
vmware.vcenter.alarm.HAcannotFindMasterMonitors whether vCenter Server is able to connect to a vSphere High Availability master agent.
vmware.vcenter.alarm.HAfailoverFailedMonitors the failover progress of vSphere High Availability.
vmware.vcenter.alarm.HAfailoverInProgressMonitors the failover progress of vSphere High Availability.
vmware.vcenter.alarm.HAhostStatusMonitors the host health status reported by vSphere High Availability.
vmware.vcenter.alarm.HAinsufficientFailoverResourcesMonitors the sufficiency of failover cluster resources required for vSphere High Availability.
vmware.vcenter.alarm.HardwareSensorStateChange
vmware.vcenter.alarm.HAvmMonitoringActionMonitors whether vSphere High Availability has restarted a virtual machine.
vmware.vcenter.alarm.HAvmMonitoringErrorMonitors whether vSphere High Availability failed to reset a virtual machine.
vmware.vcenter.alarm.HealthStatusChangedAlarmMonitors changes to service and extension health status.
vmware.vcenter.alarm.HostCertManagementModeChangedAlarmMonitors changes in the certificate management mode of vCenter Server.
vmware.vcenter.alarm.HostCertStatusAlarmMonitors the certificate status of an ESXi host.
vmware.vcenter.alarm.HostConnectionStateAlarmMonitors the power state of the host and whether the host is reachable.
vmware.vcenter.alarm.HostConnectivityAlarmMonitors host connectivity to a storage device.
vmware.vcenter.alarm.HostCPUUsageAlarmMonitors host CPU usage.
vmware.vcenter.alarm.HostErrorAlarmMonitors host error and warning events.
vmware.vcenter.alarm.HostEsxCosSwapAlarmMonitors host service console memory swap rates.
vmware.vcenter.alarm.HostIpConflictAlarm
vmware.vcenter.alarm.HostLicenseEditionNotAllowedMonitors the compatibility of the vCenter Server and host license editions.
vmware.vcenter.alarm.HostMemoryUsageAlarmMonitors host memory usage.
vmware.vcenter.alarm.HostRequiresEncryptionModeEnabledAlarm
vmware.vcenter.alarm.HostVendorProviderRegistrationAlarmDefault alarm that monitors whether the registration or unregistration of a VASA vendor provider on a vSAN host fails.
vmware.vcenter.alarm.IdentityHealthAlarmMonitors the health status of the Identity Management Service.
vmware.vcenter.alarm.ImageBuilderHealthAlarm
vmware.vcenter.alarm.InventoryHealthAlarmMonitors the health status of the Inventory Service.
vmware.vcenter.alarm.IoFilterHostVendorProviderRegistrationAlarmDefault alarm that monitors whether vCenter Server fails to register or unregister third-party IO filter storage providers on a host.
vmware.vcenter.alarm.IoFilterManagementOperationAlarmvSphere APIs for IO Filtering (VAIO) Filter Management Operations.
vmware.vcenter.alarm.IormNonVIWorkloadAlarmMonitors the unmanaged I/O workload on a SIOC-enabled datastore.
vmware.vcenter.alarm.KMSClientCertificateStatusAlarm
vmware.vcenter.alarm.KMSServerCertificateStatusAlarm
vmware.vcenter.alarm.LicenseCapacityExceededAlarmMonitors whether a license capacity is exceeded.
vmware.vcenter.alarm.LicenseErrorMonitors license errors.
vmware.vcenter.alarm.LicenseExpiredHostMonitors the expiry of host license.
vmware.vcenter.alarm.LicenseExpiredVcMonitors vCenter Server license expiry.
vmware.vcenter.alarm.LicenseHealthAlarmMonitors the health status of the License Service.
vmware.vcenter.alarm.LicenseNonComplianceAlarmMonitors the license inventory for compliance.
vmware.vcenter.alarm.LicenseUserThresholdExceededAlarmMonitors whether a user-defined license threshold is exceeded.
vmware.vcenter.alarm.LunCapabilityAlarmMonitors the change in the capability status for volumes backing the datastore.
vmware.vcenter.alarm.MemoryHealthAlarmMonitors host memory usage.
vmware.vcenter.alarm.MigrateBindToVMKAlarmMonitors incorrectly configured VMkernel NICs.
vmware.vcenter.alarm.MigrationErrorAlarmMonitors whether a virtual machine cannot be migrated or relocated, or is orphaned.
vmware.vcenter.alarm.MsgBusHealthAlarmMonitors the health status of the Message Bus Configuration Service.
vmware.vcenter.alarm.NetdumperHealthAlarmMonitors the health status of the VMware vSphere ESXi Dump Collector Service.
vmware.vcenter.alarm.NetworkConnectivityLostAlarmMonitors the network connectivity on a virtual switch.
vmware.vcenter.alarm.NetworkRedundancyDegradedAlarmMonitors network uplink redundancy degradation on a virtual switch.
vmware.vcenter.alarm.NetworkRedundancyLostAlarmMonitors network uplink redundancy on a virtual switch.
vmware.vcenter.alarm.OtherHealthAlarmMonitors other host hardware objects.
vmware.vcenter.alarm.PerfchartsHealthAlarmMonitors the health status of the Performance Charts Service.
vmware.vcenter.alarm.PowerHealthAlarmMonitors the host power status.
vmware.vcenter.alarm.ProcessorHealthAlarmMonitors the host processors.
vmware.vcenter.alarm.RBDHealthAlarmMonitors the health status of the vSphere Auto Deploy Waiter.
vmware.vcenter.alarm.SELHealthAlarmMonitors the capacity of the IPMI system event log.
vmware.vcenter.alarm.ServiceControlAgentHealthAlarmMonitors the health status of the VMware Service Control Agent.
vmware.vcenter.alarm.SpsHealthAlarmMonitors the health status of the VMware vSphere Profile-Driven Storage Service.
vmware.vcenter.alarm.StatsmonitorHealthAlarm
vmware.vcenter.alarm.StorageConnectivityAlarmMonitors host connectivity to a storage device.
vmware.vcenter.alarm.StorageHealthAlarmMonitors host connectivity to storage devices.
vmware.vcenter.alarm.StoragePodOutOfSpaceMonitors whether a datastore cluster runs out of disk space.
vmware.vcenter.alarm.StoragePodSDRSNotSupportedHostMonitors and alerts when Storage DRS is not supported on a host.
vmware.vcenter.alarm.StoragePodSDRSRecommendation
vmware.vcenter.alarm.StoragePodSDSRecommendationMonitor Storage DRS recommendations.
vmware.vcenter.alarm.SubscriptionLicenseExpiredHostMonitors the expiry of host time-limited license.
vmware.vcenter.alarm.SubscriptionLicenseExpiredVcMonitors vCenter Server time-limited license expiry.
vmware.vcenter.alarm.SubscriptionLicenseExpiredVsanMonitors the expiry of the vSAN license and the end of the evaluation period.
vmware.vcenter.alarm.SystemBoardHealthAlarmMonitors the status of host system boards.
vmware.vcenter.alarm.TemperatureHealthAlarmMonitors the temperature status of the host hardware.
vmware.vcenter.alarm.ThinProvisionedLunAlarmMonitors whether the thin provisioning threshold on the storage array exceeds for volumes backing the datastore.
vmware.vcenter.alarm.TsHealthAlarmMonitors the health status of the VMware Transfer Service.
vmware.vcenter.alarm.UpdateMgrHealthAlarm
vmware.vcenter.alarm.VapiEndpointHealthAlarmMonitors the health status of the VMware vAPI Endpoint Service.
vmware.vcenter.alarm.VasaProviderCertificateExpiryAlarmMonitors whether VASA provider certificates are getting close to their expiry date.
vmware.vcenter.alarm.VasaProviderDisconnectedAlarmMonitors the changes in the connection state of VASA providers.
vmware.vcenter.alarm.VasaProviderObjectAlarmIt tracks vCenter Object Type Storage Alarm.
vmware.vcenter.alarm.VasaProviderRefreshCACertsAndCRLsFailureAlarmMonitors whether the refreshing of CA certificates and CRLs for some of the VASA providers has failed.
vmware.vcenter.alarm.VchaHealthAlarm
vmware.vcenter.alarm.VCHAHealthAlarm
vmware.vcenter.alarm.VCServerHealthAlarmMonitors the health status of vCenter Server.
vmware.vcenter.alarm.VdcsHealthAlarmMonitors Open Virtualization Format Service Health.
vmware.vcenter.alarm.VdsHCMTUMatchAlarmMonitors changes in vSphere Distributed Switch MTU matched status.
vmware.vcenter.alarm.VdsHCMTUSupportedAlarmMonitors changes in vSphere Distributed Switch MTU supported status.
vmware.vcenter.alarm.VdsHCTeamingMatchAlarmMonitors changes in vSphere Distributed Switch teaming matched status.
vmware.vcenter.alarm.VdsHCVlanTrunkedAlarmMonitors changes in vSphere Distributed Switch VLAN trunked status.
vmware.vcenter.alarm.VFlashResourceHealthAlarmMonitors the Flash Read Cache resource status on the host.
vmware.vcenter.alarm.VFlashResourceUsageAlarmMonitors the Flash Read Cache resource usage on the host.
vmware.vcenter.alarm.VmAdapterResvervationStatusMonitors changes in the reservation status of a virtual machine network adapter.
vmware.vcenter.alarm.VmcpTerminateVmAbortedMonitors whether vSphere High Availability VM Component Protection cannot power off a virtual machine with an inaccessible datastore.
vmware.vcenter.alarm.VmCPUUsageAlarmMonitors virtual machine CPU usage.
vmware.vcenter.alarm.VmCryptoStateLockedAlarm
vmware.vcenter.alarm.VmdirHealthAlarm
vmware.vcenter.alarm.VmDiskConsolidationNeededAlarmMonitors changes in the virtual machine Consolidation Needed status.
vmware.vcenter.alarm.VmErrorAlarmMonitors virtual machine error and warning events.
vmware.vcenter.alarm.VmFaultToleranceLatencyStatusAlarmMonitors changes in the Fault Tolerance Secondary vLockStep interval.
vmware.vcenter.alarm.VmFaultToleranceStateChangedAlarmMonitors changes in the Fault Tolerance state of a virtual machine.
vmware.vcenter.alarm.VmMemoryUsageAlarmMonitors virtual machine memory usage.
vmware.vcenter.alarm.VmNoCompatibleHostForSecondaryAlarmMonitors the availability of compatible hosts on which a secondary virtual machine can be created and run.
vmware.vcenter.alarm.VmonApiHealthAlarm
vmware.vcenter.alarm.VmStorageComplianceAlarmMonitors virtual disk compliance with the object-based storage.
vmware.vcenter.alarm.VmTimedoutStartingSecondaryAlarmMonitors whether starting a secondary virtual machine has timed out.
vmware.vcenter.alarm.VmwareRhttpproxyHealthAlarm
vmware.vcenter.alarm.VmwareSyslogHealthAlarmMonitors the health status of the VMware Common Logging Service.
vmware.vcenter.alarm.VmwareVpostgresHealthAlarmMonitors the health status of the VMware vFabric Postgres Service.
vmware.vcenter.alarm.VoltageHealthAlarmMonitors host hardware voltage.
vmware.vcenter.alarm.VpxdSvcsHealthAlarm
vmware.vcenter.alarm.vsan.health.test.cloudhealth.vsancloudhealthceipexception
vmware.vcenter.alarm.vsan.health.test.cloudhealth.vsancloudhealthconnectionexception
vmware.vcenter.alarm.vsan.health.test.cluster
vmware.vcenter.alarm.vsan.health.test.cluster.advcfgsync
vmware.vcenter.alarm.vsan.health.test.cluster.clomdliveness
vmware.vcenter.alarm.vsan.health.test.cluster.clustermembership
vmware.vcenter.alarm.vsan.health.test.cluster.consistentconfig
vmware.vcenter.alarm.vsan.health.test.cluster.diskbalance
vmware.vcenter.alarm.vsan.health.test.cluster.healtheaminstall
vmware.vcenter.alarm.vsan.health.test.cluster.healthversion
vmware.vcenter.alarm.vsan.health.test.cluster.mmdecominsync
vmware.vcenter.alarm.vsan.health.test.cluster.physdiskdedupconfig
vmware.vcenter.alarm.vsan.health.test.cluster.physdiskdedupusage
vmware.vcenter.alarm.vsan.health.test.cluster.resynclimit
vmware.vcenter.alarm.vsan.health.test.cluster.timedrift
vmware.vcenter.alarm.vsan.health.test.cluster.upgradelowerhosts
vmware.vcenter.alarm.vsan.health.test.cluster.upgradesoftware
vmware.vcenter.alarm.vsan.health.test.cluster.vcauthoritative
vmware.vcenter.alarm.vsan.health.test.data
vmware.vcenter.alarm.vsan.health.test.data.objecthealth
vmware.vcenter.alarm.vsan.health.test.data.vmhealth
vmware.vcenter.alarm.vsan.health.test.encryption.hostcpuaesni
vmware.vcenter.alarm.vsan.health.test.encryption.kmsconnection
vmware.vcenter.alarm.vsan.health.test.hcl
vmware.vcenter.alarm.vsan.health.test.hcl.autohclupdate
vmware.vcenter.alarm.vsan.health.test.hcl.cimproviderinstall
vmware.vcenter.alarm.vsan.health.test.hcl.controllercache
vmware.vcenter.alarm.vsan.health.test.hcl.controllerdiskmode
vmware.vcenter.alarm.vsan.health.test.hcl.controllerdriver
vmware.vcenter.alarm.vsan.health.test.hcl.controllerfirmware
vmware.vcenter.alarm.vsan.health.test.hcl.controlleronhcl
vmware.vcenter.alarm.vsan.health.test.hcl.controllerraid
vmware.vcenter.alarm.vsan.health.test.hcl.controllerreleasesupport
vmware.vcenter.alarm.vsan.health.test.hcl.hcldbuptodate
vmware.vcenter.alarm.vsan.health.test.hcl.hclhostbadstate
vmware.vcenter.alarm.vsan.health.test.iscsi.iscsiHomeObjectStatusTest
vmware.vcenter.alarm.vsan.health.test.iscsi.iscsihomeobjectstatustest
vmware.vcenter.alarm.vsan.health.test.iscsi.iscsiInstallStatusTest
vmware.vcenter.alarm.vsan.health.test.iscsi.iscsiServiceNetworkTest
vmware.vcenter.alarm.vsan.health.test.iscsi.iscsiservicenetworktest
vmware.vcenter.alarm.vsan.health.test.iscsi.iscsiServiceRunningTest
vmware.vcenter.alarm.vsan.health.test.iscsi.iscsiservicerunningtest
vmware.vcenter.alarm.vsan.health.test.limits
vmware.vcenter.alarm.vsan.health.test.limits.limit0hf
vmware.vcenter.alarm.vsan.health.test.limits.limit1hf
vmware.vcenter.alarm.vsan.health.test.limits.nodecomponentlimit
vmware.vcenter.alarm.vsan.health.test.network
vmware.vcenter.alarm.vsan.health.test.network.clusterpartition
vmware.vcenter.alarm.vsan.health.test.network.hostconnectivity
vmware.vcenter.alarm.vsan.health.test.network.hostdisconnected
vmware.vcenter.alarm.vsan.health.test.network.hostlatencycheck
vmware.vcenter.alarm.vsan.health.test.network.largeping
vmware.vcenter.alarm.vsan.health.test.network.matchingsubnet
vmware.vcenter.alarm.vsan.health.test.network.multicastdeepdive
vmware.vcenter.alarm.vsan.health.test.network.multicastsettings
vmware.vcenter.alarm.vsan.health.test.network.multicastsuspected
vmware.vcenter.alarm.vsan.health.test.network.smallping
vmware.vcenter.alarm.vsan.health.test.network.unexpectedmember
vmware.vcenter.alarm.vsan.health.test.network.vmotionpinglarge
vmware.vcenter.alarm.vsan.health.test.network.vmotionpingsmall
vmware.vcenter.alarm.vsan.health.test.network.vsanenabled
vmware.vcenter.alarm.vsan.health.test.network.vsanvmknic
vmware.vcenter.alarm.vsan.health.test.overallsummary
vmware.vcenter.alarm.vsan.health.test.perfsvc
vmware.vcenter.alarm.vsan.health.test.perfsvc.collection
vmware.vcenter.alarm.vsan.health.test.perfsvc.hostsmissing
vmware.vcenter.alarm.vsan.health.test.perfsvc.masterexist
vmware.vcenter.alarm.vsan.health.test.perfsvc.perfsvcstatus
vmware.vcenter.alarm.vsan.health.test.perfsvc.renameddirs
vmware.vcenter.alarm.vsan.health.test.perfsvc.statsdb
vmware.vcenter.alarm.vsan.health.test.perfsvc.verbosemode
vmware.vcenter.alarm.vsan.health.test.physicaldisks
vmware.vcenter.alarm.vsan.health.test.physicaldisks.componentmetadata
vmware.vcenter.alarm.vsan.health.test.physicaldisks.lsomheap
vmware.vcenter.alarm.vsan.health.test.physicaldisks.lsomslab
vmware.vcenter.alarm.vsan.health.test.physicaldisks.physdiskcapacity
vmware.vcenter.alarm.vsan.health.test.physicaldisks.physdiskcomplimithealth
vmware.vcenter.alarm.vsan.health.test.physicaldisks.physdiskcongestion
vmware.vcenter.alarm.vsan.health.test.physicaldisks.physdiskhostissues
vmware.vcenter.alarm.vsan.health.test.physicaldisks.physdiskmetadata
vmware.vcenter.alarm.vsan.health.test.physicaldisks.physdiskoverall
vmware.vcenter.alarm.vsan.health.test.physicaldisks.physdisksoftware
vmware.vcenter.alarm.vsan.health.test.stretchedcluster
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.clusterwithmultipleunicastagents
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.clusterwithoutonewitnesshost
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.clusterwithouttwodatafaultdomains
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.hostunicastagentunset
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.hostwithinvalidunicastagent
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.hostwithnostretchedclustersupport
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.siteconnectivity
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.witnessfaultdomaininvalid
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.witnessinsidevccluster
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.witnesspreferredfaultdomaininvalid
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.witnesspreferredfaultdomainnotexist
vmware.vcenter.alarm.vsan.health.test.stretchedcluster.witnesswithnodiskmapping
vmware.vcenter.alarm.vsan.health.test.vsanhardwarecert
vmware.vcenter.alarm.vsan.health.test.vum vSAN health alarm
vmware.vcenter.alarm.vsan.health.test.vum.vumconfig
vmware.vcenter.alarm.vsan.health.test.vum.vumconfig
vmware.vcenter.alarm.vsan.health.test.vum.vumrecommendation
vmware.vcenter.alarm.VsanClusterLicenseExpiryAlarmMonitors the expiry of the vSAN license and the end of the evaluation period.
vmware.vcenter.alarm.VsanHealthAlarm
vmware.vcenter.alarm.VsanHostDiskErrorAlarmDefault alarm that monitors whether the host disks in the vSAN cluster have errors.
vmware.vcenter.alarm.VsanHostSsdOverUsageAlarmMonitors whether the flash disk capacity on the host exceeds the limit of the vSAN license.
vmware.vcenter.alarm.VSMHealthAlarmMonitors the health status of the vService Manager.
vmware.vcenter.alarm.VsphereAuthProxyHealthAlarm
vmware.vcenter.alarm.VsphereClientHealthAlarmMonitors vSphere Client Health.
vmware.vcenter.alarm.VsphereUiHealthAlarm
vmware.vcenter.alarm.VwsHealthAlarmMonitors the health status of the VMware System and Hardware Health Manager Service.
vmware.vcenter.alarm.countNumber of alarms on the device.

VMware Events Monitoring

Create custom events

  1. Navigate to Setup > Monitoring >Events.

  2. Click +Add at the right top corner.

  3. For Adapter Type, select VMware.

  4. In the name field, enter EventId from vCenter Server 8.0 IA (Build 20519528) Events Events as the metric name.

    Note: While creating the metric, it is required to replace “.” with “_“in the metric name.

Key Use Case

We have recently updated the VMware events and alarms to provide comprehensive details on how these alarms and events are generated. Below outlines the current design for events and alarms:

Retrieving alarms on individual resources

  • If an alarm template is assigned on a Host, all alerts related to the Host are mapped accordingly.
  • If an alarm template is assigned on a Datacenter, all alerts related to the Datacenter are mapped accordingly.
  • If an alarm template is assigned on DataStores, all alerts related to DataStores are mapped accordingly.
  • If an alarm template is assigned on VMs, all alerts related to VMs are mapped accordingly.
  • To retrieve only vCenter-specific alarms:
    • Assign the alarm template to the vCenter level and configure the parameter ‘vmware.vcenter.alarm.receive.child.alarms’ to ‘no’.

Configuration Parameters

Configuration ParametersDescription
vmware.vcenter.event.policyAny events added to the template and with the option set to "include" will be sent from the gateway to the cloud.

All events in the end device will be triggered from the gateway to the cloud if this parameter is set to "all".
vmware.vcenter.event.include.severity.listIt indicates that such events, regardless of their severity, will be triggered from the gateway to the cloud.

If they include "unknown,info,warning,error,user" events. Only these events are triggered

NetApp Solidfire
vmware.vcenter.event.queue.typeQueue type has three categories.

  • Ignore: If the vmware host is in schedule maintenance, the events will be ignored, i.e. they won't be triggered at cloud end.
  • Send To Maintenance Queue: During the vmware host maintenance, the events are moved to the maintenance queue.
  • Default: The events are moved to the monitoring queue even though the vmware hosts are in maintenance
vmware.events.regex.matchWhen a regular expression is given as input to the "vmware.events.regex.match" pattern, the event will only be processed if its simple class name or class name or canonical class name matches the regular expression. Here, the "vmware.vcenter.event.policy" should be set to "all".

Note: The default value of this parameter is set as "None".

VMware Authentication Failure Notification

Discovery

Displaying a failure message in the activity when the discovery process fails.

Monitoring

The OpsRamp tool sends an authentication failure alert with the metric name ‘vmware.auth.error’ specifically for VMware vCenter or ESXi hosts. This alert is triggered when monitoring is stopped due to issues related to connection, authentication failures, or other related issues. The alert is activated only when the following vCenter monitoring template is applied to vCenter, and we discover vCenter through integration.

vCenter Template Names: VMware vCenter Performance - v5.

When we apply the following ESXi monitoring template on ESXi Host, and we discover ESXi through integration.

Host Template Names: VMware Host Performance - v6.

Resource TypeMetricPossible ValuesReference Link
HOSTVMware.host.status.availabilityconnected - 1
disconnected / notResponding - 0
Enum - HostSystemConnectionState
DataStoreVMware.datastore.status.availabilitytrue - 1
false - 0
Data Object - DatastoreSummary
Note: Considering the "accessible" attribute in the above URL for datastore status monitoring
ClusterVMware.cluster.status.availabilityGreen / Yellow - 1
Red - 0
Managed Object - ManagedEntity
Note: Considering the "OverallStatus" attribute in the above URL for cluster status monitoring.
Virtual machinevmware.vm.power.statepoweredOff (0)
poweredOn (1)
suspended (2)
Enum - VirtualMachinePowerState
VCenterApply vmware.vm.power.state on the virtual machine having the same IPadress as VCenterpoweredOff (0)
poweredOn (1)
suspended (2)
Enum - VirtualMachinePowerState