Tools and extensions
Other miscellaneous items
Wishlist / Things that make it easy to use or deploy NetXMS

Agent and agent management

What is NetXMS?

NetXMS is an enterprise grade multi-platform modular open source network management and monitoring system. It provides comprehensive event management, performance monitoring, alerting, reporting and graphing for all layers of IT infrastructure — from network devices to business application layer. Having been designed with flexibility and scalability in mind, NetXMS features a wide range of supported platforms. It is licensed under the GNU General Public License version 2 as published by the Free Software Foundation.

NetXMS is a multi-platform network management and monitoring system that offers event management, performance monitoring, alerting, reporting and graphing for the entire IT infrastructure model. NetXMS’s main features include support for multiple operating systems and database engines, distributed network monitoring, auto-discovery, and business impact analysis tools, amongst others. NetXMS gives you the option to run a web-based interface or a management console.

Once you login to NetXMS you need to first go to the “Server Configuration” window to change a few settings that are dependent on your network requirements (e.g. changing the number of data collection handlers or enabling network discovery). You can then run the Network Discovery option for NetXMS to automatically discover devices on your network, or add new nodes by right clicking on “Infrastructure Services” and selecting Tools > Create Node.

Does NetXMS support Windows and Unixes?

Yes. NetXMS support both Windows and Unixes.

How can we install NetXMS server onto Windows?

  1. Download the latest version of the server
    1. Go to
    2. Scroll down to the SERVER BINARIES section and download the appropriate file for your platform.
    3. Please note that in following steps VERSION will be used as a substitution for an actual version number.
  2. Run the installer package on your server machine.
    1. Installation wizard will be shown. Follow the prompts until the Select Components window opens.
  3. Select NetXMS Server option and an appropriate database client library (in the Select Components window).
    1. You do not have to install database client library from NetXMS package, if it is already installed on the machine. If you plan to run NetXMS console from the same machine, select Administrator’s Console option as well.
  4. Follow the prompts until Ready to Install window opens.
  5. Check whether everything is correct and press the Install button (on Ready to Install window)
  6. After copying files, Server Configuration Wizard will open. Press the Next button to start NetXMS server configuration. Database selection window will open:
    1. Select the desired database engine and driver (native or ODBC). For most databases, you will have two drivers available – native and ODBC. Please note that if you select ODBC, you will have to manually configure ODBC source.
    2. Enter the name of database server or ODBC source.
    3. If you have chosen the Create new database option, do the following:
      • Provide the database administrator’s login name and password. You have to fill these fields only if you have chosen Create new database option.
    4. Enter the desired database name, database user name and password. If you are not using ODBC, the wizard will create database and a user for you. If ODBC is used, database and user should be created beforehand.
  7. Provide various values for polling parameters:
    • If you wish NetXMS server to automatically discover your IP network check the "Check Run IP autodiscovery process check-box"
    • Increase number of status and configuration pollers if you plan to monitor large number of nodes.
  8. Enter address of your SMTP server. NetXMS will use it to send notification e-mails. If you have mobile phone attached to management server via serial cable or USB, select mobile phone driver and COM port; otherwise, select “<none>”.
  9. Choose appropriate logging method (either the Windows Event Log or a file), and press the Next button. The Windows service configuration window will appear.
  10. In most situations, you can run NetXMS server under Local System account. You may need to run it under specific account if you are using Microsoft SQL database andWindows authentication, or for security reasons.
  11. Windows service dependency window will appear: If you have database engine running on same server, you can find it in service list and mark, so NetXMS server’s service will depend on database service and service startup order will be correct.
  12. Follow the prompts until server configuration will be complete. After successful server configuration, installation will be finished, and you will have NetXMS server up and running.

How can we install NetXMS agent onto Windows?

  1. Download the latest version
    1. Go to
    2. Scroll down to the "Agent Packages" section. You will need the Windows Agent installer (named nxagent-VERSION.exe or nxagent-VERSION-x64.exe, for example nxagent-1.2.0.exe).
  2. Run the installer package on target machine. Installation wizard will be shown.
    • Follow the prompts until the NetXMS Server window opens:Enter IP address or host name of your NetXMS server. You can specify multiple management servers, separating them by commas. Press the Next button to continue.
  3. Select sub-agents
    • You can select which subagents you wish to load. Each subagent extends agent’s functionality, as described below:
      • ping.nsm: Adds possibility to send ICMP pings from monitored host. Ping round-trip times can be collected by management server.
      • portcheck.nsm: Adds possibility to check network services (like FTP or HTTP) from monitored host.
      • winperf.nsm: Provides access to Windows performance counters. This subagent is required if you need to collect CPU utilization from monitored host.
      • wmi.nsm: Provides access to WMI data.
      • ups.nsm: Adds support for UPS monitoring. UPS can be attached to host via serial cable or USB. For more information about subagents, please refer to Subagents.
  4. Follow the prompts to complete the installation.

