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

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
6.0.0Added nsxt_logicalrouter_Status, nsxt_logicalrouter_HA_Mode metric support for NsxT Logical Router
5.1.0
  • Flexibility to publish event polling alert on root resource or other respective resources based on Alert on root resource option provided in configuration UI.
  • Added resource name for NsxT Manager.
5.0.2
  • Code fix to use OVERLAY Transport Zone ID to fetch tunnel status for Transport Nodes.
  • Support for reoccurrence of alerts.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
5.0.1
  • NSX-T API optimization.
  • Throttling code support for handling status code 429 too many request.
  • Bug fix to avoid duplicate alerts in OpsRamp.
5.0.0
  • Data point conversion enabled.
  • Updated NSX-T Manager Discovery and monitoring API.
  • Root native type and display order changes in Infrastructure resource page.
  • VMware NSX-T subcategory modified as Network Security.
4.1.1Bug fix to retry after waiting for 30sec in case of App Failure exceptions.
4.1.0
  • Bug fixes and API timeout checkbox added in the app configuration page.
  • Added metric label support.
  • Missing component alerts support added.
4.0.2Support added to map nsx-t manager cluster resource IP.
4.0.1Full discovery support added.
4.0.0
  • Enhanced app failure notification sending feature for ServiceUnavailableException, RequestTimeoutException, SocketTimeoutException.
  • API statistics metric support added with the display name - “NSX-T Statistics”.
  • Added NSX-T API retry mechanism with 2secs delay to address API throttling.
3.0.1
  • Added support to collect OS details for NSX-T VM resources.
  • Macro replacement in the threshold breach alert subject & descriptions.
3.0.0Added support to process NSX-T alarms into OpsRamp.
2.0.1Enhanced application failure notification sending feature.
2.0.0Initial SDK2.0 application Discovery and Monitoring Implementations.

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, for example.

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..

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 TypeMetric NameMetric Display NameUnitsApplication VersionDescription
NsxT Edge Clusternsxt_edgecluster_StatusNSXT EdgeCluster Status2.0.0Returns the aggregated status for Edge Cluster

Possible values: Up, Down, Degraded, Unknown.
NsxT Edge Physical Network Interfacensxt_edgenode_physicalinterface_AdminStatusNSXT EdgeNode Physical Interface Admin Status2.0.0EdgeNode Network Interface Admin Status.

Possible values: Up, Down, Degraded, Unknown.
nsxt_edgenode_physicalinterface_LinkStatusNSXT EdgeNode Physical Interface Link Status2.0.0EdgeNode Physical Interface Link Status.

Possible values: Up, Down, Degraded, Unknown.
NsxT Firewallnsxt_firewall_RuleCountNSXT Firewall Rule Countcount2.0.0Number of Rules associated with a Firewall.
nsxt_firewall_SectionCountNSXT Firewall Section Countcount2.0.0Number Of sessions within a firewall returns.

Total Number Of Sections available for a Firewall.
NsxT Host Physical Network Interfacensxt_hostnode_physicalinterface_AdminStatusNSXT HostNode Physical Interface Admin Status2.0.0HostNode Network Interface Admin Status.

Possible values: Up, Down, Degraded, Unknown.
nsxt_hostnode_physicalinterface_LinkStatusNSXT HostNode Physical Interface Link Status2.0.0HostNode Network Interface Link Status.

