NetXMS Wiki - User contributions [en]

SG:Security Issues

2018-01-31T00:34:19Z

Tomas Kirnak: Updated default Trusted Nodes to false - change in 2.x

{{DISPLAYTITLE:Security Issues}}
Because NXSL provides functions for searching objects, and because all scripts are executed on management server, user with write access to only one node can potentially acquire information about nodes to which he normally does not have access. For example, without additional security checks user with write access to node A and no access to node B can create transformation script for DCI on node A and use [[NXSL:FindNodeObject|FindNodeObject]] function to access node B and get information about it, thus breaking security settings.

To prevent such scenario, all NXSL functions capable of accessing NetXMS objects requires "current node" object to be provided. Reference to object being searched will only be returned if node object supplied as "current node" is in trusted nodes list of target object. For example, if variable '''$node''' in script refers to NODE1, and [[NXSL:FindNodeObject|FindNodeObject]]($node, "NODE2") called, NODE1 must be added to list of trusted nodes for NODE2. In most places (transformation script, event processing policy, etc.) predefined variable '''$node''' exists, which refers to node object on behalf of which script is being executed. It will be event source for event processing policy script, DCI owner for transformation script, and so on.

For environments where such strict security checks are not required (for example, all users have read access to all nodes), they can be disabled to simplify configuration. Enforcement of trusted nodes checking controlled by server's configuration variable '''CheckTrustedNodes'''. By default it is set to '''0''' and check of trusted nodes is not enforced. To enable it, server's configuration variable '''CheckTrustedNodes''' must be set to '''1'''. The server restart is required to make this change effective.

[[Category:Scripting Guide]]

Reseting state of all alarms and node statuses

2018-01-12T18:02:52Z

Tomas Kirnak:

Sometimes, it can be useful to reset the "state" of all your NetXMS objects completely.

For example, if you recover the DB from an older date, a lot of alarms and node statuses will be outdated. 
However, some alarms might not terminate due to the current status of the system differing from the previous state. 

Its also possible that you miss-configured EPP to not close down alarms, etc. 
There is many ways when the NetXMS alarms can become abandoned, or out-of-state due to user errors or infrastrucutre issues. 

Basically, your NetXMS system will be reset to a state where it "thinks" all things are currently OK. 
So after it starts up, it will regenerate all alarms for things that are not in a state they should be. 

After performing this procedure, you can be sure that the outstanding alarms are current.

Before you start, make sure to shut down the NetXMS server, and run "nxdbmgr check".

To completely reset the state of all object you can: 
(these commands should be run on the database NetXMS uses)
UPDATE thresholds SET current_state=0;
UPDATE alarms SET alarm_state=3;
TRUNCATE TABLE alarm_events;
UPDATE nodes SET runtime_flags = 0;
UPDATE interfaces SET admin_state=0,oper_state=0;
UPDATE object_properties SET status=5 WHERE object_id IN (SELECT id FROM interfaces);
UPDATE items SET status=0 WHERE status=2;

This will:
*Terminate all alarms
*Set nodes to properly generate new alarms if down, agent unreachable, etc.
*Set threshold to properly generate new alarms if violated
*Set interfaces to properly generate new alarms if not in expected state

You will lose:
*Any one-time alarms (from Syslog, SNMP traps, etc.)
*State of alarms (acknowledged, etc.)
*Comments on alarms

Reseting state of all alarms and node statuses

2018-01-12T18:02:01Z

Tomas Kirnak:

Sometimes, it can be useful to reset the "state" of all your NetXMS objects completely.

For example, if you recover the DB from an older date, a lot of alarms and node statuses will be outdated. 
However, some alarms might not terminate due to the current status of the system differing from the previous state. 

Its also possible that you miss-configured EPP to not close down alarms, etc. 
There is many ways when the NetXMS alarms can become abandoned, or out-of-state due to user errors or infrastrucutre issues. 

Basically, your NetXMS system will be reset to a state where it "thinks" all things are currently OK. 
So after it starts up, it will regenerate all alarms for things that are not in a state they should be. 

After performing this procedure, you can be sure that the outstanding alarms are current.

Before you start, make sure to shut down the NetXMS server, and run "nxdbmgr check".

To completely reset the state of all object you can: 
UPDATE thresholds SET current_state=0;
UPDATE alarms SET alarm_state=3;
TRUNCATE TABLE alarm_events;
UPDATE nodes SET runtime_flags = 0;
UPDATE interfaces SET admin_state=0,oper_state=0;
UPDATE object_properties SET status=5 WHERE object_id IN (SELECT id FROM interfaces);
UPDATE items SET status=0 WHERE status=2;

This will:
*Terminate all alarms
*Set nodes to properly generate new alarms if down, agent unreachable, etc.
*Set threshold to properly generate new alarms if violated
*Set interfaces to properly generate new alarms if not in expected state

You will lose:
*Any one-time alarms (from Syslog, SNMP traps, etc.)
*State of alarms (acknowledged, etc.)
*Comments on alarms

Reseting state of all alarms and node statuses

2018-01-12T18:01:27Z

Tomas Kirnak:

Sometimes, it can be useful to reset the "state" of all your NetXMS objects completely.

For example, if you recover the DB from an older date, a lot of alarms and node statuses will be outdated. 
However, some alarms might not terminate due to the current status of the system differing from the previous state. 

Its also possible that you miss-configured EPP to not close down alarms, etc. 
There is many ways when the NetXMS alarms can become abandoned, or out-of-state due to user errors or infrastrucutre issues. 

Basically, your NetXMS system will be reset to a state where it "thinks" all things are currently OK. 
So after it starts up, it will regenerate all alarms for things that are not in a state they should be. 

After performing this procedure, you can be sure that the outstanding alarms are current.

Before you start, make sure to shut down the NetXMS server, and run "nxdbmgr check".

To completely reset the state of all object you can: 
UPDATE thresholds SET current_state=0;
UPDATE alarms SET alarm_state=3;
TRUNCATE TABLE alarm_events;
UPDATE nodes SET runtime_flags = 0;
UPDATE interfaces SET admin_state=0,oper_state=0;
UPDATE object_properties SET status=5 WHERE object_id IN (SELECT id FROM interfaces);
UPDATE items SET status=0 WHERE status=2;

This will:
*Terminate all alarms
*Set nodes to properly generate new alarms if down, agent unreachable, etc.
*Set threshold to properly generate new alarms if violated
*Set interfaces to properly generate new alarms if not in expected state

You will lose:
*Any one-time alarms (from Syslog, SNMP traps, etc.)
*State of alarms (acknowledged, etc.)

Reseting state of all alarms and node statuses

2018-01-12T18:00:41Z

Tomas Kirnak: Created page with "Sometimes, it can be useful to reset the "state" of all your NetXMS objects completely. For example, if you recover the DB from an older date, a lot of alarms and node status..."

Sometimes, it can be useful to reset the "state" of all your NetXMS objects completely.

For example, if you recover the DB from an older date, a lot of alarms and node statuses will be outdated. 
However, some alarms might not terminate due to the current status of the system differing from the previous state. 

Its also possible that you miss-configured EPP to not close down alarms, etc.
There is many ways when the NetXMS alarms can become abandoned, or out-of-state due to user errors or infrastrucutre issues.

Basically, your NetXMS system will be reset to a state where it "thinks" all things are currently OK.
So after it starts up, it will regenerate all alarms for things that are not in a state they should be.

After performing this procedure, you can be sure that the outstanding alarms are current.

Before you start, make sure to shut down the NetXMS server, and run "nxdbmgr check".

To completely reset the state of all object you can: 
UPDATE thresholds SET current_state=0;
UPDATE alarms SET alarm_state=3;
TRUNCATE TABLE alarm_events;
UPDATE nodes SET runtime_flags = 0;
UPDATE interfaces SET admin_state=0,oper_state=0;
UPDATE object_properties SET status=5 WHERE object_id IN (SELECT id FROM interfaces);
UPDATE items SET status=0 WHERE status=2;

This will:
*Terminate all alarms
*Set nodes to properly generate new alarms if down, agent unreachable, etc.
*Set threshold to properly generate new alarms if violated
*Set interfaces to properly generate new alarms if not in expected state

You will lose:
*Any one-time alarms (from Syslog, SNMP traps, etc.)
*State of alarms (acknowledged, etc.)
*Comments on alarms

Main Page

2018-01-12T15:50:34Z

Tomas Kirnak: /* Miscellaneous Documents */

__NOTOC__
= Manuals =

NB! Administrator and operator guides are migrated from Wiki to separate documents: [[http://www.netxms.org/documentation/adminguide Admin Guide - Online]], [[http://www.netxms.org/documentation/netxms-admin.pdf Admin Guide - PDF]], [[http://www.netxms.org/documentation/userguide Operator Guide - Online]], [[http://www.netxms.org/documentation/netxms-user.pdf Operator Guide - PDF]].

To contribute, please contact us at team@netxms.org for write access to documentation repository.

[[Installation Guide]]

[[User Manual]]

[[Scripting Guide]]

[[System Reference]]

[[Using APT Repository|APT Repository for Debian/Ubuntu]]

[[Compiling NetXMS for OpenWRT]]

= Tutorials =

[[NetXMS Video Tutorial Series]]

[[How to send e-mail notification when disk space is low]]

[[Using nxshell to automate bulk operations]]

[[NetXMS as a cluster (high-availability) application]]

[[Creating a Dashboard]]

[[Creating SNMP table DCI]]

[[OS process monitoring using SNMP]]

[[Step by step service monitoring]]

[[Reporting server setup]]

[[NetXMS Grafana datasource setup]]

[[Deploy NetXMS WebAPI using the WebUI Windows installer (Windows only!)]]

= Miscellaneous Documents =

This section contains useful documents which should be part of User Manual, but not integrated there yet.

[[OS X Java issues]]

[[ExternalParametersProvider|External Parameters Provider]]

[[Autologin for Management Console]]

[[Unsorted Features List]]

[[Windows Performance Counters]]

[[How to Install Agent on ZeroShell]]

[[Enable SNMP for devices without standard system MIB]]

[[Add new MIBs]]

[[How to Encrypt Database Passwords]]

[[Running NetXMS under debugger]]

[[Details about database connection]]

[[How to migrate to another database]]

[[How to enable ICMP ping for NetXMS server running under non-root account]]

[[How to fix console crash on Linux]]

[[How to configure agent to server connection]]

[[NetXMS WebAPI]]

[[Reseting state of all alarms and node statuses]]

= Solutions =

[[Uninterruptible Power Supply (UPS) Monitoring]]

[[UPS Monitoring (APC) via SNMP]]

[[IBM Storwize V7000|IBM Storwize V7000 (and possibly other IBM arrays)]]

[[HP P2000]]

[[Linux monitoring]]

[[MTBF (Mean Time Between Failures) and MTTR (Mean Time To Repair) Calculation]]

[['Backbone' L3 Map - map without end-device subnets]]

[[Ubiquiti and Ligowave wireless monitoring]]

[[Application monitoring]]

[[Mass node import into NetXMS]]

= Integration =
[[NetXMS Integration with HP Operations Manager]]

[[Slack.com integration]]

= Documentation for Developers =
[[Coding Style]]

[[Communication Protocol Reference Guide]]

[[Internal API]]

[[Network Device Drivers]]

[[How to setup Eclipse/RAP]]

[[How to compile report-generator]]

[[Working with UNICODE]]

[[Web service API]]

[[Building Debian packages]]

NXSL:Zone

2018-01-05T18:42:23Z

Tomas Kirnak: proxyNode description update

Represents NetXMS zone object

'''Class Name'''

Zone

'''Attributes'''

Inherits all attributes of the [[NXSL:NetObj|NetObj class]].

{| class="wikitable"
|-
! Name !! Type !! Description
|-
| proxyNode || object ([[NXSL:Node|Node]]) || Node object used as Zone proxy ('''null''' if zone has no proxy)
|-
| proxyNodeId || int32 || Identifier of node object used as proxy
|-
| uin || int32 || Zone UIN
|}

[[Category:NXSL Class Reference]]

NXSL:Zone

2018-01-05T18:41:02Z

Tomas Kirnak: Updated after recent zone rework (ID changed to UIN, proxy attribute updates)

Represents NetXMS zone object

'''Class Name'''

Zone

'''Attributes'''

Inherits all attributes of the [[NXSL:NetObj|NetObj class]].

{| class="wikitable"
|-
! Name !! Type !! Description
|-
| proxyNode || object ([[NXSL:Node|Node]]) || Identifier of node object used as agent proxy
|-
| proxyNodeId || int32 || Identifier of node object used as proxy
|-
| uin || int32 || Zone UIN
|}

[[Category:NXSL Class Reference]]

NXSL:Node

2018-01-05T18:38:36Z

Tomas Kirnak: Updated zoneId to ZoneUIN

Represents NetXMS node object.

'''Class Name'''

Node

'''Attributes'''

Inherits all attributes of the [[NXSL:NetObj|NetObj class]].

{| class="wikitable"
|-
! Name !! Type !! Description
|-
| agentVersion || string || NetXMS agent's version
|-
| bootTime || int64 || Node boot time or 0 if not known (in seconds since epoch)
|-
| bridgeBaseAddress || string || Bridge base address (will return "000000000000" if not known or node is not a bridge/switch)
|-
| components || object ([[NXSL:Component | Component]]) || The root physical component object of the node
|-
| driver || string || Driver name
|-
| [[NXSL:Node:flags | flags]] || uint32 || Node flags (bit mask)
|-
| "is802_1x" or "isPAE" || boolean || TRUE if node supports 802.1x
|-
| isAgent || boolean || TRUE if NetXMS agent detected on node
|-
| isBridge || boolean || TRUE if node is a bridge
|-
| isCDP || boolean || TRUE if node supports CDP (Cisco Discovery Protocol)
|-
| isLLDP || boolean || TRUE if node supports LLDP (Link Layer Discovery Protocol)
|-
| "isLocalMgmt" or "isLocalManagement" || boolean || TRUE if node is a local management server (NetXMS server)
|-
| isPrinter || boolean || TRUE if node is a printer
|-
| isRouter || boolean || TRUE if node is a router (has IP forwarding enabled)
|-
| isSMCLP|| boolean || TRUE if SMCLP agent detected on node
|-
| isSNMP || boolean || TRUE if SNMP agent detected on node
|-
| isSONMP || boolean || TRUE if node supports SONMP/NDP (Synoptics/Nortel Discovery Protocol)
|-
| platformName || string || Platform name reported by NetXMS agent
|-
| [[NXSL:Node:runtimeFlags | runtimeFlags]] || uint32 || Node runtime flags (bit mask)
|-
| snmpOID || string || SNMP object identifier (value of .1.3.6.1.2.1.1.2.0)
|-
| snmpSysContact || string || SNMP system contact (value of .1.3.6.1.2.1.1.4.0)
|-
| snmpSysLocation || string || SNMP system location (value of .1.3.6.1.2.1.1.6.0)
|-
| snmpSysName || string || SNMP system name (value of .1.3.6.1.2.1.1.5.0)
|-
| snmpVersion || int32 || Configured SNMP version (0 for SNMP version 1, 1 for SNMP version 2c, 2 for SNMP version 3)
|-
| sysDescription || string || System description (value of System.Uname for nodes with agents or .1.3.6.1.2.1.1.1.0 for SNMP nodes)
|-
| zone || object ([[NXSL:Zone|Zone]]) || Zone object ('''null''' if zoning is disabled)
|-
| zoneUIN || int32 || Zone UIN (0 if zoning is disabled)
|}

'''Methods'''
{| class="wikitable"
|-
! Name !! Parameters !! Return value !! Description
|-
| [[NXSL:NetObj:clearGeoLocation|clearGeoLocation]] || none || none || Clears GeoLocation data from the node
|-
| [[NXSL:NetObj:setGeoLocation|setGeoLocation]] || Object of [[NXSL:GeoLocation|GeoLocation]] class || none || Sets GeoLocation data for the node
|-
| enableAgent || boolean || none ||Enable or disable usage of NetXMS agent for all polls
|-
| enableConfigurationPolling || boolean || none || Enable or disable configuration polling for a node
|-
| enableIcmp || boolean || none || Enable or disable usage of ICMP pings for status polls
|-
| enableRoutingTablePolling || boolean || none || Enable or disable routing table polling (since 2.1.1)
|-
| enableSnmp || boolean || none || Enable or disable usage of SNMP for all polls
|-
| enableStatusPolling || boolean || none || Enable or disable status polling for a node
|-
| enableTopologyPolling || boolean || none || Enable or disable topology polling
|}

Example (disable usage of NetXMS agent for all polls):
$node->enableAgent(false);

[[Category:NXSL Class Reference]]

NXSL:SetCustomAttribute

2017-12-21T16:20:10Z

Tomas Kirnak:

__NOTOC__
Set value of objects custom attribute. If attribute was not defined, it will be created.

'''Since:''' 1.1.1

== Syntax ==
SetCustomAttribute(''object'', ''attributeName'', ''value'')

== Parameters ==
{| class="wikitable"
|-
| ''object'' || Any object of [[NXSL_Class_Reference|NetObj class]], or its sub-classes.
You can use predefined variable $node to refer to current node. You can also use null as node if trusted nodes check is disabled (see [[SG:Security Issues|Security Issues]] for more information).
|-
| ''attributeName'' || Custom attribute name.
|-
| ''value'' || New value for custom attribute.
|}

== Return Value ==

Previous value of requested custom attribute or '''NULL''' if attribute was not defined before.

== Examples ==

SetCustomAttribute($node, "my_attribute", "new value") -> "old value"
SetCustomAttribute($node, "non_existing_attribute", "new value") -> NULL

NXSL:GetCustomAttribute

2017-12-21T16:19:53Z

Tomas Kirnak:

__NOTOC__
Get value of objects custom attribute.

== Syntax ==
GetCustomAttribute(''object'', ''attributeName'')

== Parameters ==
{| class="wikitable"
|-
| ''object'' || Any object of [[NXSL_Class_Reference|NetObj class]], or its sub-classes.
You can use predefined variable $node to refer to current node. You can also use null as node if trusted nodes check is disabled (see [[SG:Security Issues|Security Issues]] for more information).
|-
| ''attributeName'' || Custom attribute name.
|}

== Return Value ==

String value of requested custom attribute or '''NULL''' if attribute is missing.

== Notes ==
If attribute name conforms to NXSL identifier naming conventions, it can be accessed directly as node object attribute. For example “GetCustomAttribute($node, "my_attribute")” can be changed to “$node->my_attribute”. If custom attribute does not exist, accessing via "->" will generate error. Alternative way it to use syntax "my_attribute@$node", which will return NULL for missing attribute instead.

== Examples ==

GetCustomAttribute($node, "my_attribute") -> "my value"
GetCustomAttribute($node, "bad_attribute_name") -> NULL

NXSL:DeleteCustomAttribute

2017-12-21T16:19:34Z

Tomas Kirnak:

__NOTOC__
Delete objects custom attribute.

'''Since:''' 1.2.17

== Syntax ==
DeleteCustomAttribute(''object'', ''attributeName'')

== Parameters ==
{| class="wikitable"
|-
| ''object'' || Any object of [[NXSL_Class_Reference|NetObj class]], or its sub-classes.
You can use predefined variable $node to refer to current node. You can also use null as node if trusted nodes check is disabled (see [[SG:Security Issues|Security Issues]] for more information).
|-
| ''attributeName'' || Custom attribute name.
|}

== Return Value ==

'''null'''

== Examples ==

<syntaxhighlight lang="c">
DeleteCustomAttribute($node, "my_attribute");
</syntaxhighlight>

NXSL:DeleteCustomAttribute

2017-12-21T16:19:12Z

Tomas Kirnak:

__NOTOC__
Delete objects custom attribute.

'''Since:''' 1.2.17

== Syntax ==
DeleteCustomAttribute(''object'', ''attributeName'')

== Parameters ==
{| class="wikitable"
|-
| ''object'' || any object of [[NXSL_Class_Reference|NetObj class]], or it's sub-classes
You can use predefined variable $node to refer to current node. You can also use null as node if trusted nodes check is disabled (see [[SG:Security Issues|Security Issues]] for more information).
|-
| ''attributeName'' || Custom attribute name.
|}

== Return Value ==

'''null'''

== Examples ==

<syntaxhighlight lang="c">
DeleteCustomAttribute($node, "my_attribute");
</syntaxhighlight>

NXSL:DeleteCustomAttribute

2017-12-21T16:18:46Z

Tomas Kirnak:

__NOTOC__
Delete objects custom attribute.

'''Since:''' 1.2.17

== Syntax ==
DeleteCustomAttribute(''object'', ''attributeName'')

== Parameters ==
{| class="wikitable"
|-
| ''object'' || [[NXSL_Class_Reference|object]] any object of NetObj class, or it's sub-classes
You can use predefined variable $node to refer to current node. You can also use null as node if trusted nodes check is disabled (see [[SG:Security Issues|Security Issues]] for more information).
|-
| ''attributeName'' || Custom attribute name.
|}

== Return Value ==

'''null'''

== Examples ==

<syntaxhighlight lang="c">
DeleteCustomAttribute($node, "my_attribute");
</syntaxhighlight>

NXSL:DeleteCustomAttribute

2017-12-21T16:17:42Z

Tomas Kirnak:

__NOTOC__
Delete objects custom attribute.

'''Since:''' 1.2.17

== Syntax ==
DeleteCustomAttribute(''object'', ''attributeName'')

== Parameters ==
{| class="wikitable"
|-
| ''object'' || [[NXSL_Class_Reference|object]] any object of NetObj class, or it's sub-classes
you can use predefined variable $node to refer to current node. You can also use null as node if trusted nodes check is disabled (see [[SG:Security Issues|Security Issues]] for more information).
|-
| ''attributeName'' || Custom attribute name.
|}

== Return Value ==

'''null'''

== Examples ==

<syntaxhighlight lang="c">
DeleteCustomAttribute($node, "my_attribute");
</syntaxhighlight>

Script Example: Setting node geolocation from SNMP

2017-09-22T13:09:28Z

Tomas Kirnak: Created page with "Adjust the OIDs in ''SNMPGetValue'' as required. <syntaxhighlight lang="c"> transport = CreateSNMPTransport($node); if (transport == null) { return null; } lat = SNMPGetVa..."

Adjust the OIDs in ''SNMPGetValue'' as required.

<syntaxhighlight lang="c">
transport = CreateSNMPTransport($node);
if (transport == null) {
return null;
}

lat = SNMPGetValue(transport, ".1.2.3.4.1");
long = SNMPGetValue(transport, ".1.2.3.4.2");

if (lat == null || long == null) {
return null;
}

geoLoc = GeoLocation(lat, long);
$node->setGeoLocation(geoLoc);

return 0;
</syntaxhighlight>

SG:Script Examples

2017-09-22T13:06:53Z

Tomas Kirnak: Added geolocation from SNMP example

[[Script Example: Additional Information About Connected Node|Additional Information About Connected Node]]

[[Script Example: Enumerate All Nodes|Enumerate All Nodes]]

[[Script Example: Enumerate All Custom Attributes for Node|Enumerate All Custom Attributes for Node]]

[[Script Example: Aggregation of DCI values and applying the 95% percentile average|Aggregation of DCI values and applying the 95% percentile average]]

[[Script Example: Read SNMP Value From Node|Read SNMP Value From Node]]

[[Script Example: Read Table From Agent|Read Table From Agent]]

[[Script Example: Recursively Collect Values from Custom Attributes|Recursively Collect Values from Custom Attributes]]

[[Script Example: Setting node geolocation from SNMP|Setting node geolocation from SNMP]]

[[Category:Scripting Guide]]

NXSL Function Reference

2017-06-28T12:18:43Z

Tomas Kirnak: Added mktime

NXSL Function Reference

2017-06-28T12:13:56Z

Tomas Kirnak: Remove old list of functions

NXSL:Table

2017-04-21T14:20:26Z

Tomas Kirnak: Formatting fix

Represents table object (usually table DCI value).

'''Class Name'''

Table

'''Methods'''

[[NXSL:Table:addColumn|addColumn]]

[[NXSL:Table:addRow|addRow]]

[[NXSL:Table:deleteColumn|deleteColumn]]

[[NXSL:Table:deleteRow|deleteRow]]

[[NXSL:Table:get|get]]

[[NXSL:Table:getColumnIndex|getColumnIndex]]

[[NXSL:Table:getColumnName|getColumnName]]

[[NXSL:Table:set|set]]

'''Attributes'''

{| class="wikitable"
|-
! Name !! Type !! Description
|-
| columnCount || int32 || Number of columns
|-
| columns || array || Column definitions as array of [[NXSL:TableColumn|TableColumn]] objects
|-
| rowCount || int32 || Number of rows
|-
| rows || array || Row definitions as array of [[NXSL:TableRow|TableRow]] objects
|-
| title || string || Table's title
|}

[[Category:NXSL Class Reference]]

NXSL:Table

2017-04-21T14:19:57Z

Tomas Kirnak: Added rows attribute

Represents table object (usually table DCI value).

'''Class Name'''

Table

'''Methods'''

[[NXSL:Table:addColumn|addColumn]]

[[NXSL:Table:addRow|addRow]]

[[NXSL:Table:deleteColumn|deleteColumn]]

[[NXSL:Table:deleteRow|deleteRow]]

[[NXSL:Table:get|get]]

[[NXSL:Table:getColumnIndex|getColumnIndex]]

[[NXSL:Table:getColumnName|getColumnName]]

[[NXSL:Table:set|set]]

'''Attributes'''

{| class="wikitable"
|-
! Name !! Type !! Description
|-
| columnCount || int32 || Number of columns
|-
| columns || array || Column definitions as array of [[NXSL:TableColumn|TableColumn]] objects
|-
| rowCount || int32 || Number of rows
|-
| rows || array || Row definitions as array of [[NXSL:TableRow|TableRow]] objects
| -
| title || string || Table's title
|}

[[Category:NXSL Class Reference]]

Subagent:Ping

2017-03-16T21:26:08Z

Tomas Kirnak: Fixed target list name

{{DISPLAYTITLE:Ping Subagent}}
This subagent can be used to measure ICMP ping response times from one location to another.

= Provided Parameters =

When loaded, PING subagent adds the following parameters to agent:

{| class="wikitable" style="width: 70%"
|-
! Parameter !! Description
|-
| Icmp.AvgPingTime(''target'') || Average ICMP ping response time from ''target'' for last minute. Argument ''target'' can be either IP address or name specified in Target configuration record (see below).
|-
| Icmp.LastPingTime(''target'') || Last ICMP ping response time from ''target''. Argument ''target'' can be either IP address or name specified in Target configuration record (see below).
|-
| Icmp.PacketLoss(''target'') || ICMP ping packet loss (in percents) for ''target''. Argument ''target'' can be either IP address or name specified in Target configuration record (see below).
|-
| Icmp.Ping(''target'',''timeout'',''psize'') || ICMP ping response time from ''target''. Agent will send echo request as soon as it receives request for paramter's value, and will return response time for that particular request. Argument ''target'' should be an IP address. Optional argument ''timeout'' specifies timeout in milliseconds. Default timeout is 1 second. Optional argument ''psize'' specifies packet size in bytes, including IP header. If this argument is omited, value from DefaultPacketSize configuration parameter will be used.
Please note that other parameters just returns result of background ping process, while this parameter waits for actual ping completion and then returns the result. Because of this behavior, it is not recommended to use '''Icmp.Ping''' parameter for instant monitoring, only for occasional tests. For instant monitoring, you should configure targets for background ping and use '''Icmp.AvgPingTime''' or '''Icmp.LastPingTime''' parameters to retrieve results.
|-
| Icmp.PingStdDev(''target'') || [http://en.wikipedia.org/wiki/Standard_deviation Standard deviation] of ICMP ping response time for ''target''. Argument ''target'' can be either IP address or name specified in Target configuration record (see below).
|}

= Provided Lists =

{| class="wikitable"
|-
! List !! Description
|-
| Icmp.Targets || List of configured ping targets. Each line has the following fields, separated by spaces:
* IP address
* Last response time (milliseconds)
* Average response time (milliseconds)
* Packet loss (percents)
* Configured packet size
* Name
|}

= Configuration file =

All configuration parameters related to PING subagent should be placed into '''*PING''' section of agent's configuration file. The following configuration parameters are supported:

{| class="wikitable"
|-
! Parameter !! Format !! Description !! Default value
|-
| DefaultPacketSize || ''bytes'' || Set default packet size to ''bytes''. || 46
|-
| PacketRate || ''packets'' || Set ping packet rate per minute. Allowed values are from 1 to 60 and values below or above will be adjusted automatically. || 4
|-
| Target || ''ip'':''name'':''psize'' || Add target with IP address ''ip'' to background ping target list and assign an optional name ''name'' to it. Target will be pinged using packets of ''psize'' bytes size. Name and packet size fields are optional and can be omited. This parameter can be given multiple times to add multiple targets. || ''none''
|-
| Timeout || ''milliseconds'' || Set response timeout to ''milliseconds''. Allowed values are from 500 to 5000 and values below or above will be adjusted automatically. || 3000
|}

== Configuration Example ==

<syntaxhighlight lang="ini">
# This sample nxagentd.conf instructs agent to:
# 1. load PING subagent
# 2. Ping target 10.0.0.1 with default size (46 bytes) packets and 10.0.0.2 with 1000 bytes packets
# 3. Timeout for ping set to 1 second and pings are sent 12 times per minute (each 5 seconds)

MasterServers = netxms.demo
SubAgent = ping.nsm

*PING
Timeout = 1000
PacketRate = 12
Target = 10.0.0.1:target_1
Target = 10.0.0.2:target_2:1000

</syntaxhighlight>

= Notes =

PING subagent uses value of 10000 to indicate timed out requests.

NXSL Function Reference

2017-01-22T09:37:45Z

Tomas Kirnak: Added GetAllNodes

= Function tables =
{| {border="1" cellpadding="4" cellspacing="2" style="border:\#c9c9c9 1px solid; margin: 1em 1em 1em 0; border-collapse: collapse;"}
| align="center" style="background:#f0f0f0;"|'''Generic'''
| align="center" style="background:#f0f0f0;"|'''Math'''
| align="center" style="background:#f0f0f0;"|'''String-related'''
| align="center" style="background:#f0f0f0;"|'''Data Collection'''
| align="center" style="background:#f0f0f0;"|'''Object search'''
| align="center" style="background:#f0f0f0;"|'''Object management'''
| align="center" style="background:#f0f0f0;"|'''Network'''
|-
| [[NXSL:classof|classof]]||[[NXSL:abs|abs]]||[[NXSL:ArrayToString|ArrayToString]]||[[NXSL:CreateDCI|CreateDCI]]||[[NXSL:FindNodeObject|FindNodeObject]]||[[NXSL:BindObject|BindObject]]||[[NXSL:AddrInRange|AddrInRange]]
|-
| [[NXSL:d2x|d2x]]||[[NXSL:ceil|ceil]]||[[NXSL:chr|chr]]||[[NXSL:FindAllDCIs|FindAllDCIs]]||[[NXSL:FindObject|FindObject]]||[[NXSL:CreateContainer|CreateContainer]]||[[NXSL:AddrInSubnet|AddrInSubnet]]
|-
| [[NXSL:exit|exit]]||[[NXSL:exp|exp]]||[[NXSL:format|format]]||[[NXSL:FindDCIByDescription|FindDCIByDescription]]||[[NXSL:GetInterfaceName|GetInterfaceName]]||[[NXSL:CreateNode|CreateNode]]||[[NXSL:gethostbyaddr|gethostbyaddr]]
|-
| [[NXSL:GeoLocation|GeoLocation]]||[[NXSL:floor|floor]]||[[NXSL:index|index]]||[[NXSL:FindDCIByName|FindDCIByName]]||[[NXSL:GetInterfaceObject|GetInterfaceObject]]||[[NXSL:DeleteCustomAttribute|DeleteCustomAttribute]]||[[NXSL:gethostbyname|gethostbyname]]
|-
| [[NXSL:GetConfigurationVariable|GetConfigurationVariable]]||[[NXSL:log|log]]||[[NXSL:left|left]]||[[NXSL:GetAvgDCIValue|GetAvgDCIValue]]||[[NXSL:GetNodeInterfaces|GetNodeInterfaces]]||[[NXSL:DeleteObject|DeleteObject]]||
|-
| [[NXSL:inList|inList]]||[[NXSL:log10|log10]]||[[NXSL:length|length]]||[[NXSL:GetDCIObject|GetDCIObject]]||[[NXSL:GetNodeParents|GetNodeParents]]||[[NXSL:GetCustomAttribute|GetCustomAttribute]]||
|-
| [[NXSL:map|map]]||[[NXSL:pow|pow]]||[[NXSL:lower|lower]]||[[NXSL:GetDCIRawValue|GetDCIRawValue]]||[[NXSL:GetNodeTemplates|GetNodeTemplates]]||[[NXSL:ManageObject|ManageObject]]||
|-
| [[NXSL:mapList|mapList]]||[[NXSL:round|round]]||[[NXSL:ltrim|ltrim]]||[[NXSL:GetDCIValue|GetDCIValue]]||[[NXSL:GetObjectChildren|GetObjectChildren]]||[[NXSL:RenameObject|RenameObject]]||
|-
| [[NXSL:max|max]]||||[[NXSL:ord|ord]]||[[NXSL:GetDCIValues|GetDCIValues]]||[[NXSL:GetObjectParents|GetObjectParents]]||[[NXSL:SetCustomAttribute|SetCustomAttribute]]||
|-
| [[NXSL:min|min]]||||[[NXSL:right|right]]||[[NXSL:GetDCIValueByDescription|GetDCIValueByDescription]]||[[NXSL:GetAllNodes|GetAllNodes]]||[[NXSL:SetInterfaceExpectedState|SetInterfaceExpectedState]]||
|-
| [[NXSL:random|random]]||||[[NXSL:rindex|rindex]]||[[NXSL:GetDCIValueByName|GetDCIValueByName]]||||[[NXSL:UnbindObject|UnbindObject]]||
|-
| [[NXSL:sleep|sleep]]||||[[NXSL:rtrim|rtrim]]||[[NXSL:GetMaxDCIValue|GetMaxDCIValue]]||||[[NXSL:UnmanageObject|UnmanageObject]]||
|-
| [[NXSL:trace|trace]]||||[[NXSL:SplitString|SplitString]]||[[NXSL:GetMinDCIValue|GetMinDCIValue]]||||||
|-
| [[NXSL:typeof|typeof]]||||[[NXSL:substr|substr]]||[[NXSL:GetSumDCIValue|GetSumDCIValue]]||||||
|-
| [[NXSL:x2d|x2d]]||||[[NXSL:trim|trim]]||[[NXSL:PushDCIData|PushDCIData]]||||||
|-
| ||||[[NXSL:upper|upper]]||||||||
|-
|
|}
<hr>

{| {border="1" cellpadding="4" cellspacing="2" style="border:\#c9c9c9 1px solid; margin: 1em 1em 1em 0; border-collapse: collapse;"}
| align="center" style="background:#f0f0f0;"|'''Time-related'''
| align="center" style="background:#f0f0f0;"|'''Cryptography'''
| align="center" style="background:#f0f0f0;"|'''SNMP'''
| align="center" style="background:#f0f0f0;"|'''Agent'''
| align="center" style="background:#f0f0f0;"|'''Event Processing'''
| align="center" style="background:#f0f0f0;"|'''Situations'''
|-
| [[NXSL:gmtime|gmtime]]||[[NXSL:md5|md5]]||[[NXSL:CreateSNMPTransport|CreateSNMPTransport]]||[[NXSL:AgentReadList|AgentReadList]]||[[NXSL:FindAlarmById|FindAlarmById]]||[[NXSL:FindSituation|FindSituation]]
|-
| [[NXSL:localtime|localtime]]||[[NXSL:sha1|sha1]]||[[NXSL:SNMPGet|SNMPGet]]||[[NXSL:AgentReadParameter|AgentReadParameter]]||[[NXSL:FindAlarmByKey|FindAlarmByKey]]||[[NXSL:GetSituationAttribute|GetSituationAttribute]]
|-
| [[NXSL:SecondsToUptime|SecondsToUptime]]||[[NXSL:sha256|sha256]]||[[NXSL:SNMPGetValue|SNMPGetValue]]||[[NXSL:AgentReadTable|AgentReadTable]]||[[NXSL:GetEventParameter|GetEventParameter]]||
|-
| [[NXSL:strftime|strftime]]||||[[NXSL:SNMPSet|SNMPSet]]||||[[NXSL:PostEvent|PostEvent]]||
|-
| [[NXSL:time|time]]||||[[NXSL:SNMPWalk|SNMPWalk]]||||[[NXSL:SetEventParameter|SetEventParameter]]||
|-
|
|}

<hr>

Below is the old function organization.

= Generic Functions =

[[NXSL:abs|abs]]

[[NXSL:AddrInRange|AddrInRange]]

[[NXSL:AddrInSubnet|AddrInSubnet]]

[[NXSL:ArrayToString|ArrayToString]]

[[NXSL:ceil|ceil]]

[[NXSL:chr|chr]]

[[NXSL:classof|classof]]

[[NXSL:d2x|d2x]]

[[NXSL:exit|exit]]

[[NXSL:exp|exp]]

[[NXSL:floor|floor]]

[[NXSL:format|format]]

[[NXSL:GeoLocation|GeoLocation]]

[[NXSL:gethostbyaddr|gethostbyaddr]]

[[NXSL:gethostbyname|gethostbyname]]

[[NXSL:gmtime|gmtime]]

[[NXSL:index|index]]

[[NXSL:inList|inList]]

[[NXSL:left|left]]

[[NXSL:length|length]]

[[NXSL:localtime|localtime]]

[[NXSL:log|log]]

[[NXSL:log10|log10]]

[[NXSL:lower|lower]]

[[NXSL:ltrim|ltrim]]

[[NXSL:map|map]]

[[NXSL:mapList|mapList]]

[[NXSL:max|max]]

[[NXSL:min|min]]

[[NXSL:md5|md5]]

[[NXSL:ord|ord]]

[[NXSL:pow|pow]]

[[NXSL:random|random]]

[[NXSL:right|right]]

[[NXSL:rindex|rindex]]

[[NXSL:round|round]]

[[NXSL:rtrim|rtrim]]

[[NXSL:sleep|sleep]]

[[NXSL:SecondsToUptime|SecondsToUptime]]

[[NXSL:sha1|sha1]]

[[NXSL:sha256|sha256]]

[[NXSL:SplitString|SplitString]]

[[NXSL:strftime|strftime]]

[[NXSL:substr|substr]]

[[NXSL:time|time]]

[[NXSL:trace|trace]]

[[NXSL:trim|trim]]

[[NXSL:typeof|typeof]]

[[NXSL:upper|upper]]

[[NXSL:x2d|x2d]]

= Data Collection =

[[NXSL:CreateDCI|CreateDCI]]

[[NXSL:FindAllDCIs|FindAllDCIs]]

[[NXSL:FindDCIByDescription|FindDCIByDescription]]

[[NXSL:FindDCIByName|FindDCIByName]]

[[NXSL:GetAvgDCIValue|GetAvgDCIValue]]

[[NXSL:GetDCIObject|GetDCIObject]]

[[NXSL:GetDCIRawValue|GetDCIRawValue]]

[[NXSL:GetDCIValue|GetDCIValue]]

[[NXSL:GetDCIValues|GetDCIValues]]

[[NXSL:GetDCIValueByDescription|GetDCIValueByDescription]]

[[NXSL:GetDCIValueByName|GetDCIValueByName]]

[[NXSL:GetMaxDCIValue|GetMaxDCIValue]]

[[NXSL:GetMinDCIValue|GetMinDCIValue]]

[[NXSL:GetSumDCIValue|GetSumDCIValue]]

[[NXSL:PushDCIData|PushDCIData]]

= Event Processing =

[[NXSL:FindAlarmById|FindAlarmById]]

[[NXSL:FindAlarmByKey|FindAlarmByKey]]

[[NXSL:GetEventParameter|GetEventParameter]]

[[NXSL:PostEvent|PostEvent]]

[[NXSL:SetEventParameter|SetEventParameter]]

= Object Management =

[[NXSL:BindObject|BindObject]]

[[NXSL:CreateContainer|CreateContainer]]

[[NXSL:CreateNode|CreateNode]]

[[NXSL:DeleteCustomAttribute|DeleteCustomAttribute]]

[[NXSL:DeleteObject|DeleteObject]]

[[NXSL:FindNodeObject|FindNodeObject]]

[[NXSL:FindObject|FindObject]]

[[NXSL:GetCustomAttribute|GetCustomAttribute]]

[[NXSL:GetInterfaceName|GetInterfaceName]]

[[NXSL:GetInterfaceObject|GetInterfaceObject]]

[[NXSL:GetNodeInterfaces|GetNodeInterfaces]]

[[NXSL:GetNodeParents|GetNodeParents]]

[[NXSL:GetNodeTemplates|GetNodeTemplates]]

[[NXSL:GetObjectChildren|GetObjectChildren]]

[[NXSL:GetObjectParents|GetObjectParents]]

[[NXSL:ManageObject|ManageObject]]

[[NXSL:RenameObject|RenameObject]]

[[NXSL:SetCustomAttribute|SetCustomAttribute]]

[[NXSL:SetInterfaceExpectedState|SetInterfaceExpectedState]]

[[NXSL:UnbindObject|UnbindObject]]

[[NXSL:UnmanageObject|UnmanageObject]]

= Server Configuration =

[[NXSL:GetConfigurationVariable|GetConfigurationVariable]]

= Situations =

[[NXSL:FindSituation|FindSituation]]

[[NXSL:GetSituationAttribute|GetSituationAttribute]]

= Agent Access =

[[NXSL:AgentReadList|AgentReadList]]

[[NXSL:AgentReadParameter|AgentReadParameter]]

[[NXSL:AgentReadTable|AgentReadTable]]

= SNMP =

[[NXSL:CreateSNMPTransport|CreateSNMPTransport]]

[[NXSL:SNMPGet|SNMPGet]]

[[NXSL:SNMPGetValue|SNMPGetValue]]

[[NXSL:SNMPSet|SNMPSet]]

[[NXSL:SNMPWalk|SNMPWalk]]

[[Category:Scripting Guide]]

Slack.com integration

2016-08-19T12:07:28Z

Tomas Kirnak: Added Slack integration guide

==Configuration==
1) Create an "Incoming webhook" integration in Slack 
You can do this in "Team > Apps and Integrations > Manage > Custom Integrations > Incoming WebHooks" 
This will give you WebHook URL you will need in NetXMS.

2) In NetXMS, go to "Server Configuration" 
Filter for "sms". You should find "SMSDriver" and "SMSDrvConfig" server configuration variables. 

3) Configure "SMSDriver" with the path to the slack driver 
If running from Debian packages, the path will be "/usr/lib/x86_64-linux-gnu/netxms/smsdrv/slack.sms" or similiar. 
If you compiled manually, the path will be as per your ./configure settings. (example "/usr/local/lib/libnxsms_slack.so")

4) Configure "SMSDrvConfig" with Slack configuration 
This configuration needs to provide "username" and "url" 
"username" is optional, if configured, NetXMS will post with this username into your Slack. If not configured, configuration from the WebHook settings is used. 
"url" is the URL of your WebHook. 
Final configuration string should look like this: "username=user;url=http://url.slack.com"

5) Create an Action to send Slack messages 
"Configuration > Action Configuration > New action...", type "Send SMS to mobile phone", "Phone number" is the Slack #channel or @user where the message should be delivered. 
"Message text" is your NetXMS message, configured the same way as other actions.

6) Modify EPP to use your new action 
You should now see Slack messages posted to your configured destination, when the EPP action takes place.

==Debugging==
Set debug level to 4 ("debug 4" into Server Console). 
You can now look for interesting debug messages in the logs: 
''tail -f /var/log/netxmsd | egrep "[Ss]lack|sms|SMS"''

Step by step service monitoring

2016-07-05T15:24:15Z

Tomas Kirnak: Added a note regarding security issues and "CheckTrustedNodes"

Before this tutorial, please make sure there are no security issues with trusted nodes. 
https://wiki.netxms.org/wiki/SG:Security_Issues

Fast solution: 
Set "CheckTrustedNodes" to 0 in Server Configuration, and restart the server

-----
First we check if the website answers to ping. 
This is because when we add the website as a node into NetXMS, NetXMS uses ping to check basic node availability during status polls.

[[File:Website-monitoring-tutorial-1.PNG]]

In our case, netxms.org does not respond to ping. 
We need to remember that for later.

-----
Next we create a node for our website. 
We make sure to disable usage of not-supported sources for polling (including ping, since netxms.org doesnt respond to ping).

[[File:Website-monitoring-tutorial-2.PNG]]

-----
We should see our node properly created with "Unknown" status. 

Special note: in NetXMS 2.0.4 and older, there was a bug that would create a node down alarm. 
Please terminate this alarm on this node before proceeding further in the tutorial if running a version older than 2.0.5 (or 2.1).

[[File:Website-monitoring-tutorial-3.PNG]]

This is because we disabled all polling sources, so NetXMS doesnt have any way to check if a node is up or down. 
We will fix this later on in the tutorial.

Please note that if the node responded to ping (and therefor we would NOT disable usage of ICMP for status polling), the node's status would be Normal.

-----
I have created a template to put all my website monitoring into. 
This will be useful if I want to monitor many websites, since I dont have to manually create monitoring DCIs for every one.

[[File:Website-monitoring-tutorial-4.png]]

We then go into the Data collection configuration of this template.

-----
We create a new DCI. Make sure Origin is set to NetXMS Agent, press Select, and find ServiceResponseTime.Custom(*).

[[File:Website-monitoring-tutorial-5.PNG]]

-----
Next we will set the template DCI to resolve the node's primary IP for each node that is assigned to this template. 
Documentation for template macros here: https://wiki.netxms.org/wiki/UM:Data_Collection#Macros_in_template_items

[[File:Website-monitoring-tutorial-6.PNG]]

We also set the Source node to our NetXMS server. 
This will mean that even tho this DCI is configured on the website's node, the NetXMS server should be used to collect the data for this DCI. 
Final effect will be that the DCI itself will show up on our website's node, but the data will be polled by the NetXMS server, which is what we want in this case.

-----
We can now apply our template to our website's node.

[[File:Website-monitoring-tutorial-7.png]]

-----
We should now see our website's node applied to the template, and in the node's Last values, we should see the response time of the website. 
I have also added a ping DCI, to see that the website does indeed not respond to ping.

[[File:Website-monitoring-tutorial-8.PNG]]

We now just need to fix status calculation for the node.

If the node does respond to ping (as mentioned previously), we are finished.

-----
Please note that as mentioned previously, if the nodes does respond to ping (and therefore node status calculation from its Status poll based on ICMP works fine), the following steps are NOT required.

We will create another DCI, this one will be used to check just if the website is up or down. 

[[File:Website-monitoring-tutorial-9.PNG]]

Now we need to configure it to return NetXMS status codes for this node. We can do this using a transformation script. 
Status codes documented here: https://wiki.netxms.org/wiki/NXSL:NetObj (see Possible values for "status" attribute section)

[[File:Website-monitoring-tutorial-10.PNG]]

Now we just tell NetXMS to use this DCI for status calculation.

[[File:Website-monitoring-tutorial-11.PNG]]

-----
After the next status poll (br default every 1 minute), node should have Normal status. 
Node should also be correctly taken to Critical status when TCP 80 doesnt respond.

[[File:Website-monitoring-tutorial-12.PNG]]

Step by step service monitoring

2016-07-04T13:22:01Z

Tomas Kirnak: More info on ICMP capable nodes

-----
First we check if the website answers to ping. 
This is because when we add the website as a node into NetXMS, NetXMS uses ping to check basic node availability during status polls.

[[File:Website-monitoring-tutorial-1.PNG]]

In our case, netxms.org does not respond to ping. 
We need to remember that for later.

-----
Next we create a node for our website. 
We make sure to disable usage of not-supported sources for polling (including ping, since netxms.org doesnt respond to ping).

[[File:Website-monitoring-tutorial-2.PNG]]

-----
We should see our node properly created with "Unknown" status. 

Special note: in NetXMS 2.0.4 and older, there was a bug that would create a node down alarm. 
Please terminate this alarm on this node before proceeding further in the tutorial if running a version older than 2.0.5 (or 2.1).

[[File:Website-monitoring-tutorial-3.PNG]]

This is because we disabled all polling sources, so NetXMS doesnt have any way to check if a node is up or down. 
We will fix this later on in the tutorial.

Please note that if the node responded to ping (and therefor we would NOT disable usage of ICMP for status polling), the node's status would be Normal.

-----
I have created a template to put all my website monitoring into. 
This will be useful if I want to monitor many websites, since I dont have to manually create monitoring DCIs for every one.

[[File:Website-monitoring-tutorial-4.png]]

We then go into the Data collection configuration of this template.

-----
We create a new DCI. Make sure Origin is set to NetXMS Agent, press Select, and find ServiceResponseTime.Custom(*).

[[File:Website-monitoring-tutorial-5.PNG]]

-----
Next we will set the template DCI to resolve the node's primary IP for each node that is assigned to this template. 
Documentation for template macros here: https://wiki.netxms.org/wiki/UM:Data_Collection#Macros_in_template_items

[[File:Website-monitoring-tutorial-6.PNG]]

We also set the Source node to our NetXMS server. 
This will mean that even tho this DCI is configured on the website's node, the NetXMS server should be used to collect the data for this DCI. 
Final effect will be that the DCI itself will show up on our website's node, but the data will be polled by the NetXMS server, which is what we want in this case.

-----
We can now apply our template to our website's node.

[[File:Website-monitoring-tutorial-7.png]]

-----
We should now see our website's node applied to the template, and in the node's Last values, we should see the response time of the website. 
I have also added a ping DCI, to see that the website does indeed not respond to ping.

[[File:Website-monitoring-tutorial-8.PNG]]

We now just need to fix status calculation for the node.

If the node does respond to ping (as mentioned previously), we are finished.

-----
Please note that as mentioned previously, if the nodes does respond to ping (and therefore node status calculation from its Status poll based on ICMP works fine), the following steps are NOT required.

We will create another DCI, this one will be used to check just if the website is up or down. 

[[File:Website-monitoring-tutorial-9.PNG]]

Now we need to configure it to return NetXMS status codes for this node. We can do this using a transformation script. 
Status codes documented here: https://wiki.netxms.org/wiki/NXSL:NetObj (see Possible values for "status" attribute section)

[[File:Website-monitoring-tutorial-10.PNG]]

Now we just tell NetXMS to use this DCI for status calculation.

[[File:Website-monitoring-tutorial-11.PNG]]

-----
After the next status poll (br default every 1 minute), node should have Normal status. 
Node should also be correctly taken to Critical status when TCP 80 doesnt respond.

[[File:Website-monitoring-tutorial-12.PNG]]

Step by step service monitoring

2016-07-04T13:20:21Z

Tomas Kirnak: Added info on nodes that do respond to ICMP

-----
First we check if the website answers to ping. 
This is because when we add the website as a node into NetXMS, NetXMS uses ping to check basic node availability during status polls.

[[File:Website-monitoring-tutorial-1.PNG]]

In our case, netxms.org does not respond to ping. 
We need to remember that for later.

-----
Next we create a node for our website. 
We make sure to disable usage of not-supported sources for polling (including ping, since netxms.org doesnt respond to ping).

[[File:Website-monitoring-tutorial-2.PNG]]

-----
We should see our node properly created with "Unknown" status. 

Special note: in NetXMS 2.0.4 and older, there was a bug that would create a node down alarm. 
Please terminate this alarm on this node before proceeding further in the tutorial if running a version older than 2.0.5 (or 2.1).

[[File:Website-monitoring-tutorial-3.PNG]]

This is because we disabled all polling sources, so NetXMS doesnt have any way to check if a node is up or down. 
We will fix this later on in the tutorial.

Please note that if the node responded to ping (and therefor we would NOT disable usage of ICMP for status polling), the node's status would be Normal.

-----
I have created a template to put all my website monitoring into. 
This will be useful if I want to monitor many websites, since I dont have to manually create monitoring DCIs for every one.

[[File:Website-monitoring-tutorial-4.png]]

We then go into the Data collection configuration of this template.

-----
We create a new DCI. Make sure Origin is set to NetXMS Agent, press Select, and find ServiceResponseTime.Custom(*).

[[File:Website-monitoring-tutorial-5.PNG]]

-----
Next we will set the template DCI to resolve the node's primary IP for each node that is assigned to this template. 
Documentation for template macros here: https://wiki.netxms.org/wiki/UM:Data_Collection#Macros_in_template_items

[[File:Website-monitoring-tutorial-6.PNG]]

We also set the Source node to our NetXMS server. 
This will mean that even tho this DCI is configured on the website's node, the NetXMS server should be used to collect the data for this DCI. 
Final effect will be that the DCI itself will show up on our website's node, but the data will be polled by the NetXMS server, which is what we want in this case.

-----
We can now apply our template to our website's node.

[[File:Website-monitoring-tutorial-7.png]]

-----
We should now see our website's node applied to the template, and in the node's Last values, we should see the response time of the website. 
I have also added a ping DCI, to see that the website does indeed not respond to ping.

[[File:Website-monitoring-tutorial-8.PNG]]

We now just need to fix status calculation for the node.

If the node does respond to ping (as mentioned previously), the following steps are NOT required.

-----
We will create another DCI, this one will be used to check just if the website is up or down. 

[[File:Website-monitoring-tutorial-9.PNG]]

Now we need to configure it to return NetXMS status codes for this node. We can do this using a transformation script. 
Status codes documented here: https://wiki.netxms.org/wiki/NXSL:NetObj (see Possible values for "status" attribute section)

[[File:Website-monitoring-tutorial-10.PNG]]

Now we just tell NetXMS to use this DCI for status calculation.

[[File:Website-monitoring-tutorial-11.PNG]]

-----
After the next status poll (br default every 1 minute), node should have Normal status. 
Node should also be correctly taken to Critical status when TCP 80 doesnt respond.

[[File:Website-monitoring-tutorial-12.PNG]]

Step by step service monitoring

2016-07-04T12:11:43Z

Tomas Kirnak:

-----
First we check if the website answers to ping. 
This is because when we add the website as a node into NetXMS, NetXMS uses ping to check basic node availability during status polls.

[[File:Website-monitoring-tutorial-1.PNG]]

In our case, netxms.org does not respond to ping. 
We need to remember that for later.

-----
Next we create a node for our website. 
We make sure to disable usage of not-supported sources for polling (including ping, since netxms.org doesnt respond to ping).

[[File:Website-monitoring-tutorial-2.PNG]]

-----
We should see our node properly created with "Unknown" status. 

Special note: in NetXMS 2.0.4 and older, there was a bug that would create a node down alarm. 
Please terminate this alarm on this node before proceeding further in the tutorial if running a version older than 2.0.5 (or 2.1).

[[File:Website-monitoring-tutorial-3.PNG]]

This is because we disabled all polling sources, so NetXMS doesnt have any way to check if a node is up or down. 
We will fix this later on in the tutorial.

-----
I have created a template to put all my website monitoring into. 
This will be useful if I want to monitor many websites, since I dont have to manually create monitoring DCIs for every one.

[[File:Website-monitoring-tutorial-4.png]]

We then go into the Data collection configuration of this template.

-----
We create a new DCI. Make sure Origin is set to NetXMS Agent, press Select, and find ServiceResponseTime.Custom(*).

[[File:Website-monitoring-tutorial-5.PNG]]

-----
Next we will set the template DCI to resolve the node's primary IP for each node that is assigned to this template. 
Documentation for template macros here: https://wiki.netxms.org/wiki/UM:Data_Collection#Macros_in_template_items

[[File:Website-monitoring-tutorial-6.PNG]]

We also set the Source node to our NetXMS server. 
This will mean that even tho this DCI is configured on the website's node, the NetXMS server should be used to collect the data for this DCI. 
Final effect will be that the DCI itself will show up on our website's node, but the data will be polled by the NetXMS server, which is what we want in this case.

-----
We can now apply our template to our website's node.

[[File:Website-monitoring-tutorial-7.png]]

-----
We should now see our website's node applied to the template, and in the node's Last values, we should see the response time of the website. 
I have also added a ping DCI, to see that the website does indeed not respond to ping.

[[File:Website-monitoring-tutorial-8.PNG]]

We now just need to fix status calculation for the node.

-----
We will create another DCI, this one will be used to check just if the website is up or down. 

[[File:Website-monitoring-tutorial-9.PNG]]

Now we need to configure it to return NetXMS status codes for this node. We can do this using a transformation script. 
Status codes documented here: https://wiki.netxms.org/wiki/NXSL:NetObj (see Possible values for "status" attribute section)

[[File:Website-monitoring-tutorial-10.PNG]]

Now we just tell NetXMS to use this DCI for status calculation.

[[File:Website-monitoring-tutorial-11.PNG]]

-----
After the next status poll (br default every 1 minute), node should have Normal status. 
Node should also be correctly taken to Critical status when TCP 80 doesnt respond.

[[File:Website-monitoring-tutorial-12.PNG]]

Step by step service monitoring

2016-07-04T12:10:26Z

Tomas Kirnak: Created page with "----- First we check if the website answers to ping. This is because when we add the website as a node into NetXMS, NetXMS uses ping to check basic node availability durin..."

-----
First we check if the website answers to ping. 
This is because when we add the website as a node into NetXMS, NetXMS uses ping to check basic node availability during status polls.

[[File:Website-monitoring-tutorial-1.PNG]]

In our case, netxms.org does not respond to ping. 
We need to remember that for later.

-----
Next we create a node for our website. 
We make sure to disable usage of not-supported sources for polling (including ping, since netxms.org doesnt respond to ping).

[[File:Website-monitoring-tutorial-2.PNG]]

-----
We should see our node properly created with "Unknown" status. 

Special note: in NetXMS 2.0.4 and older, there was a bug that would create a node down alarms. 
Please terminate this alarm before proceeding further in the tutorial if running a version older than 2.0.5 (or 2.1).

[[File:Website-monitoring-tutorial-3.PNG]]

This is because we disabled all polling sources, so NetXMS doesnt have any way to check if a node is up or down. 
We will fix this later on in the tutorial.

-----
I have created a template to put all my website monitoring into. 
This will be useful if I want to monitor many websites, since I dont have to manually create monitoring DCIs for every one.

[[File:Website-monitoring-tutorial-4.png]]

We then go into the Data collection configuration of this template.

-----
We create a new DCI. Make sure Origin is set to NetXMS Agent, press Select, and find ServiceResponseTime.Custom(*).

[[File:Website-monitoring-tutorial-5.PNG]]

-----
Next we will set the template DCI to resolve the node's primary IP for each node that is assigned to this template. 
Documentation for template macros here: https://wiki.netxms.org/wiki/UM:Data_Collection#Macros_in_template_items

[[File:Website-monitoring-tutorial-6.PNG]]

We also set the Source node to our NetXMS server. 
This will mean that even tho this DCI is configured on the website's node, the NetXMS server should be used to collect the data for this DCI. 
Final effect will be that the DCI itself will show up on our website's node, but the data will be polled by the NetXMS server, which is what we want in this case.

-----
We can now apply our template to our website's node.

[[File:Website-monitoring-tutorial-7.png]]

-----
We should now see our website's node applied to the template, and in the node's Last values, we should see the response time of the website. 
I have also added a ping DCI, to see that the website does indeed not respond to ping.

[[File:Website-monitoring-tutorial-8.PNG]]

We now just need to fix status calculation for the node.

-----
We will create another DCI, this one will be used to check just if the website is up or down. 

[[File:Website-monitoring-tutorial-9.PNG]]

Now we need to configure it to return NetXMS status codes for this node. We can do this using a transformation script. 
Status codes documented here: https://wiki.netxms.org/wiki/NXSL:NetObj (see Possible values for "status" attribute section)

[[File:Website-monitoring-tutorial-10.PNG]]

Now we just tell NetXMS to use this DCI for status calculation.

[[File:Website-monitoring-tutorial-11.PNG]]

-----
After the next status poll (br default every 1 minute), node should have Normal status. 
Node should also be correctly taken to Critical status when TCP 80 doesnt respond.

[[File:Website-monitoring-tutorial-12.PNG]]

File:Website-monitoring-tutorial-8.PNG

2016-07-04T12:09:30Z

Tomas Kirnak: Tomas Kirnak uploaded a new version of File:Website-monitoring-tutorial-8.PNG

File:Website-monitoring-tutorial-3.PNG

2016-07-04T12:06:47Z

Tomas Kirnak: Tomas Kirnak uploaded a new version of File:Website-monitoring-tutorial-3.PNG

File:Website-monitoring-tutorial-12.PNG

2016-07-04T12:04:29Z

Tomas Kirnak:

File:Website-monitoring-tutorial-11.PNG

2016-07-04T11:41:17Z

Tomas Kirnak:

File:Website-monitoring-tutorial-10.PNG

2016-07-04T11:38:08Z

Tomas Kirnak:

File:Website-monitoring-tutorial-9.PNG

2016-07-04T11:35:32Z

Tomas Kirnak:

File:Website-monitoring-tutorial-8.PNG

2016-07-04T11:33:32Z

Tomas Kirnak:

File:Website-monitoring-tutorial-7.png

2016-07-04T11:32:42Z

Tomas Kirnak:

File:Website-monitoring-tutorial-6.PNG

2016-07-04T11:27:54Z

Tomas Kirnak:

File:Website-monitoring-tutorial-5.PNG

2016-07-04T11:24:37Z

Tomas Kirnak:

File:Website-monitoring-tutorial-4.png

2016-07-04T11:22:50Z

Tomas Kirnak:

File:Website-monitoring-tutorial-3.PNG

2016-07-04T11:21:07Z

Tomas Kirnak:

File:Website-monitoring-tutorial-2.PNG

2016-07-04T11:18:15Z

Tomas Kirnak:

File:Website-monitoring-tutorial-1.PNG

2016-07-04T11:16:03Z

Tomas Kirnak:

Main Page

2016-07-04T09:32:25Z

Tomas Kirnak:

__NOTOC__
= Manuals =

NB! Administrator and operator guides are migrated from Wiki to separate documents: [[http://www.netxms.org/documentation/adminguide Admin Guide - Online]], [[http://www.netxms.org/documentation/netxms-admin.pdf Admin Guide - PDF]], [[http://www.netxms.org/documentation/userguide Operator Guide - Online]], [[http://www.netxms.org/documentation/netxms-user.pdf Operator Guide - PDF]].

To contribute, please contact us at team@netxms.org for write access to documentation repository.

[[Installation Guide]]

[[User Manual]]

[[Scripting Guide]]

[[System Reference]]

[[Using APT Repository|APT Repository for Debian/Ubuntu]]

= Tutorials =

[[NetXMS Video Tutorial Series]]

[[How to send e-mail notification when disk space is low]]

[[Using nxshell to automate bulk operations]]

[[NetXMS as a cluster (high-availability) application]]

[[Creating a Dashboard]]

[[Creating SNMP table DCI]]

[[OS process monitoring using SNMP]]

[[Step by step service monitoring]]

= Miscellaneous Documents =

This section contains useful documents which should be part of User Manual, but not integrated there yet.

[[OS X Java issues]]

[[ExternalParametersProvider|External Parameters Provider]]

[[Autologin for Management Console]]

[[Unsorted Features List]]

[[Windows Performance Counters]]

[[How to Install Agent on ZeroShell]]

[[Enable SNMP for devices without standard system MIB]]

[[Add new MIBs]]

[[How to Encrypt Database Passwords]]

[[Running NetXMS under debugger]]

[[Details about database connection]]

[[How to migrate to another database]]

[[How to enable ICMP ping for NetXMS server running under non-root account]]

[[How to fix console crash on Linux]]

= Solutions =

[[Uninterruptible Power Supply (UPS) Monitoring]]

[[UPS Monitoring (APC) via SNMP]]

[[IBM Storwize V7000|IBM Storwize V7000 (and possibly other IBM arrays)]]

[[HP P2000]]

[[Linux monitoring]]

[[MTBF (Mean Time Between Failures) and MTTR (Mean Time To Repair) Calculation]]

[['Backbone' L3 Map - map without end-device subnets]]

[[Ubiquiti and Ligowave wireless monitoring]]

[[Application monitoring]]

[[Mass node import into NetXMS]]

= Integration =
[[NetXMS Integration with HP Operations Manager]]

[[Slack.com integration]]

= Documentation for Developers =
[[Coding Style]]

[[Communication Protocol Reference Guide]]

[[Internal API]]

[[Network Device Drivers]]

[[How to setup Eclipse/RAP]]

[[How to compile report-generator]]

[[Working with UNICODE]]

Mass node import into NetXMS

2016-05-27T23:17:14Z

Tomas Kirnak: Created page with "= NetXMS .csv importer = You can import nodes into NetXMS en-mass using the NetXMS .csv importer. The project is hosted on github: https://github.com/tomaskir/NetXMS-csv-..."

= NetXMS .csv importer =
You can import nodes into NetXMS en-mass using the NetXMS .csv importer.

The project is hosted on github: 
https://github.com/tomaskir/NetXMS-csv-importer

You can simply create a .csv file with all the nodes you want to import into NetXMS, and run the importer. 
For more documentation on the importer, please see the github page.

Main Page

2016-05-27T23:14:14Z

Tomas Kirnak:

__NOTOC__
= Manuals =

NB! Administrator and operator guides are migrated from Wiki to separate documents: [[http://www.netxms.org/documentation/adminguide Admin Guide - Online]], [[http://www.netxms.org/documentation/netxms-admin.pdf Admin Guide - PDF]], [[http://www.netxms.org/documentation/userguide Operator Guide - Online]], [[http://www.netxms.org/documentation/netxms-user.pdf Operator Guide - PDF]].

To contribute, please contact us at team@netxms.org for write access to documentation repository.

[[Installation Guide]]

[[User Manual]]

[[Scripting Guide]]

[[System Reference]]

[[Using APT Repository|APT Repository for Debian/Ubuntu]]

= Tutorials =

[[NetXMS Video Tutorial Series]]

[[How to send e-mail notification when disk space is low]]

[[Using nxshell to automate bulk operations]]

[[NetXMS as a cluster (high-availability) application]]

[[Creating a Dashboard]]

[[Creating SNMP table DCI]]

[[OS process monitoring using SNMP]]

= Miscellaneous Documents =

This section contains useful documents which should be part of User Manual, but not integrated there yet.

[[OS X Java issues]]

[[ExternalParametersProvider|External Parameters Provider]]

[[Autologin for Management Console]]

[[Unsorted Features List]]

[[Windows Performance Counters]]

[[How to Install Agent on ZeroShell]]

[[Enable SNMP for devices without standard system MIB]]

[[Add new MIBs]]

[[How to Encrypt Database Passwords]]

[[Running NetXMS under debugger]]

[[Details about database connection]]

[[How to migrate to another database]]

[[How to enable ICMP ping for NetXMS server running under non-root account]]

[[How to fix console crash on Linux]]

= Solutions =

[[Uninterruptible Power Supply (UPS) Monitoring]]

[[UPS Monitoring (APC) via SNMP]]

[[IBM Storwize V7000|IBM Storwize V7000 (and possibly other IBM arrays)]]

[[HP P2000]]

[[Linux monitoring]]

[[MTBF (Mean Time Between Failures) and MTTR (Mean Time To Repair) Calculation]]

[['Backbone' L3 Map - map without end-device subnets]]

[[Ubiquiti and Ligowave wireless monitoring]]

[[Application monitoring]]

[[Mass node import into NetXMS]]

= Integration =
[[NetXMS Integration with HP Operations Manager]]

[[Slack.com integration]]

= Documentation for Developers =
[[Coding Style]]

[[Communication Protocol Reference Guide]]

[[Internal API]]

[[Network Device Drivers]]

[[How to setup Eclipse/RAP]]

[[How to compile report-generator]]

[[Working with UNICODE]]

NXSL Function Reference

2016-03-22T11:26:55Z

Tomas Kirnak: Added ArrayToString and SplitString to function table

= Function tables =
{| {border="1" cellpadding="4" cellspacing="2" style="border:\#c9c9c9 1px solid; margin: 1em 1em 1em 0; border-collapse: collapse;"}
| align="center" style="background:#f0f0f0;"|'''Generic'''
| align="center" style="background:#f0f0f0;"|'''Math'''
| align="center" style="background:#f0f0f0;"|'''String-related'''
| align="center" style="background:#f0f0f0;"|'''Data Collection'''
| align="center" style="background:#f0f0f0;"|'''Object search'''
| align="center" style="background:#f0f0f0;"|'''Object management'''
| align="center" style="background:#f0f0f0;"|'''Network'''
|-
| [[NXSL:classof|classof]]||[[NXSL:abs|abs]]||[[NXSL:ArrayToString|ArrayToString]]||[[NXSL:CreateDCI|CreateDCI]]||[[NXSL:FindNodeObject|FindNodeObject]]||[[NXSL:BindObject|BindObject]]||[[NXSL:AddrInRange|AddrInRange]]
|-
| [[NXSL:d2x|d2x]]||[[NXSL:ceil|ceil]]||[[NXSL:chr|chr]]||[[NXSL:FindAllDCIs|FindAllDCIs]]||[[NXSL:FindObject|FindObject]]||[[NXSL:CreateContainer|CreateContainer]]||[[NXSL:AddrInSubnet|AddrInSubnet]]
|-
| [[NXSL:exit|exit]]||[[NXSL:exp|exp]]||[[NXSL:format|format]]||[[NXSL:FindDCIByDescription|FindDCIByDescription]]||[[NXSL:GetInterfaceName|GetInterfaceName]]||[[NXSL:CreateNode|CreateNode]]||[[NXSL:gethostbyaddr|gethostbyaddr]]
|-
| [[NXSL:GeoLocation|GeoLocation]]||[[NXSL:floor|floor]]||[[NXSL:index|index]]||[[NXSL:FindDCIByName|FindDCIByName]]||[[NXSL:GetInterfaceObject|GetInterfaceObject]]||[[NXSL:DeleteCustomAttribute|DeleteCustomAttribute]]||[[NXSL:gethostbyname|gethostbyname]]
|-
| [[NXSL:GetConfigurationVariable|GetConfigurationVariable]]||[[NXSL:log|log]]||[[NXSL:left|left]]||[[NXSL:GetAvgDCIValue|GetAvgDCIValue]]||[[NXSL:GetNodeInterfaces|GetNodeInterfaces]]||[[NXSL:DeleteObject|DeleteObject]]||
|-
| [[NXSL:inList|inList]]||[[NXSL:log10|log10]]||[[NXSL:length|length]]||[[NXSL:GetDCIObject|GetDCIObject]]||[[NXSL:GetNodeParents|GetNodeParents]]||[[NXSL:GetCustomAttribute|GetCustomAttribute]]||
|-
| [[NXSL:map|map]]||[[NXSL:pow|pow]]||[[NXSL:lower|lower]]||[[NXSL:GetDCIRawValue|GetDCIRawValue]]||[[NXSL:GetNodeTemplates|GetNodeTemplates]]||[[NXSL:ManageObject|ManageObject]]||
|-
| [[NXSL:mapList|mapList]]||[[NXSL:round|round]]||[[NXSL:ltrim|ltrim]]||[[NXSL:GetDCIValue|GetDCIValue]]||[[NXSL:GetObjectChildren|GetObjectChildren]]||[[NXSL:RenameObject|RenameObject]]||
|-
| [[NXSL:max|max]]||||[[NXSL:ord|ord]]||[[NXSL:GetDCIValues|GetDCIValues]]||[[NXSL:GetObjectParents|GetObjectParents]]||[[NXSL:SetCustomAttribute|SetCustomAttribute]]||
|-
| [[NXSL:min|min]]||||[[NXSL:right|right]]||[[NXSL:GetDCIValueByDescription|GetDCIValueByDescription]]||||[[NXSL:SetInterfaceExpectedState|SetInterfaceExpectedState]]||
|-
| [[NXSL:random|random]]||||[[NXSL:rindex|rindex]]||[[NXSL:GetDCIValueByName|GetDCIValueByName]]||||[[NXSL:UnbindObject|UnbindObject]]||
|-
| [[NXSL:sleep|sleep]]||||[[NXSL:rtrim|rtrim]]||[[NXSL:GetMaxDCIValue|GetMaxDCIValue]]||||[[NXSL:UnmanageObject|UnmanageObject]]||
|-
| [[NXSL:trace|trace]]||||[[NXSL:SplitString|SplitString]]||[[NXSL:GetMinDCIValue|GetMinDCIValue]]||||||
|-
| [[NXSL:typeof|typeof]]||||[[NXSL:substr|substr]]||[[NXSL:GetSumDCIValue|GetSumDCIValue]]||||||
|-
| [[NXSL:x2d|x2d]]||||[[NXSL:trim|trim]]||[[NXSL:PushDCIData|PushDCIData]]||||||
|-
| ||||[[NXSL:upper|upper]]||||||||
|-
|
|}
<hr>

{| {border="1" cellpadding="4" cellspacing="2" style="border:\#c9c9c9 1px solid; margin: 1em 1em 1em 0; border-collapse: collapse;"}
| align="center" style="background:#f0f0f0;"|'''Time-related'''
| align="center" style="background:#f0f0f0;"|'''Cryptography'''
| align="center" style="background:#f0f0f0;"|'''SNMP'''
| align="center" style="background:#f0f0f0;"|'''Agent'''
| align="center" style="background:#f0f0f0;"|'''Event Processing'''
| align="center" style="background:#f0f0f0;"|'''Situations'''
|-
| [[NXSL:gmtime|gmtime]]||[[NXSL:md5|md5]]||[[NXSL:CreateSNMPTransport|CreateSNMPTransport]]||[[NXSL:AgentReadList|AgentReadList]]||[[NXSL:FindAlarmById|FindAlarmById]]||[[NXSL:FindSituation|FindSituation]]
|-
| [[NXSL:localtime|localtime]]||[[NXSL:sha1|sha1]]||[[NXSL:SNMPGet|SNMPGet]]||[[NXSL:AgentReadParameter|AgentReadParameter]]||[[NXSL:FindAlarmByKey|FindAlarmByKey]]||[[NXSL:GetSituationAttribute|GetSituationAttribute]]
|-
| [[NXSL:SecondsToUptime|SecondsToUptime]]||[[NXSL:sha256|sha256]]||[[NXSL:SNMPGetValue|SNMPGetValue]]||[[NXSL:AgentReadTable|AgentReadTable]]||[[NXSL:GetEventParameter|GetEventParameter]]||
|-
| [[NXSL:strftime|strftime]]||||[[NXSL:SNMPSet|SNMPSet]]||||[[NXSL:PostEvent|PostEvent]]||
|-
| [[NXSL:time|time]]||||[[NXSL:SNMPWalk|SNMPWalk]]||||[[NXSL:SetEventParameter|SetEventParameter]]||
|-
|
|}

<hr>

Below is the old function organization.

= Generic Functions =

[[NXSL:abs|abs]]

[[NXSL:AddrInRange|AddrInRange]]

[[NXSL:AddrInSubnet|AddrInSubnet]]

[[NXSL:ArrayToString|ArrayToString]]

[[NXSL:ceil|ceil]]

[[NXSL:chr|chr]]

[[NXSL:classof|classof]]

[[NXSL:d2x|d2x]]

[[NXSL:exit|exit]]

[[NXSL:exp|exp]]

[[NXSL:floor|floor]]

[[NXSL:format|format]]

[[NXSL:GeoLocation|GeoLocation]]

[[NXSL:gethostbyaddr|gethostbyaddr]]

[[NXSL:gethostbyname|gethostbyname]]

[[NXSL:gmtime|gmtime]]

[[NXSL:index|index]]

[[NXSL:inList|inList]]

[[NXSL:left|left]]

[[NXSL:length|length]]

[[NXSL:localtime|localtime]]

[[NXSL:log|log]]

[[NXSL:log10|log10]]

[[NXSL:lower|lower]]

[[NXSL:ltrim|ltrim]]

[[NXSL:map|map]]

[[NXSL:mapList|mapList]]

[[NXSL:max|max]]

[[NXSL:min|min]]

[[NXSL:md5|md5]]

[[NXSL:ord|ord]]

[[NXSL:pow|pow]]

[[NXSL:random|random]]

[[NXSL:right|right]]

[[NXSL:rindex|rindex]]

[[NXSL:round|round]]

[[NXSL:rtrim|rtrim]]

[[NXSL:sleep|sleep]]

[[NXSL:SecondsToUptime|SecondsToUptime]]

[[NXSL:sha1|sha1]]

[[NXSL:sha256|sha256]]

[[NXSL:SplitString|SplitString]]

[[NXSL:strftime|strftime]]

[[NXSL:substr|substr]]

[[NXSL:time|time]]

[[NXSL:trace|trace]]

[[NXSL:trim|trim]]

[[NXSL:typeof|typeof]]

[[NXSL:upper|upper]]

[[NXSL:x2d|x2d]]

= Data Collection =

[[NXSL:CreateDCI|CreateDCI]]

[[NXSL:FindAllDCIs|FindAllDCIs]]

[[NXSL:FindDCIByDescription|FindDCIByDescription]]

[[NXSL:FindDCIByName|FindDCIByName]]

[[NXSL:GetAvgDCIValue|GetAvgDCIValue]]

[[NXSL:GetDCIObject|GetDCIObject]]

[[NXSL:GetDCIRawValue|GetDCIRawValue]]

[[NXSL:GetDCIValue|GetDCIValue]]

[[NXSL:GetDCIValues|GetDCIValues]]

[[NXSL:GetDCIValueByDescription|GetDCIValueByDescription]]

[[NXSL:GetDCIValueByName|GetDCIValueByName]]

[[NXSL:GetMaxDCIValue|GetMaxDCIValue]]

[[NXSL:GetMinDCIValue|GetMinDCIValue]]

[[NXSL:GetSumDCIValue|GetSumDCIValue]]

[[NXSL:PushDCIData|PushDCIData]]

= Event Processing =

[[NXSL:FindAlarmById|FindAlarmById]]

[[NXSL:FindAlarmByKey|FindAlarmByKey]]

[[NXSL:GetEventParameter|GetEventParameter]]

[[NXSL:PostEvent|PostEvent]]

[[NXSL:SetEventParameter|SetEventParameter]]

= Object Management =

[[NXSL:BindObject|BindObject]]

[[NXSL:CreateContainer|CreateContainer]]

[[NXSL:CreateNode|CreateNode]]

[[NXSL:DeleteCustomAttribute|DeleteCustomAttribute]]

[[NXSL:DeleteObject|DeleteObject]]

[[NXSL:FindNodeObject|FindNodeObject]]

[[NXSL:FindObject|FindObject]]

[[NXSL:GetCustomAttribute|GetCustomAttribute]]

[[NXSL:GetInterfaceName|GetInterfaceName]]

[[NXSL:GetInterfaceObject|GetInterfaceObject]]

[[NXSL:GetNodeInterfaces|GetNodeInterfaces]]

[[NXSL:GetNodeParents|GetNodeParents]]

[[NXSL:GetNodeTemplates|GetNodeTemplates]]

[[NXSL:GetObjectChildren|GetObjectChildren]]

[[NXSL:GetObjectParents|GetObjectParents]]

[[NXSL:ManageObject|ManageObject]]

[[NXSL:RenameObject|RenameObject]]

[[NXSL:SetCustomAttribute|SetCustomAttribute]]

[[NXSL:SetInterfaceExpectedState|SetInterfaceExpectedState]]

[[NXSL:UnbindObject|UnbindObject]]

[[NXSL:UnmanageObject|UnmanageObject]]

= Server Configuration =

[[NXSL:GetConfigurationVariable|GetConfigurationVariable]]

= Situations =

[[NXSL:FindSituation|FindSituation]]

[[NXSL:GetSituationAttribute|GetSituationAttribute]]

= Agent Access =

[[NXSL:AgentReadList|AgentReadList]]

[[NXSL:AgentReadParameter|AgentReadParameter]]

[[NXSL:AgentReadTable|AgentReadTable]]

= SNMP =

[[NXSL:CreateSNMPTransport|CreateSNMPTransport]]

[[NXSL:SNMPGet|SNMPGet]]

[[NXSL:SNMPGetValue|SNMPGetValue]]

[[NXSL:SNMPSet|SNMPSet]]

[[NXSL:SNMPWalk|SNMPWalk]]

[[Category:Scripting Guide]]

NXSL:FindObject

2016-01-26T13:33:24Z

Tomas Kirnak: Clarified returned object type behaviour

__NOTOC__
Find NetXMS object by object id or name.

'''Since:''' 1.2.0

== Syntax ==

FindObject(''id'', ''node'');

== Parameters ==

:{|
|-
| ''id'' || ID or name of the object to find.
|-
| ''node'' || Node object, you can use predefined variable $node to refer to current node. You can also use null or omit this parameter if trusted nodes check is disabled (see [[SG:Security Issues|Security Issues]] for more information).
|}

== Return Value ==

Object of NetObj or one of its sub-clases (depending on found object type) with given id or name on success or '''null''' on failure (either because object with given name/id does not exist, or access to it was denied). 
For more info see [[NXSL Class Reference|NXSL Class Reference]].

== Examples ==

FindObject("server.netxms.org", $node) -> object
FindObject(2) -> object
FindObject("bad_object_name", $node) -> NULL

NXSL:Zone

2016-01-25T13:13:28Z

Tomas Kirnak: Specified attributes are inhereted from NetObj and fixed attributes

Represents NetXMS zone object

'''Class Name'''

Zone

'''Attributes'''

Inherits all attributes of the [[NXSL:NetObj|NetObj class]].

{| class="wikitable"
|-
! Name !! Type !! Description
|-
| agentProxy || int32 || Identifier of node object used as agent proxy
|-
| icmpProxy || int32 || Identifier of node object used as ICMP proxy
|-
| snmpProxy || int32 || Identifier of node object used as SNMP proxy
|-
| zoneId || int32 || Zone ID
|}

[[Category:NXSL Class Reference]]

NXSL:Node

2016-01-25T13:10:49Z

Tomas Kirnak: Specified attributes are inhereted from NetObj and fixed attributes

Represents NetXMS node object.

'''Class Name'''

Node

'''Attributes'''

Inherits all attributes of the [[NXSL:NetObj|NetObj class]].

{| class="wikitable"
|-
! Name !! Type !! Description
|-
| agentVersion || string || NetXMS agent's version
|-
| bootTime || int64 || Node boot time or 0 if not known (in seconds since epoch)
|-
| bridgeBaseAddress || string || Bridge base address (will return "000000000000" if not known or node is not a bridge/switch)
|-
| driver || string || Driver name
|-
| [[NXSL:Node:flags | flags]] || uint32 || Node flags (bit mask)
|-
| "is802_1x" or "isPAE" || boolean || TRUE if node supports 802.1x
|-
| isAgent || boolean || TRUE if NetXMS agent detected on node
|-
| isBridge || boolean || TRUE if node is a bridge
|-
| isCDP || boolean || TRUE if node supports CDP (Cisco Discovery Protocol)
|-
| isLLDP || boolean || TRUE if node supports LLDP (Link Layer Discovery Protocol)
|-
| "isLocalMgmt" or "isLocalManagement" || boolean || TRUE if node is a local management server (NetXMS server)
|-
| isPrinter || boolean || TRUE if node is a printer
|-
| isRouter || boolean || TRUE if node is a router (has IP forwarding enabled)
|-
| isSMCLP|| boolean || TRUE if SMCLP agent detected on node
|-
| isSNMP || boolean || TRUE if SNMP agent detected on node
|-
| isSONMP || boolean || TRUE if node supports SONMP/NDP (Synoptics/Nortel Discovery Protocol)
|-
| platformName || string || Platform name reported by NetXMS agent
|-
| [[NXSL:Node:runtimeFlags | runtimeFlags]] || uint32 || Node runtime flags (bit mask)
|-
| snmpOID || string || SNMP object identifier (value of .1.3.6.1.2.1.1.2.0)
|-
| snmpSysContact || string || SNMP system contact (value of .1.3.6.1.2.1.1.4.0)
|-
| snmpSysLocation || string || SNMP system location (value of .1.3.6.1.2.1.1.6.0)
|-
| snmpSysName || string || SNMP system name (value of .1.3.6.1.2.1.1.5.0)
|-
| snmpVersion || int32 || Configured SNMP version (0 for SNMP version 1, 1 for SNMP version 2c, 2 for SNMP version 3)
|-
| sysDescription || string || System description (value of System.Uname for nodes with agents or .1.3.6.1.2.1.1.1.0 for SNMP nodes)
|-
| zone || object ([[NXSL:Zone|Zone]]) || Zone object ('''null''' if zoning is disabled)
|-
| zoneId || int32 || Zone ID (0 if zoning is disabled)
|}

'''Methods'''
{| class="wikitable"
|-
! Name !! Parameters !! Return value !! Description
|-
| [[NXSL:NetObj:clearGeoLocation|clearGeoLocation]] || none || none || Clears GeoLocation data from the node
|-
| [[NXSL:NetObj:setGeoLocation|setGeoLocation]] || Object of [[NXSL:GeoLocation|GeoLocation]] class || none || Sets GeoLocation data for the node
|-
| enableAgent || boolean || none ||Enable or disable usage of NetXMS agent for all polls
|-
| enableConfigurationPolling || boolean || none || Enable or disable configuration polling for a node
|-
| enableIcmp || boolean || none || Enable or disable usage of ICMP pings for status polls
|-
| enableSnmp || boolean || none || Enable or disable usage of SNMP for all polls
|-
| enableStatusPolling || boolean || none || Enable or disable status polling for a node
|-
| enableTopologyPolling || boolean || none || Enable or disable topology polling
|}

Example (disable usage of NetXMS agent for all polls):
$node->enableAgent(false);

[[Category:NXSL Class Reference]]