Supported Versions
NSX-T REST API 3.1.2
NSX-V REST API 6.4

VMware NSX-T™ Data Center provides a software-defined infrastructure for data center and enterprise application environments. NSX-T Data Center focuses on providing networking, security, automation, and operational simplicity for emerging application frameworks and architectures that have heterogeneous endpoint environments and technology stacks.

OpsRamp enables seamless integration with NSX -T and NSX-V, and enables monitoring of different NSX deployments.

Prerequisites

Classic gateway 10.0 and above, or cluster gateway, is required.

Ensure that Adapter Integrations is enabled in the respective partner and client setup. This can be done from partner and client settings when you set up your account, as described in the following steps:

  1. Select Adapter Integrations:

    Image
  2. Choose ADDONS:

    Image
  3. After adapter integration is enabled, you can view the available integrations in Setup > Integrations > Integrations and click the Adapter tab:

    Image

Step 1: Install the integration

  1. From All Clients, select a client.

  2. Go to Setup > Integrations > Integrations.

  3. In Available Integrations, select Adapter > VMware NSX-T or VMware NSX-V.

  4. In Install Integration, enter:

    ParameterDescription
    NameName of the integration.
    Upload Logo(optional) Logo for the integration.
    Gateway ProfileChoose a gateway management profile to associate with the client.
  5. Click Install. The Integration page displays the installed integration in the CONFIGURATION section.

Step 2: Configure the integration

  1. In the CONFIGURATION section, click + Add.

  2. Enter:

    • Configuration name
    • NSX Manager IP Address
    • Port
    • Protocol

  3. In the Credentials section, select Custom and enter the Client Id and secret.

  4. In the Resource Types & Metrics section, select the metrics you want and configure for availability and alert conditions.

  5. In the Discovery Schedule section, select Recurrence Pattern to add one of the following patterns:

    • Hourly
    • Daily
    • Weekly
    • Monthly

  6. In the Monitoring Schedule section, select the target device monitoring frequency. The default frequency is five minutes.

  7. Click Save.

After saving the integration, NSX resources are discovered and monitoring is enabled as specified by the configuration profile.

Discovered resources can be viewed on the Infrastructure page.

Supported metrics for NSX-T

Metric NameMetric Display NameUnits
nsxt_edgecluster_Status

Returns the aggregated status for Edge Cluster
Possible values: Up, Down, Degraded, Unknown
NSXT EdgeCluster Status
nsxt_edgenode_physicalinterface_AdminStatus

EdgeNode Network Interface Admin Status.
Possible values: Up, Down, Degraded, Unknown
NSXT EdgeNode Physical Interface Admin Status
nsxt_edgenode_physicalinterface_LinkStatus

EdgeNode Physical Interface Link Status.
Possible values: Up, Down, Degraded, Unknown
NSXT EdgeNode Physical Interface Link Status
nsxt_firewall_RuleCount

Number of Rules associated with a Firewall
NSXT Firewall Rule Countcount
nsxt_firewall_SectionCount

Number Of sessions within a firewall returns Total Number Of Sections available for a Firewall
NSXT Firewall Section Countcount
nsxt_hostnode_physicalinterface_AdminStatus

HostNode Network Interface Admin Status.
Possible values: Up, Down, Degraded, Unknown
NSXT HostNode Physical Interface Admin Status
nsxt_hostnode_physicalinterface_LinkStatus

HostNode Network Interface Link Status.
Possible values: Up, Down, Degraded, Unknown
NSXT HostNode Physical Interface Link Status
nsxt_logicalswitch_DroppedReceivedPackets

Number of received packets received by Logical Switch
NSXT LogicalSwitch Dropped Received Packetscount
nsxt_logicalswitch_DroppedTransmittedPackets

Number of transmitted packets dropped by Logical Switch
NSXT LogicalSwitch Dropped Transmitted Packetscount
nsxt_logicalswitch_FullyRealizedSwitchCount

