Introduction
VMware NSX-T™ Data Center provides an agile software-defined infrastructure to build cloud-native 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.
VMware NSX
VMware NSX is a network virtualization and security platform that enables the virtual cloud network, a software-defined approach to networking that extends across data centers, clouds and application frameworks.
VMware NSX is suitable for all infrastructure types:
- Multi-cloud environments
- On-premises data centers
- Bare metal servers
- Containerized workloads
Benefits of NSX-T
The main benefit is that NSX-T can be deployed in heterogeneous environments with many different components. NSX-T is not under the confines of the vCenter deployment. You can have multiple vCenter servers and use one NSX manager as a single pane of glass for controlling your virtual network. Or, you do not have to deploy a vCenter at all. Instead, you can choose ESXi as the operating system in the NSX-T GUI.
NSX-T Main Components:
The primary components of VMware NSX-T are:
NSX-T Manager: provides graphical user interface (GUI) and RESTful API for creating, configuring, and monitoring NSX-T components, such as segments and gateways.
NSX-T Controller: they are responsible for the programmatic deployment of virtual networks across the entire NSX-T architecture, and control the virtual networks and overlay transport tunnels.
NSX-T Edges: provides routing services and connectivity to networks that are external to the NSX-T deployment.
Logical Firewall: NSX-T handles traffic in and out of the network according to firewall rules.
Logical Routers (Gateways): NSX-T Gateways provide North-South connectivity so that workloads can access external networks and East-West connectivity between different logical networks.
Transport Zone: A transport zone defines a collection of hosts that can communicate with each other across a physical network infrastructure.
Prerequisites
- OpsRamp Classic Gateway 14.0.0 and above.
- OpsRamp Nextgen Gateway 14.0.0 and above.
Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.
Supported Target Version |
---|
Application validated against target versions 3.2.0 and 4.0.0 |
REST API version using 3.2.0 |
REST API version 4.0.0 |
Hierarchy of NSX-T resources
NsxT Manager Cluster
– NsxT Manager (i.e, nodes)
– NsxT Edge Cluster
– NsxT Logical Router
– NsxT Firewall
– NsxT Transport Zone
– NsxT Transport Node (i.e, Host(ESXi) nodes & Edge nodes)
– NsxT Edge Physical Network Interface
– NsxT Host Physical Network Interface
– NsxT Virtual Machine (i.e, Host & Edge VMs)
– NsxT Logical Switch
Supported Metrics
Click here to view the supported metrics
Native Type | Metric Name | Metric Display Name | Metric Label | Units | Application Version | Description |
---|---|---|---|---|---|---|
NsxT Edge Cluster | nsxt_edgecluster_Status | NSXT EdgeCluster Status | Availability | — | 2.0.0 | Returns the aggregated status for Edge Cluster Possible values: Up, Down, Degraded, Unknown. |
NsxT Edge Physical Network Interface | nsxt_edgenode_physicalinterface_AdminStatus | NSXT EdgeNode Physical Interface Admin Status | Availability | — | 2.0.0 | EdgeNode Network Interface Admin Status. Possible values: Up, Down, Degraded, Unknown. |
nsxt_edgenode_physicalinterface_LinkStatus | NSXT EdgeNode Physical Interface Link Status | Availability | — | 2.0.0 | EdgeNode Physical Interface Link Status. Possible values: Up, Down, Degraded, Unknown. | |
nsxt_edgenode_physicalinterface_TotalTransmittedPackets | NSXT EdgeNode Physical Interface Total Transmitted Packets | Availability | count | 8.0.0 | Number of packets transmitted. | |
nsxt_edgenode_physicalinterface_DroppedTransmittedPackets | NSXT EdgeNode Physical Interface Dropped Transmitted Packets | Availability | count | 8.0.0 | Number of transmitted packets dropped. | |
nsxt_edgenode_physicalinterface_TotalReceivedPackets | NSXT EdgeNode Physical Interface Total Received Packets | Availability | count | 8.0.0 | Number of packets received. | |
nsxt_edgenode_physicalinterface_DroppedReceivedPackets | NSXT EdgeNode Physical Interface Dropped Received Packets | Availability | count | 8.0.0 | Number of received packets dropped. | |
nsxt_edgenode_physicalinterface_TotalTransmittedBytes | NSXT EdgeNode Physical Interface Total Transmitted Bytes | Availability | GB | 8.0.0 | Number of bytes transmitted. | |
nsxt_edgenode_physicalinterface_TotalReceivedBytes | NSXT EdgeNode Physical Interface Total Received Bytes | Availability | GB | 8.0.0 | Number of bytes received. | |
nsxt_edgenode_physicalinterface_ReceiveErrors | NSXT EdgeNode Physical Interface Receive Errors | Availability | count | 8.0.0 | Number of receive errors. | |
nsxt_edgenode_physicalinterface_TransmitErrors | NSXT EdgeNode Physical Interface Transmit Errors | Availability | count | 8.0.0 | Number of transmit errors. | |
nsxt_edgenode_physicalinterface_Collisions | NSXT EdgeNode Physical Interface Collision | Availability | count | 8.0.0 | Number of collisions detected. | |
nsxt_edgenode_physicalinterface_CarrierLoss | NSXT EdgeNode Physical Interface Carrier Loss | Availability | count | 8.0.0 | Number of carrier losses detected. | |
NsxT Firewall | nsxt_firewall_RuleCount | NSXT Firewall Rule Count | Usage | count | 2.0.0 | Number of Rules associated with a Firewall. |
nsxt_firewall_SectionCount | NSXT Firewall Section Count | Usage | count | 2.0.0 | Number Of sessions within a firewall returns. Total Number Of Sections available for a Firewall. | |
NsxT Host Physical Network Interface | nsxt_hostnode_physicalinterface_AdminStatus | NSXT HostNode Physical Interface Admin Status | Availability | — | 2.0.0 | HostNode Network Interface Admin Status. Possible values: Up, Down, Degraded, Unknown. |
nsxt_hostnode_physicalinterface_LinkStatus | NSXT HostNode Physical Interface Link Status | Availability | — | 2.0.0 | HostNode Network Interface Link Status. Possible values: Up, Down, Degraded, Unknown. | |
nsxt_hostnode_physicalinterface_TotalTransmittedPackets | NSXT HostNode Physical Interface Total Transmitted Packets | Availability | count | 8.0.0 | Number of packets transmitted | |
nsxt_hostnode_physicalinterface_DroppedTransmittedPackets | NSXT HostNode Physical Interface Dropped Transmitted Packets | Availability | count | 8.0.0 | Number of transmitted packets dropped | |
nsxt_hostnode_physicalinterface_TotalReceivedPackets | NSXT HostNode Physical Interface Total Received Packets | Availability | count | 8.0.0 | Number of packets received | |
nsxt_hostnode_physicalinterface_DroppedReceivedPackets | NSXT HostNode Physical Interface Dropped Received Packets | Availability | count | 8.0.0 | Number of recieved packets dropped | |
nsxt_hostnode_physicalinterface_TotalTransmittedBytes | NSXT HostNode Physical Interface Total Transmitted Bytes | Availability | GB | 8.0.0 | Number of bytes transmitted | |
nsxt_hostnode_physicalinterface_TotalReceivedBytes | NSXT HostNode Physical Interface Total Received Bytes | Availability | GB | 8.0.0 | Number of bytes received. | |
nsxt_hostnode_physicalinterface_ReceiveErrors | NSXT HostNode Physical Interface Receive Errors | Availability | count | 8.0.0 | Number of receive errors. | |
nsxt_hostnode_physicalinterface_TransmitErrors | NSXT HostNode Physical Interface Transmit Errors | Availability | count | 8.0.0 | Number of transmit errors. | |
nsxt_hostnode_physicalinterface_Collisions | NSXT HostNode Physical Interface Collisions | Availability | count | 8.0.0 | Number of collisions detected. | |
nsxt_hostnode_physicalinterface_CarrierLoss | NSXT HostNode Physical Interface Carrier Loss | Availability | count | 8.0.0 | Number of carrier losses detected. | |
NsxT Logical Switch | nsxt_logicalswitch_DroppedReceivedPackets | NSXT LogicalSwitch Dropped Received Packets | Usage | count | 2.0.0 | Number of received packets received by Logical Switch. |
nsxt_logicalswitch_DroppedTransmittedPackets | NSXT LogicalSwitch Dropped Transmitted Packets | Usage | count | 2.0.0 | Number of transmitted packets dropped by Logical Switch. | |
nsxt_logicalswitch_FullyRealizedSwitchCount | NSXT LogicalSwitch Fully Realized Switch Count | Usage | count | 2.0.0 | Number of Logical switches in fully realized state | |
nsxt_logicalswitch_LogicalPortCount | NSXT LogicalSwitch LogicalPorts Count | Usage | count | 2.0.0 | Number of Logical ports associated with a logical switch | |
nsxt_logicalswitch_TotalReceivedBytes | NSXT LogicalSwitch Total Received Byttes | Usage | GB | 2.0.0 | Number of transmitted packets dropped by Logical Switch | |
nsxt_logicalswitch_TotalReceivedPackets | NSXT LogicalSwitch Total Received Packets | Usage | count | 2.0.0 | Number of packets received by Logical Switch | |
nsxt_logicalswitch_TotalSwitchCount | NSXT LogicalSwitch Total Count | Usage | count | 2.0.0 | Total Number of Logical Switches | |
nsxt_logicalswitch_TotalTransmittedBytes | NSXT LogicalSwitch Total Transmitted Bytes | Usage | GB | 2.0.0 | Number of bytes transmitted by Logical Switch | |
nsxt_logicalswitch_TotalTransmittedPackets | NSXT LogicalSwitch Total Transmitted Packets | Usage | count | 2.0.0 | Total number of Packets transmitted by Logical Switch | |
NsxT Manager | nsxt_manager_CPUCount | NSXT Manager CPU Count | Usage | count | 2.0.0 | Total Number Of CPU's on the NSXT Manager |
nsxt_manager_DiskSpaceUsed | NSXT Manager Disk Space Used | Usage | GB | 10.0.0 | Amount of disk space in use on the system | |
nsxt_manager_DiskSpaceTotal | NSXT Manager Disk Space Total | Usage | GB | 10.0.0 | Amount of disk space available on the system | |
nsxt_manager_DiskSpaceUtilization | NSXT Manager Disk Space Utilization | Usage | % | 10.0.0 | The Percentage of Disk Space utilized | |
nsxt_manager_ControllerNodeStatus | NSXT Manager ControllerNodeStatus | Availability | — | 2.0.0 | Defines whether controller node is running or not | |
nsxt_manager_CpuPercentageUtilization | NSXT Manager CPU Percentage Utiization | percent | 2.0.0 | Fifteen minute load averages for the system utilization | ||
nsxt_manager_FilesystemUtlization | NSXT Manager Filesyestem Utilization | Usage | percent | 2.0.0 | FileSystems utilization on the VMware NSXT Manager | |
nsxt_manager_FreeMemory | NSXT Manager Free Memory | Usage | kilobytes | 2.0.0 | The amount of free memory on the VMware NSXT Manager | |
nsxt_manager_MemoryUtilization | NSXT Manager Memory Utilization | Usage | percent | 2.0.0 | The amount of memory used by the VMware NSXT Manager in percentage | |
nsxt_manager_TotalMemory | NSXT Manager Total Memory | Usage | kilobytes | 2.0.0 | The amount of Total memory on the VMware NSXT Manager. | |
nsxt_manager_UsedMemory | NSXT Manager Used Memory | Usage | kilobytes | 2.0.0 | The amount of Used memory on the VMware NSXT Manager. | |
nsxt_manager_CPUUtilization | NSXT Manager CPU Utilization | Usage | Percentage | 2.0.0 | Fifteen minute load averages for the system utilization | |
nsxt_manager_ControllerStatus | NSXT Manager Controller Status | — | 2.0.0 | Controller Status. Possible values are Running(1),Not Running(0) | ||
NsxT Manager Cluster | nsxt_managercluster_BackupConfiguration | NSX Manager Backup Configuration | Usage | per hour | 2.0.0 | Get backup configuration,get a configuration of a file server and timers for automated backup. Fields that contain secrets (password, passphrase) are not returned. |
nsxt_resource_APIStats | NSXT Resource API Statistics | — | 4.0.0 | Provides the number of API calls made within the frequency and resources | ||
nsxt_alert_statistics | NSXT Alert Statistics | — | 3.0.0 | Provides NSXT Alert Statistics | ||
NsxT Transport Node | nsxt_transportNode_BfdAdminDownCount | NSXT TransportNode BFD Admin Down Count | Availability | count | 2.0.0 | Returns Bidirectional Forwarding Admin Down Count |
nsxt_transportNode_BfdAdministrativelyDownCount | NSXT TransportNode BFD Administrative Path Down Count | count | 2.0.0 | Returns BFD Administrative Path Down Count | ||
nsxt_transportNode_BfdConcatenatedPathDownCount | NSXT TransportNode BFD Concatenated Path Down Count | Availability | count | 2.0.0 | Returns BFD Concatenated Path Down Count | |
nsxt_transportNode_BfdControlDetectionTimeExpiredCount | NSXT TransportNode BFD Control Detection TimeExpired Count | Availability | count | 2.0.0 | Returns Bi-directional Forwarding Control Detection TimeExpired Count. | |
nsxt_transportNode_BfdDownCount | NSXT TransportNode BFD Down Count | Availability | count | 2.0.0 | Returns Bidirectional Forwarding Down Count. | |
nsxt_transportNode_BfdEchoFunctionFailedCount | NSXT TransportNode BFD Echo Function Failed Count | Availability | count | 2.0.0 | Returns Bidirectional Forwarding Detection Of Echo Function Failed Count. | |
nsxt_transportNode_BfdForwardPlaneResetCount | NSXT TransportNode BFD Echo Function Failed Count | Availability | count | 2.0.0 | Returns BFD Forward Plane Reset Count. | |
nsxt_transportNode_BfdInitCount | NSXT TransportNode BFD Init Count | Availability | count | 2.0.0 | Returns Bidirectional Forwarding Init Count. | |
nsxt_transportNode_BfdNeighbourSignalledSessionDownCount | NSXT TransportNode BFD Neighbour Signalled Session Down Count | Availability | count | 2.0.0 | Returns BFD Neighbour Signalled Session Down Count. | |
nsxt_transportNode_BfdNoDiagnosticCount | NSXT TransportNode BFD No Diagnostic Count | Availability | count | 2.0.0 | Returns Bidirectional Forwarding NoDiagnostic Count. | |
nsxt_transportNode_BfdPathDownCount | NSXT TransportNode BFD Path Down Count | Availability | count | 2.0.0 | Returns BFD Path Down Count. | |
nsxt_transportNode_BfdReverseConcatenatedPathDownCount | NSXT TransportNode BFD Reverse Concatenated Path Down Count | Availability | count | 2.0.0 | Returns BFD Reverse Concatenated Path Down Count. | |
nsxt_transportNode_BfdUpCount | NSXT TransportNode BFD Up Count | Availability | count | 2.0.0 | Returns Bidirectional Forwarding Up Count. | |
nsxt_transportNode_DataPathHeapUsage | NSXT TransportNode Data Path Heap Usage | Usage | percent | 2.0.0 | Returns Heap usage of the data path of a Transport Node. | |
nsxt_transportNode_DataPathTotalUsage | NSXT TransportNode Data Path Total Usage | Usage | percent | 2.0.0 | Returns Total usage of data path of a Transport Node. | |
nsxt_transportNode_LCPConnectionStatus | NSXT TransportNode LCP Connection Status | Availability | — | 2.0.0 | Returns the connection status of transportnode with local control plane. Possible values: Up, Down, Unknown, Degraded. | |
nsxt_transportNode_MPAConnectionStatus | NSXT TransportNode MPA Connection Status | Availability | — | 2.0.0 | Returns the connection status of transportnode with Management Plane Agent. Possible values: Up, Down, Unknown, Degraded. | |
nsxt_transportNode_PnicDegradedCount | NSXT TransportNode PNIC Degraded Count | Availability | count | 2.0.0 | Returns Count of Physical NIC's in Degraded State. | |
nsxt_transportNode_PnicDownCount | NSXT TransportNode PNIC Down Count | Availability | count | 2.0.0 | Returns Physical NIC's Down Count. | |
nsxt_transportNode_PnicStatus | NSXT TransportNode PNIC Status | Availability | — | 2.0.0 | TransportNode PNIC Status. Possible values: Up, Down, Unknown and Degraded. | |
nsxt_transportNode_PnicUpCount | NSXT TransportNode PNIC Up Count | Availability | count | 2.0.0 | Returns Physical NIC's Up Count. | |
nsxt_transportNode_Status | NSXT TransportNode Status | Availability | — | 2.0.0 | TransportNode Status. Possible values: Up, Down, Unknown and Degraded. | |
nsxt_transportNode_TunnelDownCount | NSXT TransportNode Tunnel Down Count | Availability | count | 2.0.0 | Returns Tunnel Count which is in Down State. | |
nsxt_transportNode_TunnelStatus | NSXT TransportNode Tunnel Status | Availability | — | 2.0.0 | Defines Connectivity Status Of a TransportNode with Another Remote TransportNodes Possible values: Up, Down, Unknown, Degraded. | |
nsxt_transportNode_TunnelUpCount | NSXT TransportNode Tunnel Up Count | Availability | count | 2.0.0 | Returns Tunnel Count which is in Up State. | |
nsxt_transportnode_AvgDpdkCpuCoreUtilization | NSXT TransportNode Avg Dpdk Cpu Core Utilization | Usage | percent | 2.0.0 | Average Utilization of DPDK CPU cores in a TransportNode. | |
nsxt_transportnode_AvgNonDpdkCpuCoreUtilization | NSXT TransportNode Avg Non Dpdk Cpu Core Utilization | Usage | percent | 2.0.0 | Average Utilization of Non-DPDK CPU cores in a TransportNode. | |
nsxt_transportnode_CacheMemory | NSXT TransportNode Cache Memory | Usage | megabytes | 2.0.0 | Cache Memory allocated to a TransportNode. | |
nsxt_transportnode_CacheUtilization | NSXT TransportNode Cache Utilization | Usage | percent | 2.0.0 | Cache Memory Utilization of a TransportNode. | |
nsxt_transportnode_CpuCoresCount | NSXT TransportNode Cpu Cores Count | Usage | count | 2.0.0 | The number of CPU cores in a TransportNode. | |
nsxt_transportnode_DpdkCpuCoresCount | NSXT TransportNode Dpdk Cpu Cores Count | Usage | count | 2.0.0 | The number of DPDK CPU cores in a TransportNode. | |
nsxt_transportnode_FileSystemUtlization | NSXT TransportNde FileSystem Utilization | Usage | percent | 2.0.0 | File System Utilization Of a TransportNode. | |
nsxt_transportnode_HighestDpdkCpuCoreUtilization | NSXT TransportNode Highest Dpdk Cpu Core Utilization | Usage | percent | 2.0.0 | Highest Utilization of DPDK CPU cores in a TransportNode. | |
nsxt_transportnode_HighestNonDpdkCpuCoreUtilization | NSXT TransportNode Highest Non Dpdk Cpu Core Utilization | Usage | percent | 2.0.0 | Highest Utilization of Non-DPDK CPU cores in a TransportNode. | |
nsxt_transportnode_LoadAverages | NSXT TransportNode Load Averages | Usage | percent | 2.0.0 | Fifteen minute load averages for the system utilization. | |
nsxt_transportnode_NonDpdkCpuCoresCount | NSXT TransportNode Non Dpdk Cpu Cores Count | Usage | count | 2.0.0 | The number of NON-DPDK CPU cores in a TransportNode. | |
nsxt_transportnode_SwapUtilization | NSXT TransportNode Swap Utilization | Usage | percent | 2.0.0 | Swap Memory utilization of a TransportNode. | |
nsxt_transportnode_SystemMemoryUtilization | NSXT TransportNode System Memory Utilization | Usage | percent | 2.0.0 | Total Memory utilization of a TransportNode. | |
nsxt_transportnode_TotalDiskSpace | NSXT TransportNode Total Disk Space | Usage | kilobytes | 2.0.0 | Total Disk Space of a TransportNode. | |
nsxt_transportnode_TotalMemory | NSXT TransportNode Total Memory | Usage | megabytes | 2.0.0 | Total Memory allocated to a TransportNode. | |
nsxt_transportnode_UsedDiskSpace | NSXT TransportNode Used Disk Space | Usage | kilobytes | 2.0.0 | NSXT TransportNode Used Disk Space. | |
nsxt_transportnode_UsedMemory | NSXT TransportNode Used Memory | Usage | megabytes | 2.0.0 | Amount of memory used by a Transport Node. | |
nsxt_transportnodes_DegradedCount | NSXT TransportNodes Degraded Count | Availability | count | 2.0.0 | The number of transport nodes in DegradedState. | |
nsxt_transportnodes_DownCount | NSXT TransportNodes Down Count | Availability | count | 2.0.0 | The number of transport nodes are down. | |
nsxt_transportnodes_UnknownStateCount | NSXT TransportNodes Unknown State Count | Availability | count | 2.0.0 | The number of transport nodes in Unknown State. | |
nsxt_transportnodes_UpCount | NSXT TransportNodes Up Count | Availability | count | 2.0.0 | The number of transport nodes are running. | |
nsxt_transportNode_BfdAdministrativeDownCount | NSXT TransportNode BFD Administrative Path Down Count | Availability | count | 2.0.0 | Returns BFD Administrative Path Down Count | |
NsxT Transport Zone | nsxt_transportzone_DegradedCount | NSXT TransportZone Degraded Count | Availability | count | 2.0.0 | The number of transport zones in DegradedState. |
nsxt_transportzone_DownCount | NSXT TransportZone Down Count | Availability | count | 2.0.0 | The number of transport zones are down. | |
nsxt_transportzone_LogicalSwitchesCount | NSXT TransportZone LogicalSwitches Count | Availability | count | 2.0.0 | The number of logicalswitches associated with a transportzone. | |
nsxt_transportzone_TransportNodeCount | NSXT TransportZone TransportNode Count | Availability | count | 2.0.0 | The number of transportnodes associated with a transportzone | |
nsxt_transportzone_UnknownStateCount | NSXT TransportZone Unknown Count | Availability | count | 2.0.0 | The number of transport zones in Unknown State. | |
nsxt_transportzone_UpCount | NSXT TransportZone Up Count | Availability | count | 2.0.0 | The number of transport zones are running. | |
nsxt_transportzones_LogicalSwitchCount | NSXT TransportZones Logical Switch Count | count | 2.0.0 | The number of Logical Switches associated with a transport zone | ||
nsxt_transportzones_TransportNodeCount | NSXT TransportZones TransportNode Count | count | 2.0.0 | The number of transportnodes. both HostNode and EdgeNode associated with a transportzone | ||
nsxt_transportzones_UpCount | NSXT TransportZones Up Count | count | 2.0.0 | The number of transport zones in Up(Running) state | ||
nsxt_transportzones_DownCount | NSXT TransportZones Down Count | count | 2.0.0 | The number of transport zones in Down state | ||
nsxt_transportzones_DegradedCount | NSXT TransportZones Degraded Count | count | 2.0.0 | The number of transport zones in Degraded State | ||
nsxt_transportzones_UnknownStateCount | NSXT TransportZones Unknown State Count | count | 2.0.0 | The number of transport zones in Unknown State | ||
NsxT Virtual Machine | nsxt_virtualmachines_Statuss | NSXT VirtualMachine Status | Availability | — | 2.0.0 | VirtualMachine Status. Possible values: VM_Running, VM_Stopped |
NsxT Logical Router | nsxt_logicalrouter_BGP_neighbor_connection_State | NSXT LogicalRouter BGP Neighbor Connection State | — | 2.0.0 | Current state of the BGP session. Possible values 0-UNKNOWN, 1-INVALID, 2-IDLE, 3-CONNECT, 4-ACTIVE, 5-OPEN_SENT, 6-OPEN_CONFIRM, 7-ESTABLISHED. | |
nsxt_logicalrouter_BGP_neighbor_established_connection_Count | NSXT LogicalRouter BGP Neighbor Established Connection Count | count | 2.0.0 | Count of connections established. | ||
nsxt_logicalrouter_BGP_neighbor_connection_drop_Count | NSXT LogicalRouter BGP Neighbor Connection Drop Count | count | 2.0.0 | Count of connection drop. | ||
nsxt_logicalrouter_Status | NSXT LogicalRouter Status | 6.0.0 | Overall state of desired configuration. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures.in_sync state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to success. Please note, failed state is deprecated. Possible values 0-SUCCESS, 1-IN_PROGRESS, 2-ERROR, 3-UNINITIALIZED, 4-UP, 5-DOWN, 6-UNKNOWN, 7-IN_SYNC, 8-PENDING, 9-FAILURE | |||
nsxt_logicalrouter_HA_Mode | NSXT LogicalRouter HA Mode | 6.0.0 | Logical Router High availability mode. Possible values 0-ACTIVE_ACTIVE, 1-ACTIVE_STANDBY, 2-DISTRIBUTED ONLY |
Application Migration
Check for the gateway version as a prerequisite step - classic gateway-12.0.1 and above.
Notes:- You only have to follow these steps when you want to migrate from sdk 1.0 to sdk 2.0.
- For the first time installation below steps are not required.
Disable all configurations associated with sdk 1.0 adaptor integration application.
Install and Add the configuration to that sdk 2.0 application.
Note: refer to Configure and Install the VMware NSX-T Integration & View the VMware NSX-T Details sections of this document.Once all discoveries are completed with the sdk 2.0 application, follow any one of the approaches.
- Direct uninstallation of the sdk 1.0 adaptor application through the uninstall API with skipDeleteResources=true in the post request
End-Point:https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}
Request Body:{ "uninstallReason": "Test", "skipDeleteResources": true }
(OR) - Delete the configuration one by one through the Delete adaptor config API with the request parameter as skipDeleteResources=true
End-Point:https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/config/{configId}?skipDeleteResources=true.
- Finally, uninstall the adaptor application through API with skipDeleteResources=true in the post request.
End-Point:https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}
Request Body:{ "uninstallReason": "Test", "skipDeleteResources": true }
- Direct uninstallation of the sdk 1.0 adaptor application through the uninstall API with skipDeleteResources=true in the post request
Default Monitoring Configurations
VMware-NSX-T has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business requirement by cloning respective Global Templates and Global Device Management Policies. It is recommended to clone them before installing the application to avoid noise alerts and data.
Default Global Device Management Policies
You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies. Search with suggested name in global scope. Each Device Management Policy follows below naming convention:
{appName nativeType - version}
Ex: vmware-nsx-t NsxT Manager Cluster - 2 (i.e, appName = vmware-nsx-t, nativeType = NsxT Manager Cluster, version = 2)
Default Global Templates
You can find the Global Templates for each Native Type at Setup > Monitoring > Templates. Search with suggested names in global scope. Each template follows below naming convention:
{appName nativeType 'Template' - version}
Ex: vmware-nsx-t NsxT Manager Cluster Template - 2 (i.e, appName = vmware-nsx-t, nativeType = NsxT Manager Cluster, version = 2)
Default Global Monitors
You can find the Global Monitors for each Native Type at Setup > Monitoring > Monitors. Search with suggested name in global scope. Each Monitors follows below naming convention:
{monitorKey appName nativeType - version}
Ex: NsxT Manager Cluster Monitor vmware-nsx-t NsxT Manager Cluster 2 (i.e, monitorKey = NsxT Manager Cluster Monitor, appName = vmware-nsx-t, nativeType = NsxT Manager Cluster, version = 2)
Configure and Install the VMware NSX-T Integration
- From All Clients, select a client.
- Navigate to Setup > Account.
- Select the Integrations tab.
- The Installed Integrations page, where all the installed integrations are displayed. Click + ADD on the Installed Integrations page.
- If you do not have any installed applications, you will be navigated to the Available Integrations page. The Available Integrations page displays all the available applications along with the newly created application with the version.
Note: Search for the application using the search option available. Alternatively, use the All Categories option to search. - Click ADD in the VMware NSX-T application.
Note: Select the version from the drop down menu. - In the Configurations page, click + ADD. The Add Configuration page appears.
- Enter the following BASIC INFORMATION:
Functionality | Description |
---|---|
Name | Enter the name for the configuration. |
NSX-T Manager IP Address | IP address of the target. |
Port | Port Example: By default 443 is the port value |
Credential | Select the credentials from the drop-down list. Note: Click + Add to create a credential. |
Notes:
- By default the Is Secure checkbox is selected.
- NSX-T Manager IP Address and Port should be accessible from Gateway.
- Select the following:
- App Failure Notifications: If turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
- Event/Alert Polling: Enables integrating third party alerts into OpsRamp using further configurations.
- Below are the default values set for:
- Alert On Root Resource: Alerts generated by on root resource, when checked.
- Event/Alert Cleared Status: Possible values of Event/Alert Cleared Status configuration property are “ACKNOWLEDGED”,“SUPPRESSED”,“RESOLVED”.
- Event/Alert Severity: Possible values of Event/Alert Severity configuration property are “CRITICAL”,“HIGH”,“MEDIUM”,“LOW”.
- Event/Alert Severity Mapping: Possible values of Event/Alert Severity Mapping Filter configuration property are “CRITICAL”:“Critical”,“HIGH”:“Warning”,“MEDIUM”:“Warning”,“LOW”:“Info”.
- Alert On Root Resource: Alerts generated by on root resource, when checked.
- Below are the default values set for:
- API Timeouts: These are the maximum API Timeouts that the application can use to connect and get responses from the end device.
- Connection Timeout in Secs: a time period in which a client should establish a connection with a server.
Note: By default, 60 is selected. - Connection Request Timeout in Secs: a time period required to process an HTTP call: from sending a request to receiving a response.
Note: By default, 10 is selected. - Socket Timeout in Secs: a maximum time of inactivity between two data packets when exchanging data with a server.
Note: By default, 10 is selected.
- Connection Timeout in Secs: a time period in which a client should establish a connection with a server.
- Select the following Custom Attribute:
Functionality | Description |
---|---|
Custom Attribute | Select the custom attribute from the drop down list box. |
Value | Select the value from the drop down list box. |
Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).
- In the RESOURCE TYPE section, select:
- ALL: All the existing and future resources will be discovered.
- SELECT: You can select one or multiple resources to be discovered.
- In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
- Minutes
- Hourly
- Daily
- Weekly
- Monthly
- Click ADD.
Now the configuration is saved and displayed on the configurations page after you save it. From the same page, you may Edit and Remove the created configuration.
Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.
Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.
Click NEXT.
(Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.
- Select an existing registered profile.
- Click FINISH.
The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.
Modify the Configuration
See Modify an Installed Integration or Application article.
Note: Select the VMware NSX-T application.
View the VMware NSX-T Details
To discover resources for VMware NSX-T
- Navigate to Infrastructure > Search > Software Defined Network > VMware NSX-T.
- The VMWARE NSX-T page is displayed, select the application name.
- The RESOURCE DETAILS page appears from the right.
- Click the ellipsis (…) on the top right and select View details.
- Navigate to the Attributes tab to view the discovery details.
- Click the Metrics tab to view the metric details for VMware NSX-T.
Resource Filter Input Keys
VMware NSX-T application resources are filtered and discovered based on below keys:
Click here to view the Supported Input Keys
Resource Type | Supported Input Keys |
---|---|
All Types | resourceName |
hostName | |
aliasName | |
dnsName | |
ipAddress | |
macAddress | |
os | |
make | |
model | |
serialNumber | |
NsxT Logical Router | Router Type |
NsxT Transport Node | Transport Node Type |
NsxT Edge Physical Network Interface | MTU |
Physical Address | |
NsxT Host Physical Network Interface | MTU |
Physical Address | |
NsxT Virtual Machine | VM Type |
Supported Alert Custom Macros
Customize the alert subject and description with below macros then it will generate alert based on customisation.
Supported macros keys:
Click here to view the alert subject and description with macros
${resource.name}
${resource.ip}
${resource.mac}
${resource.aliasname}
${resource.os}
${resource.type}
${resource.dnsname}
${resource.alternateip}
${resource.make}
${resource.model}
${resource.serialnumber}
${resource.systemId}
${Custome Attributes in the resource}
${parent.resource.name}
Risks, Limitations And Assumptions
- Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration
- Connectivity Exception
- Authentication Exception
- Application will send any duplicate/repeat failure alert notification for every 6 hours.
- The unique ID for the firewall has been changed from the Manager API to the Policy API. Consequently, during the migration of NSX-T devices from manager to policy mode, existing firewalls created using the Manager API will be removed, and new firewalls utilizing the Policy API will be created.
- Application cannot control monitoring pause/resume actions based on above alerts. Metrics can be used to monitor the resources and can generate alerts based on the threshold values.
- vmware-nsx-t Event/Alert polling will be started only if the user enables Event/Alert Polling in configuration.
Notes:- Here Event/Alert polling support is given for vmware-nsx-t Alarms only.
- When a status value which presents in Event/Alert Cleared Status field occurs, OpsRamp will create an Ok alert accordingly. Otherwise, OpsRamp will create an alert based on Event/Alert Severity Filter & Event/Alert Severity Mappings of the Event/Alert Polling configurations.
- Application will publish event polling alerts on root resource if Alert on root resource is checked in the configuration, else alert will be published on respective resource.
- Default values of Event/Alert Cleared Status configuration field are: ACKNOWLEDGED, SUPPRESSED, RESOLVED.
- Possible vmware-nsx-t status values are OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED.
- Default/Possible values of Event/Alert Severity Filter configuration are CRITICAL, HIGH, MEDIUM, LOW.
- We have provided default mappings to map vmware-nsx-t Severity with OpsRamp Severities as part of Event/Alert Severity Mapping configuration.
- Users can modify them as per their use-case at any point of time from the application configuration page. Possible OpsRamp Severities are Critical, Warning, Ok, Info.
- No support of showing activity logs.
- The Template Applied Time will only be displayed if the collector profile (Classic and NextGen Gateway) is version 18.1.0 or higher.
- This application supports both Classic Gateway and NextGen Gateway.
- Below are the possible reasons for tunnel status related metrics of Transport Node can go missing:
- Transport nodes which are connected to only VLAN transport zones wont have tunnel status metrics.
- Tunnels are not setup when no NSX backed/ overlay VM is connected to the host.
- BFD module could be errored and wiped all BFD tunnel related information.
Transport node tunnel status related metrics
nsxt_transportNode_TunnelStatus nsxt_transportNode_TunnelUpCount nsxt_transportNode_TunnelDownCount nsxt_transportNode_BfdAdminDownCount nsxt_transportNode_BfdDownCount nsxt_transportNode_BfdInitCount nsxt_transportNode_BfdUpCount nsxt_transportNode_BfdNoDiagnosticCount nsxt_transportNode_BfdControlDetectionTimeExpiredCount nsxt_transportNode_BfdEchoFunctionFailedCount nsxt_transportNode_BfdForwardPlaneResetCount nsxt_transportNode_BfdPathDownCount nsxt_transportNode_BfdConcatenatedPathDownCount nsxt_transportNode_BfdAdministrativeDownCount nsxt_transportNode_BfdReverseConcatenatedPathDownCount nsxt_transportNode_BfdNeighbourSignalledSessionDownCount
- Latest snapshot metric support from Gateway 14.0.0.
Troubleshooting
Before troubleshooting, ensure all prerequisites prerequisites are met.
If VMware NSX-T integrations fails to discover or monitor, troubleshoot using the following steps:
- Check if any alerts have been generated on the NSX-T resource or gateway, or if there are any error logs in vprobe.
- If there is an error or alert related to the end device connectivity or authentication, try checking the reachability of the end device from the gateway with the following commands:
- to ping the IP address provided in the configuration:
{ping <IP Address>}
- to try telnet:
{telnet <IP Adress> <Port>}
- To run an API:
Prepare the request payload by using below sample request: { “apiVersion”: “debug/v1”, “module”: “Debug”, “app”: “poly-trio”, “action”: “Reachability”, “payload”: { “ipAddressOrHostName”: “
”, “protocol”: “https”, “port”: 443, “requestPath”: “ ”, “version”:“v1”,
“requestMethod”:"<get/post>", “userName”: “
”, “password”: “ ” } } Encode the request payload to base64
Log in to the gateway concole and connect to the GCLI terminal using the below command:
{## gcli}
Run the command using the previously generated base64 encoded string
{## sdkappdebug <base64 encoded string>}
- to ping the IP address provided in the configuration:
Version History
Application Version | Bug fixes / Enhancements |
---|---|
10.0.1 | Bug fix related to disk space metrics. |
10.0.0 | added new metric support nsxt_manager_DiskSpaceUsed, nsxt_manager_DiskSpaceTotal, nsxt_manager_DiskSpaceUtilization under NsxT Manager native type |
9.0.2 | Resource deletion issue fix. |
9.0.1 | Capturing Error Log Details whenever Edge Cluster Status was Degraded State. |
Click here to view the earlier version updates
Application Version | Bug fixes / Enhancements |
---|---|
9.0.0 | Support for Deprecated Manager API's with Alternative Policy API's |
8.0.0 |
|
7.0.0 |
|
6.0.0 | Added nsxt_logicalrouter_Status, nsxt_logicalrouter_HA_Mode metric support for NsxT Logical Router |
5.1.0 |
|
5.0.2 |
|
5.0.1 |
|
5.0.0 |
|
4.1.1 | Bug fix to retry after waiting for 30sec in case of App Failure exceptions. |
4.1.0 |
|
4.0.2 | Support added to map nsx-t manager cluster resource IP. |
4.0.1 | Full discovery support added. |
4.0.0 |
|
3.0.1 |
|
3.0.0 | Added support to process NSX-T alarms into OpsRamp. |
2.0.1 | Enhanced application failure notification sending feature. |
2.0.0 | Initial SDK2.0 application Discovery and Monitoring Implementations. |