Skip to main content

vSphere

Visualize vSphere data and monitor changes through queries and alerts.

Installation​

This integration supports VMware vSphere versions 6.5–8.0. Some data types are only available on newer versions:

  • VM Guest Identity: vSphere 6.7.0 and newer
  • Namespace ingestion: vSphere 7.0.0 and newer
  • Distributed Switch ingestion: vSphere 7.0.0 and newer

Prerequisites​

  1. Access to a VMware vCenter instance with a service account that has the Read-Only role assigned at the root of the vCenter inventory (propagated to all children). The integration reads all inventory data using this account, and the vCenter list endpoints return only the objects this account has permission to see. The Read-Only role is a predefined, permanent role that allows viewing the state and details of an object.

    To assign the role in the vSphere Client:

    1. Create or choose a Single Sign-On user or group under Administration > Single Sign On > Users and Groups.
    2. Select the root inventory object (your vCenter), open the Permissions tab, and click Add Permission.
    3. Choose the user or group, select the Read-only role, and enable Propagate to children.
    note

    Namespace and distributed switch ingestion (vSphere 7.0.0 and newer) require the same Read-Only role propagated to the cluster objects, which satisfies the base privileges those endpoints check.

  2. Your vCenter credentials:

    • The vCenter domain (hostname), for example vcenter.sddc-X-YY-ZZ-F.vmwarevmc.com
    • The service account login and password

Configuration in JupiterOne​

To install the VMware vSphere integration in JupiterOne, navigate to Integrations, select VMware vSphere, and click New Instance.

Creating an instance requires the following:

  • Account Name — a display name for this vSphere account in JupiterOne. Ingested entities will have this value stored in tag.AccountName when the AccountName toggle is enabled.
  • Description — optional label for this integration instance.
  • Polling Interval — how often JupiterOne collects data from vSphere. Set to DISABLED to run manually.
  • vSphere Domain — the hostname of your vCenter server (for example, vcenter.sddc-X-YY-ZZ-F.vmwarevmc.com for a VMware Cloud-hosted vCenter).
  • vCenter Login — the login or email address of the service account.
  • vCenter Password — the password for the service account.

Click Create once all required values are provided.

Optional configuration​

FieldDescriptionDefault
Uses NSXWhen enabled, the integration queries distributed switch compatibility using VMware NSX (NSXT_CONTAINER_PLUGIN) as the network provider instead of standard vSphere networking. Enable this if your environment uses VMware NSX for Kubernetes workload networking.Disabled
Disable TLS VerificationWhen enabled, TLS certificate verification is skipped for connections to the vCenter host. Use this only for vCenter hosts that cannot present a valid certificate (for example, those using self-signed certificates).Disabled
caution

Disabling TLS verification reduces transport security. Use a valid TLS certificate on your vCenter host whenever possible.

Next steps​

Once configured, the integration will run on the polling interval you selected and populate vSphere inventory data in JupiterOne. See the Instance management guide to learn how to edit or disable an integration instance.