VMware NSX Monitoring

Last updated on 27 March, 2023


LogicMonitor’s VMware NSX monitoring package leverages the VMware NSX Data Center for vSphere API to monitor and alert on metrics for manager, controllers, and edges.


As of October 2020, LogicMonitor’s VMware NSX package is known to be compatible with NSX for vSphere API 6.4. It may work with earlier versions, but this has not been explicitly tested.

Setup Requirements

Add Resources Into Monitoring

Add your VMware NSX Manager host into monitoring. For more information on adding resources into monitoring, see Adding Devices.

Obtain Credentials

LogicMonitor uses basic authentication to query the NSX for vSphere API and must provide the appropriate credentials in order to successfully access the NSX resource’s data. The NSX Manager requires port 443/TCP to be open between host and Collector for REST API requests.

These credentials must belong to a user account that has been assigned the following minimum permissions:

Role Description
Read-only All API calls made in this package are compatible with read-only access.

Please refer to VMware NSX documentation for additional information on configuring users and roles.

Assign Properties to Resources

The following custom properties must be set on the VMware NSX resource within LogicMonitor. For more information on setting properties, see Resource and Instance Properties.

Property Value
nsx.api.user REST API username
nsx.api.pass REST API password
system.categories VMware_NSX (this value will be automatically added by the addCategory_VMware_NSX PropertySource)

Import LogicModules

From the LogicMonitor public repository, import all VMware NSX LogicModules, which are listed in the LogicModules in Package section of this support article. If these LogicModules are already present, ensure you have the most recent versions.

Once the LogicModules are imported (assuming all previous setup requirements have been met), modules will be automatically applied to devices through Active Discovery.


When monitoring NSX Edge interfaces, note that the API updates values for traffic every five minutes. For this reason, we do not recommend customizing the data collection intervals of associated DataSources to anything more frequent than every five minutes. Doing so will result in duplicate values in polls.


The modules in this package are designed with a debug mode embedded in the data collection scripts. If issues occur, turn on debug mode by setting the variable debug to “true” to get more information in the output when testing the script in the Collector Debug Facility. For more information on testing scripts in the Collector Debug Facility, see Script Troubleshooting.

LogicModules in Package

LogicMonitor’s package for VMware NSX consists of the following LogicModules. For full coverage, please ensure that all of these LogicModules are imported into your LogicMonitor platform.

Note: This package includes ConfigSources (configuration file monitoring LogicModules). If the ability to monitor and alert on configuration files is not currently available in your LogicMonitor platform and you would like to learn more, reach out to your customer success manager. For more information on ConfigSources, see Creating ConfigSources.

Display Name Type Description
addCategory_VMware_NSX PropertySource Checks for working API credentials and adds “VMware_NSX” to the system.categories property.
VMware_NSX_ManagerInfo PropertySource Adds basic info for NSX Manager using VMware NSX for vSphere API 6.4.
NSX Manager Component Status DataSource Provides information about NSX manager component status.
NSX Manager Utilization DataSource Provides information about NSX manager CPU, memory, and disk utilization.
NSX Controllers DataSource Provides information about NSX controller usage statistics and node failover status.
NSX Controllers Uptime DataSource Provides information about NSX controller uptime and sync status.
NSX Controller Cluster Configs ConfigSource NSX controller cluster info including DNS, NTP, and syslog.
NSX Edge Health DataSource Provides information about NSX edge state and status.
NSX Edge Interfaces DataSource Provides information about NSX edge interface statistics.
NSX Edge Configs ConfigSource NSX edge configuration info including firewall, NAT, routing, bridging, loadbalancer, DHCP, high availability, and SSL VPN.

When setting static datapoint thresholds on the various metrics tracked by this package’s DataSources, LogicMonitor follows the technology owner’s best practice KPI recommendations. If necessary, we encourage you to adjust these predefined thresholds to meet the unique needs of your environment. For more information on tuning datapoint thresholds, see Tuning Static Thresholds for Datapoints.

In This Article