Number of Logical switches in fully realized state
NSXT LogicalSwitch Fully Realized Switch Countcount
nsxt_logicalswitch_LogicalPortCount

Number of Logical ports associated with a logical switch
NSXT LogicalSwitch LogicalPorts Countcount
nsxt_logicalswitch_TotalReceivedBytes

Number of transmitted packets dropped by Logical Switch
NSXT LogicalSwitch Total Received Byttesbytes
nsxt_logicalswitch_TotalReceivedPackets

Number of packets received by Logical Switch
NSXT LogicalSwitch Total Received Packetscount
nsxt_logicalswitch_TotalSwitchCount

Total Number of Logical Switches
NSXT LogicalSwitch Total Countcount
nsxt_logicalswitch_TotalTransmittedBytes

Number of bytes transmitted by Logical Switch
NSXT LogicalSwitch Total Transmitted Bytesbytes
nsxt_logicalswitch_TotalTransmittedPackets

Total number of Packets transmitted by Logical Switch
NSXT LogicalSwitch Total Transmitted Packetscount
nsxt_manager_CPUCount

Total Number Of CPU's on the NSXT Manager
NSXT Manager CPU Countcount
nsxt_manager_ControllerNodeStatus

Defines whether controller node is running or not
NSXT Manager ControllerNodeStatus
nsxt_manager_CpuPercentageUtilization

fifteen minute load averages for the system utilization
NSXT Manager CPU Percentage Utiizationpercent
nsxt_manager_FilesystemUtlization

FileSystems utilization on the VMware NSXT Manager
NSXT Manager Filesyestem Utilizationpercent
nsxt_manager_FreeMemory

The amount of free memory on the VMware NSXT Manager
NSXT Manager Free Memorykilobytes
nsxt_manager_MemoryUtilization

The amount of memory used by the VMware NSXT Manager in percentage
NSXT Manager Memory Utilizationpercent
nsxt_manager_TotalMemory

The amount of Total memory on the VMware NSXT Manager
NSXT Manager Total Memorykilobytes
nsxt_manager_UsedMemory

The amount of Used memory on the VMware NSXT Manager
NSXT Manager Used Memorykilobytes
nsxt_managercluster_BackupConfiguration

Get backup configuration,Get a configuration of a file server and timers for automated backup. Fields that contain secrets (password, passphrase) are not returned.
NSX Manager Backup Configurationper hour
nsxt_transportNode_BfdAdminDownCount

Returns Bidirectional Forwarding Admin Down Count
NSXT TransportNode BFD Admin Down Countcount
nsxt_transportNode_BfdAdministrativelyDownCount

Returns BFD Administrative Path Down Count
NSXT TransportNode BFD Administrative Path Down Countcount
nsxt_transportNode_BfdConcatenatedPathDownCount

Returns BFD Concatenated Path Down Count
NSXT TransportNode BFD Concatenated Path Down Countcount
nsxt_transportNode_BfdControlDetectionTimeExpiredCount

Returns Bidirectional Forwarding Control Detection TimeExpired Count
NSXT TransportNode BFD Control Detection TimeExpired Countcount
nsxt_transportNode_BfdDownCount

Returns Bidirectional Forwarding Down Count
NSXT TransportNode BFD Down Countcount
nsxt_transportNode_BfdEchoFunctionFailedCount

Returns Bidirectional Forwarding Detection Of Echo Function Failed Count
NSXT TransportNode BFD Echo Function Failed Countcount
nsxt_transportNode_BfdForwardPlaneResetCount

Returns BFD Forward Plane Reset Count
NSXT TransportNode BFD Echo Function Failed Countcount
nsxt_transportNode_BfdInitCount

Returns Bidirectional Forwarding Init Count
NSXT TransportNode BFD Init Countcount
nsxt_transportNode_BfdNeighbourSignalledSessionDownCount

Returns BFD Neighbour Signalled Session Down Count
NSXT TransportNode BFD Neighbour Signalled Session Down Countcount
nsxt_transportNode_BfdNoDiagnosticCount