How can we install the NetXMS Desktop Management Console onto Windows?

  1. Download the latest version
    1. Go to
    2. Scroll down to the "" section and select appropriate file for your platform.
  2. Extract zip in preferred directory.
  3. Run nxmc file form extracted catalog.

How can we install the Web Management console onto Windows?

On Windows, we have 2 options:

  • install manually servlet container and just download tar
  • use netxms-webui-VERSION.exe installer. This installer will install by itself jetty and copy into required folder tar file.

Here, we will be describe only automated way of installation:

  1. Download the latest version
    1. Go to
    2. Scroll down to the "" section and select the appropriate file for your platform
  2. Run the installer package on your server machine. Installation wizard will be shown. Follow the prompts. While installation it will be possible to change installation path and port.
  3. After installation procedure is finished check that WEB GUI is available at http://SERVER_IP:SERVER_PORT/nxmc/

What is the default credential?

The default admin username and password: admin / netxms

What are the components of the architecture?

The system has three-tier architecture: the information is collected by monitoring agents (either our own highperformance agents or SNMP agents) and delivered to monitoring server for processing and storage. Network administrator can access collected data using cross-platform Management Console,Web Interface or Management Console for Android.

  1. NetXMS server: is daemon or service. It collects, process and stores data, does network discovery. Server is modular and can be extended with additional functionality. By it selves server can collect only some simple information about nodes or can use SNMP agent to collect data from SNMP-capable devices. NetXMS has special drivers for different types of SNMP devices that collect data like VLANs, interfaces and other default collected information.
  2. NetXMS agent: is daemon or service that is installed on nodes to provide additional monitoring options and can be used like SNMP agent or NetXMS agent proxy. Agent implements communication with server and work with configuration. Agent functionality is extended with subagents. Server uses 4701 port to communicate with agents.
    1. There are default OS subagents and manually loaded like file manager, ping or others. There are different types of subagents. It can be just a library that is loaded by NetXMS agent or it can be application that uses NetXMS subagent library to provide required subagent interface. Library type of subagents can be run as one process with agent or as a separate process. It can be used when it is necessary to run them under different user privileges. Agent uses 4700 port to communicate with server.
    2. Subagent can be also run as a separate application. NetXMS also provides some command line tools like nxdbmgr(work with NetXMS database), nxencpasswd(password encryption) and others. Information about this tools can be found in Command line tools chapter.

How can we configure SMTP?

  1. Launch the NetXMS management console
  2. Click on Configuration -> Server Configuration
  3. Scroll down to find the SMTP settings
  4. Double click on the setting in the table or right-click and select Edit.

The following parameters may need to be changed:

  • SMTPFromAddr: Address that will be shown as a sender address when notification from NetXMS will come.
  • SMTPFromName: Name that will be shown as a sender name when notification from NetXMS will come.
  • SMTPRetryCount: Number of retries that NetXMS will try to do in case if message sending will fail.
  • SMTPServer: Server IP address or DNS name where NetXMS will send request for message dispatch.

Can we define multiple thresholds for a single DCI?

Yes. You also have the possibility to define more than one threshold for a single DCI, which allows you to distinguish between different severity conditions.

How can we generate report?

NetXMS is integrated with Jasper reporting engine from Jaspersoft. This view allows user to generate report and download result as PDF file. Report generation can take long time, so it’s done in background, without user interaction. When report is generated, resulting PDF can be downloaded any time, as well as any result from previous runs.

To generate report:

  1. Right-click on report name in Object Browser and select Open report in pop-up menu, report view will open (as show in figure above)
  2. In report view, fill parameters and click Generate Report

You can monitor progress in Server Jobs view. To open it, select Window→ Show view→Other→ Server Jobs. When report is generated, new finished job will appear in Results table of the view. Select it and click on Render to PDF to download.

When generated report data is not longer needed, it can be deleted from the sever by selecting job in Results view, and then clicking Delete.

What happens if I close all the Views?

You can re-open them from the Views menu.

What are different poll types?

  1. Status poll: Check to see if the node is up
  2. Data collection poll:
  3. Topology poll:
  4. Configuration poll:
  5. Interface poll:

How can we add a set of DCIs to many nodes?

  1. Create a template
  2. Right click on the template and select Data Collection Configuration
  3. Add the DCIs
  4. Right click on the template and select Apply.

How can we see some graphs?

  1. Go to a particular node
  2. Click on the "Last Value" tab
  3. Right-click on the particular DCI and select "Line chart"

How can we see multiple DCI on one graph?

  1. Go to a particular node
  2. Click on the "Last Value" tab
  3. Click on the first DCI
  4. Hold down the SHIFT key and click on other DCIs
  5. Right-click and select "Line Chart"

How can we create a graph?

  1. Go to a particular node
  2. Click on the "Last Value" tab
  3. Click on the first DCI
  4. Hold down the SHIFT key and click on other DCIs
  5. Right-click and select "Line Chart"
  6. Right-click on the graph and select Properties to add more data-source (DCIs)
  7. Click the Apply button to close out the Properties window
  8. Right-click on the graph to make other changes if necessary
  9. Click on the Save icon

How can we see our saved graphs?

  1. Click on View -> Predefined Graphs

Can NetXMS trigger an alarm based on the syslog message that it receives?

Yes. NetXMS includes a built-in syslog server, but you must first enable it. Do that through the server configuration interface. After the syslog server is enabled, NetXMS can receive incoming syslog message from other servers (you must configure these servers to forward syslog message). You can view and filter syslog message. You can also set up alert. This is done through the "Syslog Parser configuration" interface. You can set up the alert based on the text that the message contains.

How can we create a new dashboard?

  1. Right click on Dashboard (in the Object browser)
  2. Select "Create dashboard"
  3. Give it a name and click OK. (The dashboard is created but it may not be obviously visible)
  4. Drill down Dashboards
  5. Right-click on the dashboard and select Properties.
  6. Click on Dashboard Elements
  7. Specify the number of columns that this dashboard contains
  8. Click on the Add button to add elements
    1. Select appropriate type for the element and click OK
    2. Click on the element that just got added
    3. Click on the Edit button
    4. Specify the title and other attributes
    5. Click on the Data Sources category to add data sources.
    6. Click OK until all the dialogs are dismissed
    7. Close the dashboard if you currently have it opened
    8. Double-click on the name of the dashboard in the object browser to re-open it.

How can we configure actions and alarms?

In this section will be shown how to configure alarm and email notifications generation on the SYS_THRESHOLD_REACHED (predefined) event and the SYS_THRESHOLD_REARMED (predefined) event.

  1. Created Send E-Mail action in Action Configuration view. There we will set recipient of e-mail, subject and body of e-mail. In body of e-mail will be used Macros for Event Processing. hen message will be sent, macros “%n” will be substituted with name of the node and “%m” will be substituted with event message. Value of event message is personal for each event and can be found in event description.
    1. Go to "Tools -> Action Configuration"
    2. Click on the plus icon in the top right hand corner. Give this action an appropriate name. Select appropriate type. If you want this action to send email, select the "Send E-Mail" type. Fill out the other fields and click OK.
  2. Add processing policies. It is done in Event Processing Policy view. We will add this rules before all other rules as it it is planed that this rules will be most commonly used ones.
    1. Go to "Tools -> Event Processing Policy"
    2. Right click on the appropriate row and select either "Insert before" or "Insert after"
    3. Click on the row that just got inserted and click on the "Edit rule" icon on the right hand side.
    4. Specify the conditions (source objects, events), actions, comment (name for the rule) and click OK
    5. Click on the Save button.

For each DCI, we specify the threshold and the event that get trigger. However, it seems that we cannot create an event processing rule that is specific to a particular DCI.

How does NetXMS do status calculation?

Each object has it’s own status calculation properties. By default status is calculated based on polling results, status of underlying objects, associated alarms and status DCIs. But there can be used different options of status calculation. Status calculation has two configuration parts: status propagation and status calculation.

How can we control access to nodes?

Object access rights controls access to NetXMS objects. Permissions given to an object inherited by all child objects, unless specifically blocked by turning off Inherit access rights from parent object(s) option in object’s access control properties. Permissions given at different levels of the object tree summarize to form effective user rights for the object.

Where can we find the configuration file for the agent?

On Windows, the configuration file for the agent is automatically created:


On Unix, after agent is installed, we must manually create /etc/nxagentd.conf

Minimal configuration that should be set for agent is server address and path to log file.

If MasterServer was set correctly no action is required form user. This file should contain at least this information:

# Sample agent’s configuration file
MasterServers =
LogFile = /var/log/nxagentd

Where can we find the configuration file for the server?


On UNIX based systems, we have to manually create the /etc/netxmsd.conf file:

DBDriver = oracle.ddr
DBServer = ServerIP/Hostname.DomainName #Here is service (full database name), not SID
DBName = netxms
DBLogin = netxms
DBPassword = PaSwD
LogFailedSQLQueries = yes
LogFile = /var/log/netxmsd

How can I determine the version number?

For the management console, we can determine the version number by clicking on Help -> About NetXMS Management Console. For the agent, do:

nxagentd -v

For the server, do:

netxmsd -v
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License