Node

Bind childObject to the current object as a child.

Bind current object to parentObject as a child.

Calculate node downtime

Clears GeoLocation data from the node

Send a User Support Application notification to the nodes at or below this object. Set startTime and endTime to 0 for an instant notification. See User Support Application Notifications.

Deletes current object.

Delete custom attribute.

Enable maintenance mode for the object.

Expand string by replacing macros with their values.

>>> $node.expandString("%n")
My node name

Schedule forced autobind poll for this object. The poll is executed asynchronously on the poller thread pool; the method returns immediately after scheduling.

Schedule forced configuration poll for this object. The poll is executed asynchronously on the poller thread pool; the method returns immediately after scheduling.

// Re-read node configuration after changing its SNMP settings
$node.setSNMPCommunity("public");
if (!$node.forceConfigurationPoll())
   println("Cannot schedule configuration poll");

Schedule forced network discovery poll for this object. The poll is executed asynchronously on the poller thread pool; the method returns immediately after scheduling.

Schedule forced instance discovery poll for this object. The poll is executed asynchronously on the poller thread pool; the method returns immediately after scheduling.

Schedule forced map update poll for this object. The poll is executed asynchronously on the poller thread pool; the method returns immediately after scheduling.

Schedule forced routing table poll for this object. The poll is executed asynchronously on the poller thread pool; the method returns immediately after scheduling.

Schedule forced status poll for this object. The poll is executed asynchronously on the poller thread pool; the method returns immediately after scheduling.

Schedule forced topology poll for this object. The poll is executed asynchronously on the poller thread pool; the method returns immediately after scheduling.

Returns value of the custom attribute with the provided name.

Returns list of responsible users with specific tag. Full list is acceessible via .responsibleUsers

If provided object is child of this object

If provided object is direct child of this object

If provided object is direct parent of this object

If provided object is parent of this object

Disable maintenance mode for the object.

Sets object to managed state. Has no affect if object already managed. Returns false and does not change the state if the object is a decommissioned node. Since 6.2.6

Read maintenance entries

Rename object.

Set object alias name

Set object category id or name (used to get object display image)

Set object comments

Update or create custom attribute with the given key and value.

$node.setCustomAttribute("location", "Rack 12");
if ($node.getCustomAttribute("location") != "Rack 12")
   println("Cannot set custom attribute");

Sets node geographical location.

Sets object image, that will be used to display object on network map

Sets object’s name, that will be used to display object on network map

Sets object’s postal address. Each argument must be a string or null. A null or empty value clears the corresponding field.

Sets status calculation method.

Sets status propagation method.

Unbind provided object from the current object.

Unbind current object from the provided object.

Set object into unmanaged state. Has no effect if object is already in unmanaged state.

Add entry to maintenance journal

Apply template to this object.

Create a new data collection item on this object.

dci = $node.createDCI("agent", "Agent.Version", "Agent Version", "string");
println(dci.id);

Delete data collection item from this object. DCIs created from a template are managed by that template and cannot be deleted this way.

dci = $node.findDCIByName("Temporary.Metric");
if (dci != null)
   $node.deleteDCI(dci.id);

Enable or disable configuration polling.

Enable or disable data collection polling.

Enable or disable status polling.

Find all DCIs on this object matching the given filters. All parameters are optional; omitted or null parameters are not used for filtering. Name, description, and tag filters support glob patterns (? and *) and are case-insensitive.

// Find all CPU-related DCIs
for (d : $node.findAllDCIs("System.CPU.*"))
   println(d.name .. " = " .. d.cachedValue);

Find a DCI on this object by description (exact case-insensitive match).

Find a DCI on this object by its ID.

Find a DCI on this object by metric name (exact case-insensitive match).

dci = $node.findDCIByName("System.CPU.Usage");
if (dci != null)
   println("CPU Usage: " .. dci.cachedValue);

Find a DCI on this object by user tag (exact case-insensitive match).

Find a DCI on this object by user tag using a case-insensitive glob pattern.