Returns Bidirectional Forwarding NoDiagnostic Count
NSXT TransportNode BFD No Diagnostic Countcount
nsxt_transportNode_BfdPathDownCount

Returns BFD Path Down Count
NSXT TransportNode BFD Path Down Countcount
nsxt_transportNode_BfdReverseConcatenatedPathDownCount

Returns BFD Reverse Concatenated Path Down Count
NSXT TransportNode BFD Reverse Concatenated Path Down Countcount
nsxt_transportNode_BfdUpCount

Returns Bidirectional Forwarding Up Count
NSXT TransportNode BFD Up Countcount
nsxt_transportNode_DataPathHeapUsage

Returns Heap usage of data path of a Transport Node
NSXT TransportNode Data Path Heap Usagepercent
nsxt_transportNode_DataPathTotalUsage

Returns Total usage of data path of a Transport Node
NSXT TransportNode Data Path Total Usagepercent
nsxt_transportNode_LCPConnectionStatus

Returns the connection status of transportnode with local control plane
Possible values: Up, Down, Unknown, Degraded
NSXT TransportNode LCP Connection Status
nsxt_transportNode_MPAConnectionStatus

Returns the connection status of transportnode with Management Plane Agent
Possible values: Up, Down, Unknown, Degraded
NSXT TransportNode MPA Connection Status
nsxt_transportNode_PnicDegradedCount

Returns Count of Physical NIC's in Degraded State
NSXT TransportNode PNIC Degraded Countcount
nsxt_transportNode_PnicDownCount

Returns Physical NIC's Down Count
NSXT TransportNode PNIC Down Countcount
nsxt_transportNode_PnicStatus

TransportNode PNIC Status.
Possible values: Up, Down, Unknown and Degraded
NSXT TransportNode PNIC Status
nsxt_transportNode_PnicUpCount

Returns Physical NIC's Up Count
NSXT TransportNode PNIC Up Countcount
nsxt_transportNode_Status

TransportNode Status.
Possible values: Up, Down, Unknown and Degraded
NSXT TransportNode Status
nsxt_transportNode_TunnelDownCount

Returns Tunnel Count which are in Down State
NSXT TransportNode Tunnel Down Countcount
nsxt_transportNode_TunnelStatus

Defines Connectivity Status Of a TransportNode with Another Remote TransportNodes
Possible values: Up, Down, Unknown, Degraded
NSXT TransportNode Tunnel Status
nsxt_transportNode_TunnelUpCount

Returns Tunnel Count which are in Up State
NSXT TransportNode Tunnel Up Countcount
nsxt_transportnode_AvgDpdkCpuCoreUtilization

Average Utilization of DPDK CPU cores in a TransportNode
NSXT TransportNode Avg Dpdk Cpu Core Utilizationpercent
nsxt_transportnode_AvgNonDpdkCpuCoreUtilization

Average Utilization of Non-DPDK CPU cores in a TransportNode
NSXT TransportNode Avg Non Dpdk Cpu Core Utilizationpercent
nsxt_transportnode_CacheMemory

Cache Memory allocated to a TransportNode
NSXT TransportNode Cache Memorymegabytes
nsxt_transportnode_CacheUtilization

Cache Memory Utilization of a TransportNode
NSXT TransportNode Cache Utilizationpercent
nsxt_transportnode_CpuCoresCount

The number of CPU cores in a TransportNode
NSXT TransportNode Cpu Cores Countcount
nsxt_transportnode_DpdkCpuCoresCount

The number of DPDK CPU cores in a TransportNode
NSXT TransportNode Dpdk Cpu Cores Countcount
nsxt_transportnode_FileSystemUtlization

File System Utilization Of a TransportNode
NSXT TransportNde FileSystem Utilizationpercent
nsxt_transportnode_HighestDpdkCpuCoreUtilization