Possible values: Up, Down, Degraded, Unknown.
NsxT Logical Switchnsxt_logicalswitch_DroppedReceivedPacketsNSXT LogicalSwitch Dropped Received Packetscount2.0.0Number of received packets received by Logical Switch.
nsxt_logicalswitch_DroppedTransmittedPacketsNSXT LogicalSwitch Dropped Transmitted Packetscount2.0.0Number of transmitted packets dropped by Logical Switch.
nsxt_logicalswitch_FullyRealizedSwitchCountNSXT LogicalSwitch Fully Realized Switch Countcount2.0.0Number of Logical switches in fully realized state
nsxt_logicalswitch_LogicalPortCountNSXT LogicalSwitch LogicalPorts Countcount2.0.0Number of Logical ports associated with a logical switch
nsxt_logicalswitch_TotalReceivedBytesNSXT LogicalSwitch Total Received Byttesbytes2.0.0Number of transmitted packets dropped by Logical Switch
nsxt_logicalswitch_TotalReceivedPacketsNSXT LogicalSwitch Total Received Packetscount2.0.0Number of packets received by Logical Switch
nsxt_logicalswitch_TotalSwitchCountNSXT LogicalSwitch Total Countcount2.0.0Total Number of Logical Switches
nsxt_logicalswitch_TotalTransmittedBytesNSXT LogicalSwitch Total Transmitted Bytesbytes2.0.0Number of bytes transmitted by Logical Switch
nsxt_logicalswitch_TotalTransmittedPacketsNSXT LogicalSwitch Total Transmitted Packetscount2.0.0Total number of Packets transmitted by Logical Switch
NsxT Managernsxt_manager_CPUCountNSXT Manager CPU Countcount2.0.0Total Number Of CPU's on the NSXT Manager
nsxt_manager_ControllerNodeStatusNSXT Manager ControllerNodeStatus2.0.0Defines whether controller node is running or not
nsxt_manager_CpuPercentageUtilizationNSXT Manager CPU Percentage Utiizationpercent2.0.0Fifteen minute load averages for the system utilization
nsxt_manager_FilesystemUtlizationNSXT Manager Filesyestem Utilizationpercent2.0.0FileSystems utilization on the VMware NSXT Manager
nsxt_manager_FreeMemoryNSXT Manager Free Memorykilobytes2.0.0The amount of free memory on the VMware NSXT Manager
nsxt_manager_MemoryUtilizationNSXT Manager Memory Utilizationpercent2.0.0The amount of memory used by the VMware NSXT Manager in percentage
nsxt_manager_TotalMemoryNSXT Manager Total Memorykilobytes2.0.0The amount of Total memory on the VMware NSXT Manager.
nsxt_manager_UsedMemoryNSXT Manager Used Memorykilobytes2.0.0The amount of Used memory on the VMware NSXT Manager.
nsxt_manager_CPUUtlizationNSXT Manager CPU Utilization%2.0.0Fifteen minute load averages for the system utilization
nsxt_manager_ControllerStatusNSXT Manager Controller Status2.0.0Controller Status. Possible values are Running(1),Not Running(0)
NsxT Manager Clusternsxt_managercluster_BackupConfigurationNSX Manager Backup Configurationper hour2.0.0Get 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_APIStatsNSXT Resource API Statistics4.0.0Provides the number of API calls made within the frequency and resources
nsxt_alert_statisticsNSXT Alert Statistics3.0.0Provides NSXT Alert Statistics
NsxT Transport Nodensxt_transportNode_BfdAdminDownCountNSXT TransportNode BFD Admin Down Countcount2.0.0Returns Bidirectional Forwarding Admin Down Count
nsxt_transportNode_BfdAdministrativelyDownCountNSXT TransportNode BFD Administrative Path Down Countcount2.0.0Returns BFD Administrative Path Down Count
nsxt_transportNode_BfdConcatenatedPathDownCountNSXT TransportNode BFD Concatenated Path Down Countcount2.0.0Returns BFD Concatenated Path Down Count
nsxt_transportNode_BfdControlDetectionTimeExpiredCountNSXT TransportNode BFD Control Detection TimeExpired Countcount2.0.0Returns Bi-directional Forwarding Control Detection TimeExpired Count.
nsxt_transportNode_BfdDownCountNSXT TransportNode BFD Down Countcount2.0.0Returns Bidirectional Forwarding Down Count.
nsxt_transportNode_BfdEchoFunctionFailedCountNSXT TransportNode BFD Echo Function Failed Countcount2.0.0Returns Bidirectional Forwarding Detection Of Echo Function Failed Count.
nsxt_transportNode_BfdForwardPlaneResetCountNSXT TransportNode BFD Echo Function Failed Countcount2.0.0Returns BFD Forward Plane Reset Count.
nsxt_transportNode_BfdInitCountNSXT TransportNode BFD Init Countcount2.0.0Returns Bidirectional Forwarding Init Count.
nsxt_transportNode_BfdNeighbourSignalledSessionDownCountNSXT TransportNode BFD Neighbour Signalled Session Down Countcount2.0.0Returns BFD Neighbour Signalled Session Down Count.
nsxt_transportNode_BfdNoDiagnosticCountNSXT TransportNode BFD No Diagnostic Countcount2.0.0Returns Bidirectional Forwarding NoDiagnostic Count.
nsxt_transportNode_BfdPathDownCountNSXT TransportNode BFD Path Down Countcount2.0.0Returns BFD Path Down Count.
nsxt_transportNode_BfdReverseConcatenatedPathDownCountNSXT TransportNode BFD Reverse Concatenated Path Down Countcount2.0.0Returns BFD Reverse Concatenated Path Down Count.
nsxt_transportNode_BfdUpCountNSXT TransportNode BFD Up Countcount2.0.0Returns Bidirectional Forwarding Up Count.
nsxt_transportNode_DataPathHeapUsageNSXT TransportNode Data Path Heap Usagepercent2.0.0Returns Heap usage of the data path of a Transport Node.
nsxt_transportNode_DataPathTotalUsageNSXT TransportNode Data Path Total Usagepercent2.0.0Returns Total usage of data path of a Transport Node.
nsxt_transportNode_LCPConnectionStatusNSXT TransportNode LCP Connection Status2.0.0Returns the connection status of transportnode with local control plane.

