Onboarding VMware


You use Klarity's VMware Scanner to feed data to Klarity from your VMware installations.

To run the VMware Scanner, you must:

  • download and install the Scanner in your VMware environment
  • configure and deploy the Scanner
  • schedule the Scanner to run at regular intervals


Klarity's VMware Scanner is an extra feature, for which you must make an additional payment. To arrange payment, and onboarding, please contact your Nordcloud CSM for support.


The VMware Scanner supports both Windows and Linux machines (amd64).

Nordcloud does not officially support binaries for other platforms and architectures. However, for test purposes, you are permitted to compile the scanner with the Golang compiler (using the relevant GOOS and GOARCH variables).

Virtual machine

You must prepare a virtual machine with direct access to VMware's vCenter API (at least, vCenter 7).


You must arrange to have:

  • Read-only API credentials for VMware's vCenter API
  • Nordcloud Klarity Cloud Account credentials for VMware


In Klarity, it is not possible to see the cost of machines running on VMware, because no billing information is available.


  1. In vCenter, create a service user with read-only permissions for your VMware installation. Record the username and password of this service user, because you must add this information to the Scanner's configuration file.

  2. To download the relevant binary package (either Windows, or Linux) to the virtual machine, click below:

  1. The downloaded binary package includes a configuration file named as config.json.

In config.json, change the values of the keys, as follows:

vmware_api_urlDomain name or IP address of a VMware installation (for example, vmware.local)
vmware_api_usernameUsername of created service account
vmware_api_passwordPassword of created service account
  1. Copy config.json to the same location as the binary.

  2. Schedule the binary to run at a certain time during the night, for example, 1:00 UTC.

For this purpose:

  • for Windows machines, use Windows Task Scheduler
  • for Linux machines, use Crontab
  1. After configuration, first run the binary as a test. Verify with Nordcloud that the Scanner is importing estate record data as you would expect.
Edit this page on GitHub