Push a new value to a DCI from script. The DCI must be a single value DCI with origin set to "Push" or "OpenTelemetry (OTLP)".

dci = $node.findDCIByName("My.Push.Metric");
$node.pushDCIData(dci.id, "42");

Reads object internal metric (metric with source "Internal").

Remove template from this object.

Finds web service by name, makes request and returns the WebServiceResponse object.

// Valid example when request fails because there is no connection to agent
result = $node.callWebService("Web service name", "GET", "additional/ult/path");
println(result.success); // "false"
println(result.errorMessage); // "No connection with agent"
println(result.agentErrorCode); // "0"
println(result.httpResponseCode); // "0"
println(result.document); // ""

// Successful post request
result = $node.callWebService("Web service name", "POST", "{ \"id\":10 }", "application/json", "additional/ult/path");
println(result.success); // "true"
println(result.errorMessage); // ""
println(result.agentErrorCode); // "0"
println(result.httpResponseCode); // "200"
println(result.document); // ""

// Get requests
result = $node.callWebService("Web service name", "GET", "additional", "parameters");
result = $node.callWebService("Web service name", "GET", acceptCached: true, "additional", "parameters");

Remove separate SNMP trap credentials set with setSNMPTrapCommunity() or setSNMPTrapUSMCredentials(). After this call, incoming traps are validated against the node’s polling credentials again. Since 6.2.3

Create SNMP transport object of class SNMPTransport with communication settings defined on the node. It is possible to specify a community string but only community strings listed in Network Credentials will be accepted. Creation of SNMP transport is a preparatory operation enabling subsequent sending of SNMP requests to node. However, creation of SNMP transport does not guarantee that the node is accessible.

Enable or disable 802.1x port state checking during status polls.

Enable or disable usage of NetXMS agent for all polls.

Enable or disable discovery polling.

Enable or disable usage of EtherNet/IP for polls.

Enable or disable usage of ICMP pings for status polls.

Enable or disable usage of Modbus TCP for polls.

Enable or disable usage of ICMP ping for primary IP.

Enable or disable routing table polling.

Enable or disable usage of SNMP for all polls.

Enable or disable reading of SM-CLP available properties metadata during configuration poll.

Enable or disable usage of SSH

Enable or disable topology polling.

Enable or disable VNC detection on the node during configuration poll.

Enable or disable reading of Windows performance counters metadata during configuration poll.

Execute agent command (action) on node.

Execute agent command (action) on node and return it’s output.

Execute SSH command on node. The command is executed through the node’s effective SSH proxy using SSH credentials from node properties.

Get array of blocked ports for the specified protocol.

blockedTcpPorts = $node.getBlockedPorts("tcp");
for (port : blockedTcpPorts) {
    println("Blocked TCP port: " .. port);
}

Get array of installed packages on the node.

// Get all packages
packages = $node.getInstalledPackages();

// Get packages matching filter
packages = $node.getInstalledPackages("netxms", false);

Get interface object by index, MAC address or name. If name is number method will assume that it is index.

println($node.getInterface("00:14:22:04:25:37").name); // Will print "wlp4s0"
println($node.getInterface(3).name); // Will print "wlp4s0"
println($node.getInterface("wlp4s0").name); // Will print "wlp4s0"

Get interface object by index.

println($node.getInterfaceByIndex(3).name); // Will print "wlp4s0"

Get interface object by MAC address.

println($node.getInterfaceByMACAddress("00:14:22:04:25:37").name); // Will print "wlp4s0"

Get interface object by name.

println($node.getInterfaceByName("wlp4s0").name); // Will print "wlp4s0"

Get interface name by index.

Retrieve running configuration of the device using its network device driver. Only works if the node’s driver supports configuration backup.

config = $node.getRunningConfig();
if (config != null)
{
   f = IO::OpenFile("/var/backup/" .. $node.name .. ".cfg", "w");
   if (f != null)
   {
      f.write(config);
      f.close();
   }
}

Retrieve startup configuration of the device using its network device driver. Only works if the node’s driver supports configuration backup.