Possible values: Up, Down, Unknown, Degraded.
nsxt_transportNode_MPAConnectionStatusNSXT TransportNode MPA Connection Status2.0.0Returns the connection status of transportnode with Management Plane Agent.

Possible values: Up, Down, Unknown, Degraded.
nsxt_transportNode_PnicDegradedCountNSXT TransportNode PNIC Degraded Countcount2.0.0Returns Count of Physical NIC's in Degraded State.
nsxt_transportNode_PnicDownCountNSXT TransportNode PNIC Down Countcount2.0.0Returns Physical NIC's Down Count.
nsxt_transportNode_PnicStatusNSXT TransportNode PNIC Status2.0.0TransportNode PNIC Status.

Possible values: Up, Down, Unknown and Degraded.
nsxt_transportNode_PnicUpCountNSXT TransportNode PNIC Up Countcount2.0.0Returns Physical NIC's Up Count.
nsxt_transportNode_StatusNSXT TransportNode Status2.0.0TransportNode Status.

Possible values: Up, Down, Unknown and Degraded.
nsxt_transportNode_TunnelDownCountNSXT TransportNode Tunnel Down Countcount2.0.0Returns Tunnel Count which is in Down State.
nsxt_transportNode_TunnelStatusNSXT TransportNode Tunnel Status2.0.0Defines Connectivity Status Of a TransportNode with Another Remote TransportNodes

Possible values: Up, Down, Unknown, Degraded.
nsxt_transportNode_TunnelUpCountNSXT TransportNode Tunnel Up Countcount2.0.0Returns Tunnel Count which is in Up State.
nsxt_transportnode_AvgDpdkCpuCoreUtilizationNSXT TransportNode Avg Dpdk Cpu Core Utilizationpercent2.0.0Average Utilization of DPDK CPU cores in a TransportNode.
nsxt_transportnode_AvgNonDpdkCpuCoreUtilizationNSXT TransportNode Avg Non Dpdk Cpu Core Utilizationpercent2.0.0Average Utilization of Non-DPDK CPU cores in a TransportNode.
nsxt_transportnode_CacheMemoryNSXT TransportNode Cache Memorymegabytes2.0.0Cache Memory allocated to a TransportNode.
nsxt_transportnode_CacheUtilizationNSXT TransportNode Cache Utilizationpercent2.0.0Cache Memory Utilization of a TransportNode.
nsxt_transportnode_CpuCoresCountNSXT TransportNode Cpu Cores Countcount2.0.0The number of CPU cores in a TransportNode.
nsxt_transportnode_DpdkCpuCoresCountNSXT TransportNode Dpdk Cpu Cores Countcount2.0.0The number of DPDK CPU cores in a TransportNode.
nsxt_transportnode_FileSystemUtlizationNSXT TransportNde FileSystem Utilizationpercent2.0.0File System Utilization Of a TransportNode.
nsxt_transportnode_HighestDpdkCpuCoreUtilizationNSXT TransportNode Highest Dpdk Cpu Core Utilizationpercent2.0.0Highest Utilization of DPDK CPU cores in a TransportNode.
nsxt_transportnode_HighestNonDpdkCpuCoreUtilizationNSXT TransportNode Highest Non Dpdk Cpu Core Utilizationpercent2.0.0Highest Utilization of Non-DPDK CPU cores in a TransportNode.
nsxt_transportnode_LoadAveragesNSXT TransportNode Load Averagespercent2.0.0Fifteen minute load averages for the system utilization.
nsxt_transportnode_NonDpdkCpuCoresCountNSXT TransportNode Non Dpdk Cpu Cores Countcount2.0.0The number of NON-DPDK CPU cores in a TransportNode.
nsxt_transportnode_SwapUtilizationNSXT TransportNode Swap Utilizationpercent2.0.0Swap Memory utilization of a TransportNode.
nsxt_transportnode_SystemMemoryUtilizationNSXT TransportNode System Memory Utilizationpercent2.0.0Total Memory utilization of a TransportNode.
nsxt_transportnode_TotalDiskSpaceNSXT TransportNode Total Disk Spacekilobytes2.0.0Total Disk Space of a TransportNode.
nsxt_transportnode_TotalMemoryNSXT TransportNode Total Memorymegabytes2.0.0Total Memory allocated to a TransportNode.
nsxt_transportnode_UsedDiskSpaceNSXT TransportNode Used Disk Spacekilobytes2.0.0NSXT TransportNode Used Disk Space.
nsxt_transportnode_UsedMemoryNSXT TransportNode Used Memorymegabytes2.0.0Amount of memory used by a Transport Node.
nsxt_transportnodes_DegradedCountNSXT TransportNodes Degraded Countcount2.0.0The number of transport nodes in DegradedState.
nsxt_transportnodes_DownCountNSXT TransportNodes Down Countcount2.0.0The number of transport nodes are down.
nsxt_transportnodes_UnknownStateCountNSXT TransportNodes Unknown State Countcount2.0.0The number of transport nodes in Unknown State.
nsxt_transportnodes_UpCountNSXT TransportNodes Up Countcount2.0.0The number of transport nodes are running.
nsxt_transportNode_BfdAdministrativeDownCountNSXT TransportNode BFD Administrative Path Down Countcount2.0.0Returns BFD Administrative Path Down Count
NsxT Transport Zonensxt_transportzone_DegradedCountNSXT TransportZone Degraded Countcount2.0.0The number of transport zones in DegradedState.
nsxt_transportzone_DownCountNSXT TransportZone Down Countcount2.0.0The number of transport zones are down.
nsxt_transportzone_LogicalSwitchesCountNSXT TransportZone LogicalSwitches Countcount2.0.0The number of logicalswitches associated with a transportzone.
nsxt_transportzone_TransportNodeCountNSXT TransportZone TransportNode Countcount2.0.0The number of transportnodes associated with a transportzone
nsxt_transportzone_UnknownStateCountNSXT TransportZone Unknown Countcount2.0.0The number of transport zones in Unknown State.
nsxt_transportzone_UpCountNSXT TransportZone Up Countcount2.0.0The number of transport zones are running.
nsxt_transportzones_LogicalSwitchCountNSXT TransportZones Logical Switch Countcount2.0.0The number of Logical Switches associated with a transport zone
nsxt_transportzones_TransportNodeCountNSXT TransportZones TransportNode Countcount2.0.0The number of transportnodes. both HostNode and EdgeNode associated with a transportzone
nsxt_transportzones_UpCountNSXT TransportZones Up Countcount2.0.0The number of transport zones in Up(Running) state
nsxt_transportzones_DownCountNSXT TransportZones Down Countcount2.0.0The number of transport zones in Down state
nsxt_transportzones_DegradedCountNSXT TransportZones Degraded Countcount2.0.0The number of transport zones in Degraded State
nsxt_transportzones_UnknownStateCountNSXT TransportZones Unknown State Countcount2.0.0The number of transport zones in Unknown State
NsxT Virtual Machinensxt_virtualMachine_StatusNSXT VirtualMachine Status2.0.0VirtualMachine Status.

