ZenPack:VMware NSX

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search

Note: This ZenPack is available in commercial versions of Zenoss. Click here to request more information about this commercial ZenPack. Click here to see all commercial ZenPacks.

Zenoss, Inc.
ZenPack name

Applications Monitored: 

VMware NSX ZenPack

VMware NSX monitoring.


The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.


This ZenPack is included with commercial versions of Zenoss and enterprise support for this ZenPack is provided to Zenoss customers with an active subscription.


Version 1.2.0- Download
Released on 2016/07/29
Requires PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.x.x
Enhances VMware vSphere,
Version 1.0.1- Download
Released on 2015/09/24
Requires PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.x.x
Version 1.0.0- Download
Released on 2015/06/26
Requires PythonCollector ZenPack
Compatible with Zenoss Resource Manager 4.2.x, Zenoss Resource Manager 5.x.x


This ZenPack provides support for monitoring VMware NSX. Modeling and monitoring of devices placed in the /VMware/NSX device class is performed using the NSX API by executing queries and parsing the output.



The NSX ZenPack provides:

  • Initial discovery and continual synchronization of relevant components.
  • Performance monitoring.
  • System event management.
  • Service impact and root cause analysis (Requires Zenoss Service Dynamics).
  • Collection of detailed configuration data, including NAT Rules, Routing Protocols, Load Balancer Configs, and Firewall Configs.


The following entities will be automatically discovered. The attributes and collections will be updated on Zenoss's normal remodeling interval which defaults to every 12 hours.

NSX Manager
Attributes: NSX Version, IP Address
Attributes: Name, ID, Edge Type, Version, Tenant, Size, State, Status, Interfaces Count
Relations: NSX Interfaces
Attributes: Name, Controller Cluster, Node, vSphere Datastore, Host, Software Version, Upgrade Status, Status
Controller Clusters
Attributes: Name, Number of Controllers
Relations: NSX Controllers
Attributes: Name, Edge, IP Addresses, MTU, Type, Is Connected, Virtual Switch
Relations: NSX Edge, NSX Virtual Switches
Attributes: Name, Edge, Interface, IP Addresses, MTU, Type, Tunnel ID, Virtual Network ID, Redirects
Virtual Switches
Attributes: Name, Transport Zone, Segment ID, Control Plane Mode, vSphere Portgroup, Connected Interfaces Count
Relations: NSX Interfaces
Network Scopes
Attributes: Name, Control Plane Mode, Virtual Switches Count
Relations: NSX Virtual Switches
Firewall Rules
Attributes: Name, Type, Source, Destination, Service, Action, Applied To
Edge Firewall Rules
Attributes: Name, Rule Type, Enabled, Action, Exclude, Sources, Destinations, Ports, Description
IP Pools
Attributes: Name, Ranges, Capacity, Prefix Length, Gateway, DNS Suffix, Primary DNS, Secondary DNS, IP Pool Type
Segment ID Pools
Attributes: Name, Begin, End
IPSec Tunnels
Attributes: Name, Local ID, Local IP, Local Subnets, Peer ID, Peer IP, Peer Subnets

Service Impact

When combined with the Zenoss Service Dynamics product, this ZenPack adds built-in service impact capability for VMware NSX. The following service impact relationships are automatically added. These will be included in any services that contain one or more of the explicitly mentioned entities.

Internal Service Impact Relationships
  • NSX Manager failure affects NSX Controllers
  • NSX Controller failure affects related NSX Controller Cluster
  • NSX Cluster Controller failure affects related NSX Edges and Virtual Switches
  • NSX Edges failure affects related NSX Interfaces and NSX Edge Firewall Rules
  • NSX Interface failure affects related NSX Subinterfaces
External Service Impact Relationships
  • NSX Edges failure affects related OpenStack Router
  • NSX VirtualSwitch failure impacts vSphere Portgroups, Virtual Machines and vNIC, and OpenStack Network
  • NSX Interface failure affects related vSphere Portgroups, Virtual Machines and vNIC