Check if a specific port is blocked for the given protocol.

if ($node.isPortBlocked(22, "tcp")) {
    println("SSH port is blocked");
}

Get web service object by name.

webSvc = $node.getWebService("webSvcName");

Open an interactive SSH session to this node.

session = $node.openSSHSession();
if (session != null && session.connected) {
    output = session.execute("ls -la");
    for (line : output) {
        println(line);
    }
    session.close();
}

Request agent list directly from agent on given node. Returns array of strings or NULL if failed or caller has no agent read access to the node.

Request metric directly from agent on given node. Returns NULL if failed or caller has no agent read access to the node.

Requests agent table directly from agent on given node. Returns Table or NULL if failed or caller has no agent read access to the node.

Request driver-specific metric from network device driver (e.g. Rittal). Returns NULL if failed.

Read internal table

Read list from node using web service

Read from node web service parameter

Set the expected capabilities for this node. Expected capabilities prevent automatic removal of protocol capability flags when a protocol becomes temporarily unreachable. Normally, if a protocol (e.g., SNMP or agent) fails beyond the capability expiration time, its capability flag is cleared. Setting expected capabilities overrides this behavior, keeping the specified capabilities persistent regardless of connectivity status.

Set ifXTable usage mode 0 - use default, 1 - enable, 2 - disable. Any other value is treated as 0.

Set the required number of polls before registering a status change.

Set product code of the node. The next configuration poll replaces the value if the device reports its own hardware information.

Set product name of the node. The next configuration poll replaces the value if the device reports its own hardware information.

Set product version of the node. The next configuration poll replaces the value if the device reports its own hardware information.

Set SNMP community string used for polling this node (SNMP version 1 and 2c).

Set separate community string for validating SNMP traps received from this node (SNMP version 1 and 2c). If not set, traps are validated against polling credentials. Use clearSNMPTrapCredentials() to remove it. Since 6.2.3

Set separate SNMP version 3 USM credentials for validating SNMP traps received from this node. If not set, traps are validated against polling credentials. Use clearSNMPTrapCredentials() to remove them. Since 6.2.3

Set SNMP version 3 USM credentials used for polling this node. Node’s SNMP version is switched to 3.

$node.setSNMPUSMCredentials("monitor", "authpass123", "privpass123", "sha256", "aes-128");
$node.forceConfigurationPoll();

Set SNMP version used for polling this node.

$node.setSNMPVersion("2c");
$node.setSNMPCommunity("public");

Set serial number of the node. The next configuration poll replaces the value if the device reports its own hardware information.

Set password used for VNC connections to this node. Since 6.2.1

Set vendor of the node. The next configuration poll replaces the value if the device reports its own hardware information.

// Fill hardware information from custom attributes populated by an external inventory system
vendor = $node.getCustomAttribute("inv.vendor");
if (vendor != null)
{
   $node.setVendor(vendor);
   $node.setProductName($node.getCustomAttribute("inv.model"));
   $node.setSerialNumber($node.getCustomAttribute("inv.serial"));
}

Trace layer 2 path from this node to the destination node using layer 2 peer information and switch forwarding databases (MAC address tables) collected by the server. No requests are sent to devices.

path = $node.traceL2Path(FindObject("core-sw1"));
if ((path != null) && path.isComplete)
{
   for (hop : path.hops)
   {
      if (hop.type == "L2_LINK")
         println(hop.node.name .. " via " .. hop.name);
   }
}

Trace layer 3 path from this node to the destination node using routing tables collected by the server. No requests are sent to devices.

path = $node.traceRoute(FindObject("core-router"));
if (path != null)
{
   for (hop : path.hops)
      println(hop);
}

Send Wake-on-LAN magic packet to this node. Interfaces with IPv4 address are tried in order until magic packet is sent successfully; interfaces that are not unmanaged are tried first, then unmanaged ones. See Interface::wakeUp() for details on how the packet is sent. Since 6.2.3

// Action script: wake up node that went down
if (!$node.wakeUp())
   println("Cannot send WoL packet to " .. $node.name);