Highest Utilization of DPDK CPU cores in a TransportNode
NSXT TransportNode Highest Dpdk Cpu Core Utilizatonpercent
nsxt_transportnode_HighestNonDpdkCpuCoreUtilization

Highest Utilization of Non-DPDK CPU cores in a TransportNode
NSXT TransportNode Highest Non Dpdk Cpu Core Utilizatonpercent
nsxt_transportnode_LoadAverages

fifteen minute load averages for the system utilization
NSXT TransportNode Load Averagespercent
nsxt_transportnode_NonDpdkCpuCoresCount

The number of NON-DPDK CPU cores in a TransportNode
NSXT TransportNode Non Dpdk Cpu Cores Countcount
nsxt_transportnode_SwapUtilization

Swap Memory utilization of a TransportNode
NSXT TransportNode Swap Utilizationpercent
nsxt_transportnode_SystemMemoryUtilization

Total Memory utilization of a TransportNode
NSXT TransportNode System Memory Utilizationpercent
nsxt_transportnode_TotalDiskSpace

Total Disk Space of a TransportNode
NSXT TransportNode Total Disk Spacekilobytes
nsxt_transportnode_TotalMemory

Total Memory allocated to a TransportNode
NSXT TransportNode Total Memorymegabytes
nsxt_transportnode_UsedDiskSpace

NSXT TransportNode Used Disk Space
NSXT TransportNode Used Disk Spacekilobytes
nsxt_transportnode_UsedMemory

Amount of memory used by a Transport Node
NSXT TransportNode Used Memorymegabytes
nsxt_transportnodes_DegradedCount

The number of transport nodes in DegradedState
NSXT TransportNodes Degraded Countcount
nsxt_transportnodes_DownCount

The number of transport nodes are down
NSXT TransportNodes Down Countcount
nsxt_transportnodes_UnknownStateCount

The number of transport nodes in Unknown State
NSXT TransportNodes Unknown State Countcount
nsxt_transportnodes_UpCount

The number of transport nodes are running
NSXT TransportNodes Up Countcount
nsxt_transportzone_DegradedCount

The number of transport zones in DegradedState
NSXT TransportZone Degraded Countcount
nsxt_transportzone_DownCount

The number of transport zones are down
NSXT TransportZone Down Countcount
nsxt_transportzone_LogicalSwitchesCount

The number of logicalswitches associated with a transportzone
NSXT TransportZone LogicalSwitches Countcount
nsxt_transportzone_TransportNodeCount

The number of transportnodes associated with a transportzone
NSXT TransportZone TransportNode Countcount
nsxt_transportzone_UnknownStateCount

The number of transport zones in Unknown State
NSXT TransportZone Unknown Countcount
nsxt_transportzone_UpCount

The number of transport zones are running
NSXT TransportZone Up Countcount
nsxt_virtualMachine_Status

VirtualMachine Status.
Possible values: VM_Running, VM_Stopped
NSXT VirtualMachine Status

Supported metrics for NSX-V

Metric NameMetric Display NameUnits
nsxv_controller_Status

The status of the VMware NSX controller.
Possible values: 0 = NOT_RUNNING, 1 = RUNNING
NSXV Controller Status
nsxv_edgeFirewall_ICMP6TimeOut

The Edge Firewall configuration for ICMP6 timeout.
NSXV Edge Firewall ICMP6 Timeoutseconds
nsxv_edgeFirewall_ICMPTimeOut

The Edge Firewall configuration for ICMP timeout.
NSXV Edge Firewall ICMP Timeoutseconds
nsxv_edgeFirewall_IPGenericTimeOut

The Edge Firewall configuration for IP generic timeout.
NSXV Edge Firewall IP Genreric Timeoutseconds
nsxv_edgeFirewall_TCPAllowOutofWindowPackets

The Edge Firewall configuration for TCP allows out-of-window packets status.
Possible values: 0 = False, 1 = True
NSXV Edge Firewall TCP Allow Out Of Window Packets
nsxv_edgeFirewall_TCPPickOngoingConnections

