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: Install the integration

  1. Select a client from the All Clients list.

  2. Go to Setup > Integrations and Apps. If there are apps/integrations already installed, it will redirect to the INSTALLED INTEGRATIONS page where all the installed integrations/apps are displayed. Click +ADD and search for VMware on the AVAILABLE INTEGRATIONS AND APPS page. Also you can use the All Categories dropdown list to search. If there are no installed apps, it will navigate to the AVAILABLE INTEGRATIONS AND APPS page.

  3. Click ADD on the VMware tile.

  4. Enter the gateway profile name or select a gateway profile on the Installation tab and click NEXT.
    Note: The selected gateway should be up and running.
    Provide all details related to the device.

  5. Name: Configuration name

  6. IP Address: IP Address of the vCenter

  7. CredentialSet: You can select a credential from the list or add a credential.
    To add a credential:

    1. Click the +ADD option available in the CredentialSet dropdown. The ADD CREDENTIAL window 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 domain\username.
      • 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.
    2. Click ADD to add the credential to the credential list.

  8. vCenter Plug-ins Configurations: Enable the vSAN checkbox.

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

    ALL: All the existing and future resources will be discovered.
    SELECT: You can select one or multiple resources to be discovered.

  11. ACTIONS_LABEL: Select the Manage Device option, if you want the discovered devices to be managed.

  12. 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)

  13. Event Schedule: Enable the Event Schedule checkbox.

    • Event Schedule option will be shown 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.
  1. Click FINISH.

The VMware integration is installed and displayed on the INSTALLED INTEGRATIONS page.

Step 2: View VMware details

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

Step 3: 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.