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.
Note
OpsRamp’s Gateway based VMware discovery is used to halt vCenter discovery if any host was in a maintenance or disconnected state up to gateway version 14.1.0.
From 14.2.0 gateway version onwards we have improved the process so that vCenter discovery can proceed even if a host is in a maintenance or disconnected state.
Only the following child resources of a host in maintenance or disconnected state will not be updated, while the rest of the vCenter components will be updated without any impact.
- VMs
- DataStores
- OOBInterfaceDetails
- VxRail components (Boot info and PhysicalDisks)
- vSAN components (HardDisks)
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.
- Go to Menu and select Administration.
- Under Single Sign On, click Users and Groups.
- Select the required domain from the Domain list box and click Add User.
- Enter the required details and click Add.
- 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.
- Search for the user in the Add Member and click SAVE.
- Under Access Control, click Global Permissions.
- Select the user and click +.
- Search for the user and select the role from the Role list.
- Select Propagate to children checkbox and click OK.
Note: Username of the vCenter is
<name of the user>@<domain name>
- Go to Menu and select Administration.
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
andhelp api list
.Steps to create SSH user for appliance monitoring.
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.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
When prompted, enter and verify the new local user’s password.
- To switch to bash shell from appliance-shell.
Command>shell
Note: if the above command does not work, we recomment usingCommand>bash
To set appliance shell as the default shell run below command in the vCenter.chsh -s /bin/appliancesh <Opsramp-SSH-username>
- Exit the shell first, then the vCenter appliance.
- 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.
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 templateVMware ESXi Hardware Status
for monitoring.The user accounts configured for VMware integration must have privileges to access CIM APIs. Configure
CIM
andCIM Interaction
permissions to access the host hardware metrics. Refer to Host CIM Privileges in the VMware documentation.From vcenter version 8.0 the
CIM monitoring
is to be enabled manually using the commandesxcli system wbem set -e true
by connecting to the respectiveesxi
usingssh
credentials as mentioned in the Control Access for CIM-Based Hardware Monitoring Tools 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.Alternatively, grant the rights by taking the following actions:
- Click Edit role action and select the provider.
- On the Edit Role page, check box the CIM and CIM interaction.
- Click NEXT.
The VMware Host should have the CIM Service functioning.
Enable gateway IPAddress access to
5989,5988
port.CIM Secure Server and CIM Server services should be in running state.
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
- From All Clients, select a client.
- Navigate to Setup > Account.
- Select the Integrations and Apps tab.
- 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.
- 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.
- Search for the application using the search option available. Alternatively, use the All Categories option to search.
- Click ADD on the VMware.
- The Configuration page is displayed, enter the below information:
- Name: Configuration name.
- IP Address/dnsName: IP Address or DNS Name 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.
- Click + ADD available in the CredentialSet dropdown. The ADD CREDENTIAL page is displayed. Enter the following information:
- 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.
- 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
.
- 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.
- Enter/select the values in the Key, Operator, and Value fields for filtering the resources.
- 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.
- PERFORM ACTION: Select the Manage Device checkbox, if you want the discovered devices to be managed.
- 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)
- Click NEXT.
- In the Installation page, select an existing registered gateway profile, and click FINISH.
Note: The selected gateway should be up and running.
- 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.
Notes
Our tool performs VMware monitoring in the following manner:
- A session is initiated with the vCenter/ESXi device at the outset, and it remains operational until the session is active.
- If the session becomes inactive or if the vProbe service is restarted, a new session is created.
Assign Monitoring templates to the resource
- Go to Infrastructure > Resources > VMware.
- On the Resources page of VMware, click resource name > resource Details > Monitors > Template.
- On the Templates screen, click +Assign Templates.
- In the Apply Templates section, AssignTemplates > Available templates, select the templates and click the > button.
- Click Assign. The Templates screen displays the selected templates.
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 Parameter | Description |
---|---|
Connection Time-out | Maximum 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 Port | Port 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 Security | Events triggered from gateway to cloud while applying a vCenter event template. The different events available are:
|
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.
VMware Recommended templates
The recommended templates for VMware in each entity level
Entity | Template | Metric Name | VMware Supported Version | Gateway Supported Version | Description |
---|---|---|---|---|---|
vCenter | VMware vCenter Performance - v5 | vmware.vcResources.physicalmemusage.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Physical memory used by vCenter. |
vmware.vcenter.disk.freeCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of free capacity in the vCenter. | ||
vmware.vcenter.disk.usedCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of used capacity of the hosts in the vCenter. | ||
vmware.vcenter.api.service.respons-time | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | VMware vCenter API service response time. | ||
vmware.vcenter.disk.capacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of the capacity of the hosts in the vCenter. | ||
vmware.vcResources.systemcpuusage.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Total system CPU used on the system where vCenter Server is running. | ||
vmware.vcenter.disk.usedCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of used capacity in the vCenter. | ||
vmware.vcenter.disk.freeCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of the free capacity of the hosts in the vCenter. | ||
VMware vCenter Appliance Performance - v2 | com.vmware.appliance.version1.resources.system.stats.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance System Stats. | |
com.vmware.appliance.version1.resources.system.health.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance System Health State. | ||
com.vmware.appliance.version1.resources.mem.health.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance Memory Health State. | ||
com.vmware.appliance.version1.resources.mem.stats.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance Memory Stats. | ||
com.vmware.appliance.version1.resources.load.stats.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance Load Stats. | ||
com.vmware.appliance.version1.resources.storage.health.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance Storage Health State. | ||
com.vmware.appliance.version1.networking.interfaces.list | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | It 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.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance Load Health State. | ||
com.vmware.appliance.version1.resources.swap.health.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance Swap Health State. | ||
com.vmware.appliance.version1.resources.softwarepackages.health.get | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | VMware vCenter Appliance SoftwarePackages Health State. | ||
Gateway - VMware vCenter Appliance Service Status | vmware_vcenter_appliance_service_Status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Monitors 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 - v2 | com.vmware.appliance.version1.service.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Monitors 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 - v2 | vmware_vcenter_appliance_certificates_expiry_inDays | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | It monitors VMware vCenter appliance certificates expiry in days. | |
Cluster | VMware Cluster Performance - v6 | vmware.cluster.disk.capacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of Maximum capacity of the datastores. |
vmware.cluster.status.availability | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | General health of the cluster. | ||
vmware.clusterServices.effectivecpu.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Total available CPU resources of all hosts within a cluster. | ||
vmware.cluster.disk.freeCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of free capacity in the cluster. | ||
vmware.vmop.numSVMotion.latest | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Number of migrations with Storage vMotion (datastore change operations for powered-on VMs). | ||
vmware.cluster.mem.utilization | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Amount of host machine memory used by all powered on virtual machines in the cluster. | ||
vmware.cluster.mem.capacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Total 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.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Total 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.ghz | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | VMware Cluster CPU Capacity in GHz. | ||
vmware.cluster.disk.usedCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of used capacity of the datastores. | ||
vmware.vmop.numVMotion.latest | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Number of migrations with vMotion (host change operations for powered-on VMs). | ||
vmware.clusterServices.effectivemem.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Cluster services effective mem average. | ||
vmware.cluster.disk.freeCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of available space of the datastores. | ||
vmware.cluster.disk.usedCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of used capacity in the cluster. | ||
Virtual Machine | VMware VirtualMachine Performance - v7 | vmware.vm.power.state | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | This metric defines the power state for a virtual machine. The possible metrics values are, poweredOff(0), poweredOn(1), suspended(2) |
vmware.mem.usage.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of physical memory that has been consumed by the Virtual Machine. | ||
vmware.vm.status.availability | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | This 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.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Average number of kilobytes written to disk each second during the collection interval. | ||
vmware.cpu.ready.summation | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Time the virtual machine is ready to run, but is not running because it has reached its maximum CPU limit setting. | ||
vmware.cpu.usage.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | CPU usage as a percentage during the interval. | ||
vmware.cpu.capacity.demand.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | The amount of CPU resources a virtual machine would use if there were no CPU contention or CPU limit. | ||
vmware.vm.disk.usedSpaceInPercentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Used space of each disk in the virtual machine in percentage. | ||
vmware.mem.entitlement.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Amount of host physical memory the virtual machine is entitled to, as determined by the ESX scheduler. | ||
vmware.virtualDisk.numberReadAveraged.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Average number of read commands issued per second to the virtual disk during the collection interval. | ||
vmware.disk.read.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Average number of kilobytes read from the disk each second during the collection interval. | ||
vmware.vm.disk.usedCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Total storage space, committed to this virtual machine across all datastores. | ||
vmware.mem.active.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Amount of guest “physical” memory actively used in VM. | ||
vmware.cpu.entitlement.latest | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Amount 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.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Datastore Write latency. | ||
vmware.cpu.ready.summation.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | It displays the CPU ready summation in percentage. | ||
vmware.net.transmitted.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Average rate at which data was transmitted during the interval. | ||
vmware.vm.disk.freeCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Additional storage space, in bytes, potentially used by this virtual machine on all datastores. | ||
vmware.cpu.latency.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percent of time the virtual machine is unable to run because it is contending for access to the physical CPU(s). | ||
vmware.vm.disk.freeCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | It displays the available disk space of Virtual Machine in percentage. | ||
vmware.virtualDisk.totalWriteLatency.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | The average time a write to the virtual disk takes. | ||
vmware.virtualDisk.numberWriteAveraged.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Average number of write commands issued per second to the virtual disk during the collection interval. | ||
vmware.cpu.maxlimited.summation | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Time the virtual machine is ready to run, but is not running because it has reached its maximum CPU limit setting. | ||
vmware.vm.disk.usedCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | The percentage of total storage space,committed to this virtual machine across all datastores. | ||
vmware.vm.disk.capacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Additional storage space, in bytes, potentially used by this virtual machine on all datastores. | ||
vmware.mem.granted.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Amount of host physical memory or physical memory that is mapped for a virtual machine or a host. | ||
vmware.virtualDisk.totalReadLatency.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | The average time a read from the virtual disk takes. | ||
vmware.mem.latency.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of time the virtual machine is waiting to access swapped or compressed memory. | ||
vmware.disk.numberRead.summation | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Number of disk reads during the collection interval. | ||
vmware.datastore.totalReadLatency.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Average amount of time for a read operation from the datastore. | ||
vmware.vm.cpu.demandToEntitlementRatio | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | CPU resource entitlement to CPU demand ratio (in percents). | ||
vmware.net.usage.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Network utilization (combined transmit-rates and receive-rates) during the interval. | ||
vmware.disk.numberWrite.summation | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Number of disk writes during the collection interval. | ||
vmware.cpu.costop.summation | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Time the virtual machine is ready to run, but is unable to run due to co-scheduling constraints. | ||
vmware.net.received.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Average 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. | ||
HostSystem | VMware Host Performance - v6 | vmware.host.status.availability | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | General health of the host. |
vmware.datastore.totalReadLatency.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Average amount of time for a read operation from the datastore. | ||
vmware.mem.usage.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of physical memory that has been consumed by the host. | ||
vmware.disk.usage.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Average data I/O rate across all virtual disks on the host. | ||
vmware.disk.write.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Average number of kilobytes written to disk each second during the collection interval. | ||
vmware.host.disk.freeCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of free capacity in the host. | ||
vmware.cpu.ready.summation | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Time the virtual machine is ready to run, but is not running because it has reached its maximum CPU limit setting. | ||
vmware.vm.poweroff.count | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Count of number of VMs powered off on a host. | ||
vmware.vm.suspended.count | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Count of number of VMs suspended on a host. | ||
vmware.datastore.datastoreIops.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Storage I/O Control aggregate IOPS. | ||
vmware.host.cpu.capacity.ghz | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of the MHz for all the individual cores on the host. | ||
vmware.net.usage.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Network utilization (combined transmit-rates and receive-rates) during the interval. | ||
vmware.disk.numberRead.summation | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Number of disk reads during the collection interval. | ||
vmware.cpu.usage.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | CPU usage as a percentage during the interval. | ||
vmware.host.mem.capacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Total amount of physical memory on the host in bytes. | ||
vmware.host.disk.usedCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of used capacity of the datastores. | ||
vmware.vm.poweron.count | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Count of number of VMs powered on. | ||
vmware.host.cpu.utilization.ghz | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Aggregated CPU usage across all cores on the host in GHz. This is only available if the host is connected. | ||
vmware.host.disk.capacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of the capacity of the datastores. | ||
vmware.datastore.maxTotalLatency.latest | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Highest latency value across all datastores used by the host. | ||
vmware.cpu.ready.summation.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | It displays the CPU ready summation in percentage. | ||
vmware.datastore.totalWriteLatency.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Average amount of time for a write operation from the datastore. | ||
vmware.host.disk.usedCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Percentage of used capacity in the host. | ||
vmware.host.mem.utilization | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Physical memory usage on the host in GB. This is only available if the host is connected. | ||
vmware.host.disk.freeCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Sum of free capacity of the datastores. | ||
vmware.disk.read.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Average number of kilobytes read from the disk each second during the collection interval. | ||
vmware.disk.numberWrite.summation | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | VMware disk number write summation. | ||
VMware Host Hardware Health Status - v3 | vmware.host.hardware.battery-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Battery Health Status. | |
vmware.host.hardware.memory-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Memory Health Status. | ||
vmware.host.hardware.power-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Power Health Status. | ||
vmware.host.hardware.temperature-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Temperature Health Status. | ||
vmware.host.hardware.other.health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Other Health Status. | ||
vmware.host.hardware.system-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware System Health Status. | ||
vmware.host.hardware.processor-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Processor Health Status. | ||
vmware.host.hardware.storage-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Storage Health Status. | ||
vmware.host.hardware.watchdog-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Watchdog Health Status. | ||
vmware.host.hardware.fan-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Fan Health Status. | ||
vmware.host.hardware.voltage-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Voltage Health Status. | ||
vmware.host.hardware.cableinterconnect-health.status | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Host Hardware Cable InterConnect Health Status. | ||
Datastore | VMware Datastore Performance - v5 | vmware.datastore.numberReadAveraged.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Average number of read commands issued per second to the datastore during the collection interval. |
vmware.disk.provisioned.latest | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Amount of storage set aside for use by a datastore or a virtual machine. | ||
vmware.datastore.disk.capacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Maximum capacity of the datastore. | ||
vmware.disk.used.latest | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Amount of space actually used by the virtual machine or the datastore. | ||
vmware.datastore.disk.usedCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Used capacity of the datastore. | ||
vmware.datastore.numberWriteAveraged.average | 6.0.0, 6.5.0, and 7.0.0 | 14.1.0 | Average number of write commands issued per second to the datastore during the collection interval. | ||
vmware.datastore.disk.usedCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | The percentage of used capacity of the datastore. | ||
vmware.disk.capacity.latest | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Configured size of the datastore. | ||
vmware.datastore.disk.freeCapacity | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Available space of the datastore. | ||
vmware.datastore.disk.freeCapacity.percentage | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | The percentage of available space of the datastore. | ||
vmware.datastore.status.availability | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | VMware Datastore Status Availability. | ||
VMware DataStore - Disk Performance - v2 | vmware.disk.numberWriteAveraged.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Average number of write commands issued per second to the datastore during the collection interval. | |
vvmware.disk.numberReadAveraged.average | 6.0.0, 6.5.0, 7.0.0, and 8.0.0 | 14.1.0 | Average number of read commands issued per second to the datastore during the collection interval. |
VMware Alarms Document
Create custom alarm metrics
- Navigate to Setup > Monitoring > Events.
- Click +Add at the right top corner.
- For Adapter Type, select VMware.
- In the name field, the metric name should be added as follows:
For user defined alarms, the sysname is null. In that case, add the metric name in this format:
“vmware_vcenter_alarm_”+alarmName
. Here, alarmName
should not have any spaces.
Example: If a user defines an alarm with name memory Limit Alarm, then the metric name should be created as vmware_vcenter_alarm_memoryLimitAlarm
.
Note
According to the design, VMware alarm metric thresholds and alert configurations will not function within VMware alarm templates.Key Use Case
The following paramaters 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 Parameter | Description |
---|---|
vmware.vcenter.alarm.policy | If "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:
|
vmware.vcenter.alarm.exclude.entity.list | If 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.list | If 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.alarms | Only 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.match | When 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 Name | Description |
---|---|
vmware.vcenter.alarm.ApplmgmtHealthAlarm | Monitors the health status of the Appliance Management Service. |
vmware.vcenter.alarm.BatteryHealthAlarm | Monitors the battery status of hosts. |
vmware.vcenter.alarm.BMCHealthAlarm | Monitors the status of the Baseboard Management Controller. |
vmware.vcenter.alarm.CertificateStatusAlarm | Monitors the certificate status of an ESXi host. |
vmware.vcenter.alarm.ComponentMgrHealthAlarm | Monitors Component Manager Service Health |
vmware.vcenter.alarm.ConsistencyGroupViolation | Datastore cluster has datastores that belong to different SRM consistency groups. |
vmware.vcenter.alarm.ContentLibraryServiceHealthAlarm | Monitors the health status of the VMware Content Library Service. |
vmware.vcenter.alarm.DatastoreDiskUsageAlarm | Monitors datastore disk usage. |
vmware.vcenter.alarm.DatastoreInMultipleDatacenters | Monitors whether a datastore in a datastore cluster is visible in more than one data center. |
vmware.vcenter.alarm.DatastoreStorageComplianceAlarm | Monitors whether the virtual disk on the datastore complies with the object-based storage. |
vmware.vcenter.alarm.DBHealthAlarm | |
vmware.vcenter.alarm.DSHealthAlarm | Monitors the health status of the Data Service. |
vmware.vcenter.alarm.EAMHealthAlarm | Monitors the health status of the ESX Agent Manager. |
vmware.vcenter.alarm.ExitStandbyErrorAlarm | Monitors whether a host cannot exit standby mode. |
vmware.vcenter.alarm.FailoverFailedAlarm | |
vmware.vcenter.alarm.FanHealthAlarm | Monitors host fans. |
vmware.vcenter.alarm.HAcannotFindMaster | Monitors whether vCenter Server is able to connect to a vSphere High Availability master agent. |
vmware.vcenter.alarm.HAfailoverFailed | Monitors the failover progress of vSphere High Availability. |
vmware.vcenter.alarm.HAfailoverInProgress | Monitors the failover progress of vSphere High Availability. |
vmware.vcenter.alarm.HAhostStatus | Monitors the host health status reported by vSphere High Availability. |
vmware.vcenter.alarm.HAinsufficientFailoverResources | Monitors the sufficiency of failover cluster resources required for vSphere High Availability. |
vmware.vcenter.alarm.HardwareSensorStateChange | |
vmware.vcenter.alarm.HAvmMonitoringAction | Monitors whether vSphere High Availability has restarted a virtual machine. |
vmware.vcenter.alarm.HAvmMonitoringError | Monitors whether vSphere High Availability failed to reset a virtual machine. |
vmware.vcenter.alarm.HealthStatusChangedAlarm | Monitors changes to service and extension health status. |
vmware.vcenter.alarm.HostCertManagementModeChangedAlarm | Monitors changes in the certificate management mode of vCenter Server. |
vmware.vcenter.alarm.HostCertStatusAlarm | Monitors the certificate status of an ESXi host. |
vmware.vcenter.alarm.HostConnectionStateAlarm | Monitors the power state of the host and whether the host is reachable. |
vmware.vcenter.alarm.HostConnectivityAlarm | Monitors host connectivity to a storage device. |
vmware.vcenter.alarm.HostCPUUsageAlarm | Monitors host CPU usage. |
vmware.vcenter.alarm.HostErrorAlarm | Monitors host error and warning events. |
vmware.vcenter.alarm.HostEsxCosSwapAlarm | Monitors host service console memory swap rates. |
vmware.vcenter.alarm.HostIpConflictAlarm | |
vmware.vcenter.alarm.HostLicenseEditionNotAllowed | Monitors the compatibility of the vCenter Server and host license editions. |
vmware.vcenter.alarm.HostMemoryUsageAlarm | Monitors host memory usage. |
vmware.vcenter.alarm.HostRequiresEncryptionModeEnabledAlarm | |
vmware.vcenter.alarm.HostVendorProviderRegistrationAlarm | Default alarm that monitors whether the registration or unregistration of a VASA vendor provider on a vSAN host fails. |
vmware.vcenter.alarm.IdentityHealthAlarm | Monitors the health status of the Identity Management Service. |
vmware.vcenter.alarm.ImageBuilderHealthAlarm | |
vmware.vcenter.alarm.InventoryHealthAlarm | Monitors the health status of the Inventory Service. |
vmware.vcenter.alarm.IoFilterHostVendorProviderRegistrationAlarm | Default alarm that monitors whether vCenter Server fails to register or unregister third-party IO filter storage providers on a host. |
vmware.vcenter.alarm.IoFilterManagementOperationAlarm | vSphere APIs for IO Filtering (VAIO) Filter Management Operations. |
vmware.vcenter.alarm.IormNonVIWorkloadAlarm | Monitors the unmanaged I/O workload on a SIOC-enabled datastore. |
vmware.vcenter.alarm.KMSClientCertificateStatusAlarm | |
vmware.vcenter.alarm.KMSServerCertificateStatusAlarm | |
vmware.vcenter.alarm.LicenseCapacityExceededAlarm | Monitors whether a license capacity is exceeded. |
vmware.vcenter.alarm.LicenseError | Monitors license errors. |
vmware.vcenter.alarm.LicenseExpiredHost | Monitors the expiry of host license. |
vmware.vcenter.alarm.LicenseExpiredVc | Monitors vCenter Server license expiry. |
vmware.vcenter.alarm.LicenseHealthAlarm | Monitors the health status of the License Service. |
vmware.vcenter.alarm.LicenseNonComplianceAlarm | Monitors the license inventory for compliance. |
vmware.vcenter.alarm.LicenseUserThresholdExceededAlarm | Monitors whether a user-defined license threshold is exceeded. |
vmware.vcenter.alarm.LunCapabilityAlarm | Monitors the change in the capability status for volumes backing the datastore. |
vmware.vcenter.alarm.MemoryHealthAlarm | Monitors host memory usage. |
vmware.vcenter.alarm.MigrateBindToVMKAlarm | Monitors incorrectly configured VMkernel NICs. |
vmware.vcenter.alarm.MigrationErrorAlarm | Monitors whether a virtual machine cannot be migrated or relocated, or is orphaned. |
vmware.vcenter.alarm.MsgBusHealthAlarm | Monitors the health status of the Message Bus Configuration Service. |
vmware.vcenter.alarm.NetdumperHealthAlarm | Monitors the health status of the VMware vSphere ESXi Dump Collector Service. |
vmware.vcenter.alarm.NetworkConnectivityLostAlarm | Monitors the network connectivity on a virtual switch. |
vmware.vcenter.alarm.NetworkRedundancyDegradedAlarm | Monitors network uplink redundancy degradation on a virtual switch. |
vmware.vcenter.alarm.NetworkRedundancyLostAlarm | Monitors network uplink redundancy on a virtual switch. |
vmware.vcenter.alarm.OtherHealthAlarm | Monitors other host hardware objects. |
vmware.vcenter.alarm.PerfchartsHealthAlarm | Monitors the health status of the Performance Charts Service. |
vmware.vcenter.alarm.PowerHealthAlarm | Monitors the host power status. |
vmware.vcenter.alarm.ProcessorHealthAlarm | Monitors the host processors. |
vmware.vcenter.alarm.RBDHealthAlarm | Monitors the health status of the vSphere Auto Deploy Waiter. |
vmware.vcenter.alarm.SELHealthAlarm | Monitors the capacity of the IPMI system event log. |
vmware.vcenter.alarm.ServiceControlAgentHealthAlarm | Monitors the health status of the VMware Service Control Agent. |
vmware.vcenter.alarm.SpsHealthAlarm | Monitors the health status of the VMware vSphere Profile-Driven Storage Service. |
vmware.vcenter.alarm.StatsmonitorHealthAlarm | |
vmware.vcenter.alarm.StorageConnectivityAlarm | Monitors host connectivity to a storage device. |
vmware.vcenter.alarm.StorageHealthAlarm | Monitors host connectivity to storage devices. |
vmware.vcenter.alarm.StoragePodOutOfSpace | Monitors whether a datastore cluster runs out of disk space. |
vmware.vcenter.alarm.StoragePodSDRSNotSupportedHost | Monitors and alerts when Storage DRS is not supported on a host. |
vmware.vcenter.alarm.StoragePodSDRSRecommendation | |
vmware.vcenter.alarm.StoragePodSDSRecommendation | Monitor Storage DRS recommendations. |
vmware.vcenter.alarm.SubscriptionLicenseExpiredHost | Monitors the expiry of host time-limited license. |
vmware.vcenter.alarm.SubscriptionLicenseExpiredVc | Monitors vCenter Server time-limited license expiry. |
vmware.vcenter.alarm.SubscriptionLicenseExpiredVsan | Monitors the expiry of the vSAN license and the end of the evaluation period. |
vmware.vcenter.alarm.SystemBoardHealthAlarm | Monitors the status of host system boards. |
vmware.vcenter.alarm.TemperatureHealthAlarm | Monitors the temperature status of the host hardware. |
vmware.vcenter.alarm.ThinProvisionedLunAlarm | Monitors whether the thin provisioning threshold on the storage array exceeds for volumes backing the datastore. |
vmware.vcenter.alarm.TsHealthAlarm | Monitors the health status of the VMware Transfer Service. |
vmware.vcenter.alarm.UpdateMgrHealthAlarm | |
vmware.vcenter.alarm.VapiEndpointHealthAlarm | Monitors the health status of the VMware vAPI Endpoint Service. |
vmware.vcenter.alarm.VasaProviderCertificateExpiryAlarm | Monitors whether VASA provider certificates are getting close to their expiry date. |
vmware.vcenter.alarm.VasaProviderDisconnectedAlarm | Monitors the changes in the connection state of VASA providers. |
vmware.vcenter.alarm.VasaProviderObjectAlarm | It tracks vCenter Object Type Storage Alarm. |
vmware.vcenter.alarm.VasaProviderRefreshCACertsAndCRLsFailureAlarm | Monitors 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.VCServerHealthAlarm | Monitors the health status of vCenter Server. |
vmware.vcenter.alarm.VdcsHealthAlarm | Monitors Open Virtualization Format Service Health. |
vmware.vcenter.alarm.VdsHCMTUMatchAlarm | Monitors changes in vSphere Distributed Switch MTU matched status. |
vmware.vcenter.alarm.VdsHCMTUSupportedAlarm | Monitors changes in vSphere Distributed Switch MTU supported status. |
vmware.vcenter.alarm.VdsHCTeamingMatchAlarm | Monitors changes in vSphere Distributed Switch teaming matched status. |
vmware.vcenter.alarm.VdsHCVlanTrunkedAlarm | Monitors changes in vSphere Distributed Switch VLAN trunked status. |
vmware.vcenter.alarm.VFlashResourceHealthAlarm | Monitors the Flash Read Cache resource status on the host. |
vmware.vcenter.alarm.VFlashResourceUsageAlarm | Monitors the Flash Read Cache resource usage on the host. |
vmware.vcenter.alarm.VmAdapterResvervationStatus | Monitors changes in the reservation status of a virtual machine network adapter. |
vmware.vcenter.alarm.VmcpTerminateVmAborted | Monitors whether vSphere High Availability VM Component Protection cannot power off a virtual machine with an inaccessible datastore. |
vmware.vcenter.alarm.VmCPUUsageAlarm | Monitors virtual machine CPU usage. |
vmware.vcenter.alarm.VmCryptoStateLockedAlarm | |
vmware.vcenter.alarm.VmdirHealthAlarm | |
vmware.vcenter.alarm.VmDiskConsolidationNeededAlarm | Monitors changes in the virtual machine Consolidation Needed status. |
vmware.vcenter.alarm.VmErrorAlarm | Monitors virtual machine error and warning events. |
vmware.vcenter.alarm.VmFaultToleranceLatencyStatusAlarm | Monitors changes in the Fault Tolerance Secondary vLockStep interval. |
vmware.vcenter.alarm.VmFaultToleranceStateChangedAlarm | Monitors changes in the Fault Tolerance state of a virtual machine. |
vmware.vcenter.alarm.VmMemoryUsageAlarm | Monitors virtual machine memory usage. |
vmware.vcenter.alarm.VmNoCompatibleHostForSecondaryAlarm | Monitors the availability of compatible hosts on which a secondary virtual machine can be created and run. |
vmware.vcenter.alarm.VmonApiHealthAlarm | |
vmware.vcenter.alarm.VmStorageComplianceAlarm | Monitors virtual disk compliance with the object-based storage. |
vmware.vcenter.alarm.VmTimedoutStartingSecondaryAlarm | Monitors whether starting a secondary virtual machine has timed out. |
vmware.vcenter.alarm.VmwareRhttpproxyHealthAlarm | |
vmware.vcenter.alarm.VmwareSyslogHealthAlarm | Monitors the health status of the VMware Common Logging Service. |
vmware.vcenter.alarm.VmwareVpostgresHealthAlarm | Monitors the health status of the VMware vFabric Postgres Service. |
vmware.vcenter.alarm.VoltageHealthAlarm | Monitors 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.VsanClusterLicenseExpiryAlarm | Monitors the expiry of the vSAN license and the end of the evaluation period. |
vmware.vcenter.alarm.VsanHealthAlarm | |
vmware.vcenter.alarm.VsanHostDiskErrorAlarm | Default alarm that monitors whether the host disks in the vSAN cluster have errors. |
vmware.vcenter.alarm.VsanHostSsdOverUsageAlarm | Monitors whether the flash disk capacity on the host exceeds the limit of the vSAN license. |
vmware.vcenter.alarm.VSMHealthAlarm | Monitors the health status of the vService Manager. |
vmware.vcenter.alarm.VsphereAuthProxyHealthAlarm | |
vmware.vcenter.alarm.VsphereClientHealthAlarm | Monitors vSphere Client Health. |
vmware.vcenter.alarm.VsphereUiHealthAlarm | |
vmware.vcenter.alarm.VwsHealthAlarm | Monitors the health status of the VMware System and Hardware Health Manager Service. |
vmware.vcenter.alarm.count | Number of alarms on the device. |
VMware Events Monitoring
Create custom events
Navigate to Setup > Monitoring >Events.
Click +Add at the right top corner.
For Adapter Type, select VMware.
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 Parameters | Description |
---|---|
vmware.vcenter.event.policy | Any 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.list | It 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 |
vmware.vcenter.event.queue.type | Queue type has three categories.
|
vmware.events.regex.match | When 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.
Recommended Metrics for Availability
Resource Type | Metric | Possible Values | Reference Link |
---|---|---|---|
HOST | VMware.host.status.availability | connected - 1 disconnected / notResponding - 0 | Enum - HostSystemConnectionState |
DataStore | VMware.datastore.status.availability | true - 1 false - 0 | Data Object - DatastoreSummary Note: Considering the "accessible" attribute in the above URL for datastore status monitoring |
Cluster | VMware.cluster.status.availability | Green / Yellow - 1 Red - 0 | Managed Object - ManagedEntity Note: Considering the "OverallStatus" attribute in the above URL for cluster status monitoring. |
Virtual machine | vmware.vm.power.state | poweredOff (0) poweredOn (1) suspended (2) | Enum - VirtualMachinePowerState |
VCenter | Apply vmware.vm.power.state on the virtual machine having the same IPadress as VCenter | poweredOff (0) poweredOn (1) suspended (2) | Enum - VirtualMachinePowerState |