The Edge Firewall configuration for TCP pick ongoing connections status.
Possible values: 0 = False, 1 = True
NSXV Edge Firewall TCP Pick Ongoing Connections
nsxv_edgeFirewall_TCPSendResetForClosedVsePorts

The Edge Firewall configuration for TCP sends reset for closed VSE ports status.
Possible values: 0 = False, 1 = True
NSXV Edge Firewall TCP Send Reset For Closed Vse Ports
nsxv_edgeFirewall_TCPTimeoutClose

The Edge Firewall configuration for TCP timeout to close.
NSXV Edge Firewall TCP Timeout Closeseconds
nsxv_edgeFirewall_TCPTimeoutOpen

The Edge Firewall configuration for TCP timeout to open.
NSXV Edge Firewall TCP Timeout Openseconds
nsxv_edgeFirewall_UDPTimeOut

The Edge Firewall configuration for UDP timeout.
NSXV Edge Firewall UDP Timeoutseconds
nsxv_edgeVnic_EnableProxyArp

Enabled state of proxy ARP on VNIC.
Possible values: 0 = False, 1 = True
NSXV Edge VNIC Enable Proxy Arp
nsxv_edgeVnic_EnableSendRedirects

Enable state of redirects on VNIC.
Possible values: 0 = False, 1 = True
NSXV Edge VNIC Enable Send Redirects
nsxv_edgeVnic_IsConnected

The connection state of the VNIC.
Possible values: 0 = False, 1 = True
NSXV Edge VNIC Is Connected
nsxv_edgeVnic_MTU

The MTU on the VNIC.
NSXV Edge VNIC MTUcount
nsxv_edge_EdgeStatus

The status of the edge.
Possible values: 1 = GREEN, 2 = YELLOW, 3 = RED, 4 = GREY
NSXV Edge EdgeStatus
nsxv_edge_State

The state of the gateway.
Possible values: 1 = Deployed
NSXV Edge State
nsxv_manager_CPUUsageIndicator

The CPU utilization status on the VMware NSX Manager.
Possible values: 0 = Low, 1 = High
NSXV Manager CPU Usage Indicator
nsxv_manager_CPUUtilization

The percentage of CPU capacity utilization on the VMware NSX Manager
NSXV Manager CPU Capacity Utilizationpercent
nsxv_manager_FreeCPUCapacity

The amount of free CPU capacity on the VMware NSX Manager
NSXV Manager Free CPU CapacityMHz
nsxv_manager_FreeMemory

The amount of free memory on the VMware NSX Manager
NSXV Manager Free Memorymegabytes
nsxv_manager_FreeStorage

The amount of free storage on the VMware NSX Manager
NSXV Manager Free Storagegigabytes
nsxv_manager_MemoryUtilization

The percentage of memory utilization on the VMware NSX Manager
NSXV Manager Memory Utilizationpercent
nsxv_manager_ServerServiceStatus

The status of services running on the VMware NSX Manager.
Possible values: 0 = NOT_RUNNING, 1 = RUNNING
NSXV Manager Server Services Status
nsxv_manager_StorageUtilization

The percatage of storage utlization on the VMware NSX Manager
NSXV Manager Storage Utilizationpercent
nsxv_manager_UpTime

The appliance uptime.
NSXV Manager UpTimehours
nsxv_manager_UsedCPUCapacity

The amount of used CPU capacity on the VMware NSX Manager
NSXV Manager Used CPU CapacityMHz
nsxv_manager_UsedMemory

The amount of used memory on the VMware NSX Manager
NSXV Manager Used Memorymegabytes
nsxv_manager_UsedStorage

The amount of used storage on the VMware NSX Manager
NSXV Manager Used Storagegigabytes
nsxv_manager_VCenterConnected

The vCenter Server connection status.
Possible values: 0 = False, 1 = True
NSXV Manager VCenter Connected