VMware NSX-T Monitoring
Last updated on 30 September, 2024LogicMonitor’s VMware NSX-T monitoring package leverages the VMware NSX-T Data Center API to monitor and alert on metrics for clusters, cluster managers/controllers, edges, firewalls, load balancers, and other virtualized NSX-T networking components.
Compatibility
As of January 2022, LogicMonitor’s VMware NSX-T package is compatible with NSX-T API versions 2.4 – 3.2.
Note: This monitoring package may work with earlier versions of the NSX-T API, but has not yet been tested. Due to changes in the structure of the NSX-T cluster between major versions, users running API versions 2.x might be unable to collect data for some datapoints on some datasources. See VMware NSX-T API documentation.
Setup Requirements
Add resources into monitoring
Add your VMware NSX-T cluster host into monitoring. For more information on adding resources into monitoring, see Adding Devices.
Obtain credentials
LogicMonitor uses basic authentication to query the NSX-T API and must provide the appropriate credentials to access the NSX-T resource’s data. The NSX-T cluster 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. |
Refer to VMware NSX-T documentation for additional information on configuring users and roles.
Assign properties to resources
The following custom properties must be set on the VMware NSX-T resource within LogicMonitor. For more information, see Resource and Instance Properties.
Property | Value |
nsx.api.user | REST API username. |
nsx.api.pass | REST API password. |
system.category | VMware_NSX-T will be automatically added by the PropertySource addCategory_VMware_NSXT. |
Import LogicModules
From the LogicMonitor public repository, import all VMware NSX-T LogicModules, which are listed in the LogicModules in Package section of this support article. If these LogicModules are already present, make sure you have the most recent versions.
Once the LogicModules are imported (assuming all previous setup requirements have been met), data collection will automatically commence.
Considerations
When monitoring NSX-T devices, some aggregated statistics are limited by the API for how often they update. For this reason, we do not recommend customizing the data collection interval lower than the default configuration.
Troubleshooting
If there is an error, the DataSources will print the error messages to the console. You can see these errors in the output (from the Raw Data tab that displays from the Resources page for each DataSource) when manually polling data. When errors occur, the DataSources will still attempt to collect available data.
LogicModules in Package
LogicMonitor’s package for VMware NSX-T consists of the following LogicModules. For full coverage, make sure that all of these LogicModules are imported into your LogicMonitor platform.
Display Name | Type | Description |
addCategory_VMware_NSXT | PropertySource | Checks for working credentials for VMware NSX-T. Requires the properties nsx.api.user & nsx.api.pass. |
addERI_VMware_NSXT | PropertySource | Sets ERI using data from the VMware NSX-T API |
NSXT Cluster Controller Node File System | DataSource | File system usage of each cluster node. |
NSXT Cluster Manager Node File System | DataSource | File system usage of each cluster manager node. |
NSXT Cluster Nodes | DataSource | CPU and Memory of each cluster node. |
NSXT Cluster Nodes Network Status | DataSource | Displays interface statistics for transmitted and received packets. |
NSXT Edge Clusters | DataSource | Status information for NSX-T edge clusters. |
NSXT Firewall | DataSource | Firewall usage statistics per firewall section. |
NSXT Firewall Logical Router Ports | DataSource | Firewall statistics for individual logical router ports. |
NSXT IP Pools | DataSource | IP Pool usage metrics. |
NSXT Latest Backups | DataSource | Status of the most recent backups for cluster, node, and inventory. |
NSXT Load Balancer Pools | DataSource | Current operational status and transmission statistics for load balancer pools. |
NSXT Load Balancer Services | DataSource | Current operational status and transmission statistics for load balancer services. |
NSXT Load Balancer Virtual Servers | DataSource | Current operational status and transmission statistics for load balancer virtual servers. |
NSXT Logical Routers | DataSource | High availability information for Logical Routers. |
NSXT Logical Routers BGP | DataSource | Status for Tier 0 BGP neighbors. |
NSXT Management Cluster Status | DataSource | Status information for NSX-T control and management roles. |
NSXT Transport Node File System | DataSource | File system usage of each transport node. |
NSXT Transport Nodes | DataSource | CPU and Memory of each transport node. |
NSXT Transport Zones | DataSource | Monitors logical switch information for each transport zone. |
VMware_NSXT_Topology | TopologySource | Maps VMware NSX-T topologies. |
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.