The installation of this ZenPack will create the device class /VMware/NSX. This new device class will provide five new zProperties zNSXUsername, zNSXPassword, zNSXPort, zNSXSSL, and zNSXConcurrentHTTP

Configuring NSX Monitoring

To monitor a NSX device you use the custom device panel via the Add NSX Manager The NSX device could be created only via this menu (Add NSX Manager') and couldn't be created via Add a Single Device, or under other device classes\subclasses. NSX AddNSXManager.png

Provide correct information for the The Hostname or IP Address, Username, Password and Port (443 by default)

NSX Credential.png

If the NSX supports SSL on the port annotated above you must check the SSL box (checked by default).


Adding an NSX Manager with Zenbatchload

You can add an NSX Manager by using the zenbatchload command:

zenbatchload <filename>

where the file <filename> should have the format:

/Devices/VMware/NSX loader='VMware NSX', loader_arg_keys=['name', 'address', 'username', 'password', 'port', 'useSSL', 'collector']
my.nsx name='my.nsx', address='', username='zenoss', password='secret_pass', port=443, useSSL=True, collector='localhost'

For example:

/Devices/VMware/NSX loader='VMware NSX', loader_arg_keys=['name', 'address', 'username', 'password', 'port', 'useSSL', 'collector']
my.nsx name='my.nsx', address='', username='zenoss', password='secret_pass', port=443, useSSL=True, collector='localhost'

System Event Management

Monitoring plugin collects System Events from NSX Manager and shows them as Zenoss Events with the same time and severity.

Standard Zenoss Event Fields
  • device (set to VMware vSphere Endpoint device in the /vSphere device class)
  • component
  • summary
  • severity
  • eventClassKey (for mapping specific event types)
  • eventKey (for de-duplication and auto-clear fingerprinting)

Once the event is sent, it will not be sent again. If the user clears the event, it will not reappear again. There’s no automatic mechanism to clear system events, as they can not be cleared from NSX manager and do not have expire date, therefore the user is to close new events manually from zenoss UI.

Installed Items

Installing this ZenPack will add the following items to your Zenoss system.

Configuration Properties
  • zNSXUsername
  • zNSXPassword
  • zNSXPort
  • zNSXConcurrentHTTP
Device Classes
  • /VMware/NSX
Modeler Plugins
  • zenoss.VMwareNSX
Monitoring Templates
  • NSXController (in /VMware/NSX)
  • NSXEdge (in /VMware/NSX)
  • NSXIpsec (in /VMware/NSX)
  • NSXSegmentIDPool (in /VMware/NSX)
  • NSXIPPool (in /VMware/NSX)
  • NSXInterface (in /VMware/NSX)
  • NSXEdgeFirewallRule (in /VMware/NSX)
  • NSXManager (in /VMware/NSX)

Monitoring Templates

NSXController (/VMware/NSX)
  • Data Points
    • None
  • Thresholds
    • None
  • Graphs
    • None
NSXEdge (/VMware/NSX)
  • Data Points
    • pool_bytesIn
    • pool_bytesOut
    • vserver_bytesIn
    • vserver_bytesOut
  • Thresholds
    • None
  • Graphs
    • Load Balancer - Data Flow
  • Data Points
    • None
  • Thresholds
    • None
  • Graphs
    • None
  • Data Points
    • pool_usage
    • pool_capacity
  • Thresholds
    • None
  • Graphs
    • Pool Usage
  • Data Points
    • pool_usage
    • pool_capacity
  • Thresholds
    • None
  • Graphs
    • Pool Usage
NSXInterface (/VMware/NSX)
  • Data Points
    • in
    • out
  • Thresholds
    • None
  • Graphs
    • Throughput
    • packetCount
    • byteCount
    • connectionCount
  • Thresholds
    • None
  • Graphs
    • Packet Count
    • Byte Count
    • Connection
NSXManager (/VMware/NSX)
  • Data Points
    • capacity
    • usedCapacity
    • totalMemory
    • usedMemory
    • totalStorage
    • usedStorage
  • Thresholds
    • None
  • Graphs
    • CPU Usage
    • Memory Usage
    • Storage Usage


Please refer to the Zenoss Service Dynamics documentation if you run into any of the following problems:

  • ZenPack will not install
  • Adding a device fails
  • Don't understand how to add a device
  • Don't understand how to model a device

If you cannot find the answer in the documentation, then Resource Manager (Service Dynamics) users should contact Zenoss Customer Support. Core users can use the #zenoss IRC channel or the community.zenoss.org forums.

Zenoss Analytics

This ZenPack provides additional support for Zenoss Analytics. Perform the following steps to install extra reporting resources into Zenoss Analytics after installing the ZenPack.

  1. Copy analytics-bundle.zip from $ZENHOME/ZenPacks/ZenPacks.zenoss.NSX*/ZenPacks/zenoss/NSX/analytics/ on your Zenoss server.
  2. Navigate to Zenoss Analytics in your browser.
  3. Login as superuser.
  4. Remove any existing NSX ZenPack folder.
    1. Choose Repository from the View menu at the top of the page.
    2. Expand Public in the list of folders.
    3. Right-click on NSX ZenPack folder and choose Delete.
    4. Confirm deletion by clicking OK.
  5. Add the new NSX ZenPack folder.
    1. Choose Server Settings from the Manage menu at the top of the page.
    2. Choose Import in the left page.
    3. Remove checks from all check boxes.
    4. Click Choose File to import a data file.
    5. Choose the analytics-bundle.zip file copied from your Zenoss server.
    6. Click Import.

You can now navigate back to the NSX ZenPack folder in the repository to see the resources added by the bundle.

The NSX Domain can be used to create ad hoc views using the following steps.

  1. Choose Ad Hoc View from the Create menu.
  2. Click Domains at the top of the data chooser dialog.
  3. Expand Public then NSX ZenPack.
  4. Choose the NSX Domain domain

Known Limitation

  • Legacy ZenPacks.zenoss.ZenVMware zenpack may produce false events for your NSX device. Do not name your NSX device just "NSX" to avoid it.
  • NSX ZenPack may be created only under the NSX device class and with using Add NSX Manager UI or Zenbatchload.
  • Link NSX Edge components to vSphere VMs works only for running VMs.
  • The linkage between NSX and vSphere is established during modeling of the NSX device. If the vSphere device is added after the NSX device, it may be necessary to re-model the NSX device for relationships between their components to be reflected in RM and Impact.
  • Under Zenoss 4.x, an "Unable to set zProperty zCredentialsZProperties" error may be encountered when the ZenPack is installed. This error may be disregarded.


  • Add zNSXConcurrentHTTP zProperty to limit maximum number of simultaneous http connections allowed per NSX manager.
  • Add configuration check for openstack_neutron_integration. (OSI 2.1.1)
  • Fixed metric collection stopping for all Edge and Interfaces if one or more edge vm is powered off. (ZEN-19008)
  • Fixed invalid dictionary for event messages when NSX edge is powered off. (ZEN-19009)
  • Fixed NSX devices failing to collect when there is a 5.x edge device. (ZEN-21660)
  • Fixed TypeError on Edge components. (ZEN-22734)
  • Added modeling and usage monitoring for IP Pools and Segment ID Pools. (ZEN-22189)
  • Link NSX Edge components to vSphere VMs (requires vSphere ZP).
  • Added modeling and monitoring for Edge Firewall Rules for each Edge.
  • Added modeling and monitoring for NSX Subinterfaces
  • Added monitoring for connection state to vCenter (requires vSphere ZP).
  • Added modeling for Routing Protocols.
  • Added modeling for NAT Rules.
  • Added load balancer modeling and monitoring.
  • Fixed traceback during modeling NSX Manager device if one or more Edges is powered off. (ZEN-18984)
  • Initial release


Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.zenoss.NSX-*.egg
  4. Restart these services:
    $ zenoss restart


Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus