Debug Console
The NetXMS server provides an interactive debug console for runtime diagnostics, configuration changes, and troubleshooting.
Accessing the Debug Console
Local Access with nxadm
Connect to a locally running server using the nxadm tool:
nxadm -iThis opens an interactive session. Type help to see available commands.
To execute a single command without entering interactive mode:
nxadm -u <login> -c "show stats"Console access is authenticated by default (Server.Security.RestrictLocalConsoleAccess server configuration variable, enabled by default).
Interactive mode prompts for credentials; for one-shot commands, pass the login with -u (the password is supplied with -p or prompted for with -P).
nxadm -s <script> executes an NXSL script — the argument is resolved as a script library name first, or loaded from the given file and compiled.
Command Reference
Task Scheduling
| Command | Description |
|---|---|
|
Schedule one-time NXSL script execution after given delay in seconds; script arguments are passed in parentheses, e.g. |
For recurring schedules, use scheduled tasks in the management client — the console at command cannot accept a multi-field cron schedule.
Device Configuration Backup
| Command | Description |
|---|---|
|
Show latest device configuration backup for given node |
|
Start device configuration backup for given node |
|
Show device configuration backup status for given node |
Server Control
| Command | Description |
|---|---|
|
Shut down NetXMS server |
|
Show high availability cluster status (available only when the server runs in cluster mode) |
|
Perform graceful switchover to the standby cluster node (available only when the server runs in cluster mode) |
|
Run housekeeper immediately |
|
Synchronize LDAP users with local user database |
|
Force server log file rotation |
|
Reload MIB tree from compiled MIB file |
|
Wake up syncer thread immediately (force pending data writes to database) |
Configuration Variables
| Command | Description |
|---|---|
|
Get value of server configuration variable |
|
Set value of server configuration variable; the value must be a single word without whitespace |
Debug and Logging
| Command | Description |
|---|---|
|
Show or set global debug level (0..9) |
|
Set debug level for a specific debug tag, or reset to default ( |
|
Turn SQL query trace on or off |
|
Write process memory dump (Windows only) |
|
Write custom text to the server log |
|
Write a marker line ( |
|
Raise exception ( |
|
Create object access snapshot for given user ID |
Script Execution
| Command | Description |
|---|---|
|
Execute NXSL script from an allowed script location |
Script resolution for exec is controlled by the DebugConsole.AllowedScriptLocations server configuration variable — an ordered, comma-separated list of locations searched left to right.
The default @library resolves scripts from the script library; absolute directory paths can also be listed.
An empty value disables the command.
Script names must not contain path separators.
Database
| Command | Description |
|---|---|
|
Show list of valid component names that can be cleared |
|
Clear internal data or queue ( |
|
Reset database connection pool |
Session Management
| Command | Description |
|---|---|
|
Exit from remote session |
|
Kill client session by session ID |
|
Send notification message to a client session |
Network Diagnostics
| Command | Description |
|---|---|
|
Send ICMP echo request to given IP address |
|
TCP ping to a specific address and port |
|
Show network path trace between two nodes |
Polling and Discovery
| Command | Description |
|---|---|
|
Initiate node poll (types: |
|
Manual network discovery scan over an IP range; optionally specify proxy node or zone; add |
Tunnel Management
| Command | Description |
|---|---|
|
Bind an agent tunnel to a node |
|
Unbind an agent tunnel from a node |
Thread Pool
| Command | Description |
|---|---|
|
Start test tasks in given thread pool for load testing |
Show Commands
| Command | Description |
|---|---|
|
Show AI operator instances |
|
Show configured AI providers |
|
Show AI provider slots |
|
Show ARP cache for given node |
|
Show active user authentication tokens |
|
Show physical components of given node |
|
Show active sessions in database connection pool |
|
Show database library statistics |
|
Show state of active network discovery by address range |
|
Show event processing threads statistics |
|
Show event processing policy rules |
|
Show forwarding database for given node |
|
Show internal server flags |
|
Show detailed heap memory information |
|
Show heap usage summary |
|
Show internal index (valid names: |
|
Show LLDP topology information for given node |
|
Show memory usage information |
|
Show management server node information |
|
Show loaded server modules |
|
Show registered network device drivers |
|
Dump network objects to screen, optionally filtered by name, ID, or GUID |
|
Show OSPF topology information for given node |
|
Show poller threads state information; add |
|
Show internal queues statistics |
|
Show cached routing table for given node |
|
Show active client and mobile device sessions |
|
Show sizes of internal data structures |
|
Show global server statistics |
|
Show data syncer statistics |
|
Show background tasks |
|
Show thread statistics; optionally for a specific thread pool |
|
Collect and show link layer topology for given node |
|
Show active agent tunnels |
|
Show registered users and groups |
|
Show NetXMS server version |
|
Show cached VLAN information for given node |
|
Display watchdog information |
Examples
poll configuration 150get Syslog.AllowUnknownSources
set Syslog.AllowUnknownSources 1debug poll.status 7debug poll.status defaultscan 10.0.0.1 10.0.0.254 zone 5 discoveryat +60 MyCleanupScriptshow stats
show queues
show threadsshow tunnelsreload mibFor more details on debug logging and tags, see Diagnostics. For common problems and solutions, see Common Issues.