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.


  • Requires read-only access at vCenter for the discovery and monitoring of resources.

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

  • 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.
  • Enable default port 443 on vCenter.

Step 1: Create a credential

  1. Select a client from the All Clients list.
  2. Go to Setup > Accounts > Clients.
  3. In the client Credentials tab, add the credential information.
  • If you use a domain account to access vCenter, specify the domain with the username in the format domain\username.
  • Install VMware Tools in virtual machines to avoid duplicate resources while discovering IP address and hostname.

Step 2: Install integration

  1. Select a client from the All Clients list.

  2. Go to Setup > Integrations > Integrations.

  3. In the Available Integrations section, select Compute > VMware and click Install.

  4. In the Install VMware Integrations section, enter:

    • Name
    • IP address
    • Credentials. Select an existing credential or create a new credential.
  5. Click Save.

Step 3: Add a discovery profile

  1. On the VMWARE Integration page, go to Discovery Profiles and click + Add.

  2. In the Profiles Details section, enter:

    • Profile Name
    • Select Profile
    • IP Address
  3. In the Filter Criteria section, enter the following details:

    • Select Smart Filters to filter resources based on the resource types and select All Resources to discover all resource types.
    • Select Resource Filters to filter resources based on resource attributes. See Regular Expressions in OpsRamp Help to view details on filtering resources using logical operator Regex.
  4. In the Perform Actions section, select Manage Device if the resource needs to be managed.

  5. In the Discovery Schedule section, select the preferred Recurrence Pattern. Choose one of the following intervals:

    • Hourly
    • Daily
    • Weekly
    • Monthly
  6. Click Save.

  7. In the Discovery Profiles section and click Scan Now for the profile.

Step 4: View VMware details

VMware is successfully integrated and displayed in the Infrastructure > VMware category.

Step 5: 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.
  4. In the Apply Templates section, Select Templates > Available templates, select the templates.
  5. 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 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.

    Supported metrics

    Metric NameMetric Display NameUnits
    vmware_vcenter_appliance_certificates_expiry_inDaysVMware vCenter Appliance Certificates Expiry In Days
    Note: Metric details applicable to vcenter appliance.
    vmware_windows_vcenter_certificates_expiry_inDaysVMware Windows vCenter Certificates Expiry In Days
    Note:Metric details applicable to windows vcenter.
    com.vmware.appliance.version1.networking.interfaces.listVMware vCenter Appliance Performance - v2
    vmware_vcenter_appliance_service_StatusVmware Vcenter Appliance Service Status
    Note: Metric details are applicable to vcenter appliance
    vmware_vcenter_service_StatusVmware Vcenter Appliance Service Status
    Note: Metric details are applicable to vcenter appliance.
    vmware.datastore.snapshot.used.latestVmware Datastore Snapshot Used LatestGigaBytes
    vmware.datastore.swap.sizeVmware Datastore Swap SizeGigaBytes
    vmware.disk.busResets.summationVmware Disk Bus Resets SummationCount
    vmware.disk.kernelLatency.averageVmware Disk Kernel Latency AverageMilliSecond
    vmware.disk.kernelReadLatency.averageVmware Disk Kernel Read Latency AverageMilliSecond
    vmware.disk.kernelWriteLatency.averageVmware Disk Kernel Write Latency AverageMilliSecond
    vmware.disk.maxQueueDepth.averageVmware Disk Max Queue Depth AverageMilliSecond
    vmware.disk.queueReadLatency.averageVmware Disk Queue Read Latency AverageMilliSecond
    vmware.disk.queueWriteLatency.averageVmware Disk Queue Write Latency AverageMilliSecond
    vmware.vm.log.sizeVmware Vm Log SizekiloBytes
    vmware.datastore.datastoreIops.averageVMware datastore IOPS averagecount
    vmware.mem.vmmemctl.average.averageVMware memory balloonkilobytes
    vmware.cpu.usagemhz.averageVMware CPU usage mhzmegahertz
    vmware.mem.swapinRate.averageVMware memory swap in ratekilobytes per second
    vmware.mem.swapoutRate.averageVMware memory swap out ratekilobytes per second
    vmware.mem.swapin.averageVMware memory swap inkilobytes
    vmware.mem.swapout.averageVMware memory swap outkilobytes