Possible values: VM_Running, VM_Stopped
NsxT Logical Routernsxt_logicalrouter_BGP_neighbor_connection_StateNSXT LogicalRouter BGP Neighbor Connection State2.0.0Current 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_CountNSXT LogicalRouter BGP Neighbor Established Connection Countcount2.0.0Count of connections established.
nsxt_logicalrouter_BGP_neighbor_connection_drop_CountNSXT LogicalRouter BGP Neighbor Connection Drop Countcount2.0.0Count of connection drop.

Application Migration

  1. 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.
  2. Disable all configurations associated with sdk 1.0 adaptor integration application.

  3. 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.

  4. 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
          }

Default Monitoring Configurations

VMware-NSX-T application has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. Users can customize these default monitoring configurations as per their business use cases by cloning respective global templates and global Device Management Policies. OpsRamp recommends doing this activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for each Native Type of VMware-NSX-T. You can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names 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)

  2. Default Global Templates

    OpsRamp has a Global template for each Native Type of VMware-NSX-T. You can find those templates 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)

  3. Default Global Monitors

    OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, Search with suggested names 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

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed.
    Note: If there are no installed applications, it will navigate to the ADD APP page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
    Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
  1. Click ADD in the VMware NSX-T application.
    Note: Select the version from the drop down menu.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
FunctionalityDescription
NameEnter the name for the configuration.
NSX-T Manager IP AddressIP address of the target.
PortPort
Example: By default 443 is the port value
CredentialSelect 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”.
    • 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.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect 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).

  1. 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.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. 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.

  1. 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.

  2. Click NEXT.

  3. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

Veeam
  1. Select an existing registered profile.
Veeam
  1. 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

View the VMware NSX-T Details

To discover resources for VMware NSX-T

  1. Navigate to Infrastructure > Search > Software Defined Network > VMware NSX-T.
  2. The VMWARE NSX-T page is displayed, select the application name.
  3. The RESOURCE DETAILS page appears from the right.
  4. Click the ellipsis () on the top right and select View details.
  5. 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 TypeSupported Input Keys
All TypesresourceName
hostName
aliasName
dnsName
ipAddress
macAddress
os
make
model
serialNumber
NsxT Logical RouterRouter Type
NsxT Transport NodeTransport Node Type
NsxT Edge Physical Network InterfaceMTU
Physical Address
NsxT Host Physical Network InterfaceMTU
Physical Address

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 & 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.
  • 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.
  • OpsRamp has 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 log and applied time.
  • 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