Node

Represents NetXMS node object. Extends DataCollectionTarget.

Instance attributes

Inherited from NetObj

alarms ⇒ array: List of active Alarms for this object.
alarmStats ⇒ array: Integer array that consists of 5 numbers - each number represents number of alarms for this and child objects for each of severity.
alias: String: Object alias. For interfaces it is automatically collected on configuration poll (e.g. from SNMP ifAlias).
asset ⇒ Asset: Reference to asset class of asset linked to this object.
assetId: int: Id of linked asset object.
assetProperties ⇒ AssetProperties: Reference to asset properties class of asset linked to this object.
backupZoneProxy: Node: Currently selected backup zone proxy (null if zoning is disabled or backup proxy is not assigned)
backupZoneProxyId: int: ID of currently selected backup zone proxy (0 if zoning is disabled or backup proxy is not assigned)
category: String: Object’s category name
categoryId: int: Object’s category ID
children ⇒ array: List of child objects. Use classof to differentiate.
city: String: Postal address - city.
comments: String: Object comments.
country: String: Postal address - country.
creationTime: int64: Object creation time as UNIX timestamp
customAttributes ⇒ HashMap: Hash map of object custom attributes.
district: String: Postal address - district.
geolocation ⇒ GeoLocation: Object geographical location.
guid: String: Object GUID as string.
id: int: Unique object identifier.
ipAddr: String: Primary IP address. Deprecated and will be removed in a future version, use ipAddress instead.
ipAddress ⇒ InetAddress: Added in version 5.1

Primary IP address.
isInMaintenanceMode: bool: Maintenance mode indicator (true if object currently is in maintenace mode).
maintenanceInitiator: int: Maintenance initiator user id
mapImage: String: GUID of object image used for representation on the maps.
name: String: Object name.
nameOnMap: String: Object name displayed on map.
parents ⇒ array: List of direct parents for this object (most likely either Container or Cluster).
postcode: String: Postal address - postal code.
primaryZoneProxy: Node: currently selected primary zone proxy (null if zoning is disabled or primary proxy is not assigned)
primaryZoneProxyId: int: ID of currently selected primary zone proxy (0 if zoning is disabled or primary proxy is not assigned)
region: String: Postal address - region.
responsibleUsers: Array: Array with user objects that are added as responsible users for this object. Objects are User or UserGroup
state: int: Current object state. One of: Node State, Cluster State, Sensor State
status: int: Current object status.
streetAddress: String: Postal address - street.
type: int: Object type.

Inherited from DataCollectionTarget

templates: Array: Returns array of templates (Template) applied on this object. Return value also affected by trusted nodes settings.

agentCertificateMappingData: String: Agent certificate mapping data (set in object properties).

agentCertificateMappingMethod: String: Agent certificate mapping method (set in object properties).

agentCertificateSubject: String: Subject of certificate issued for agent tunnel on this node.

agentId: String: NetXMS agent unique ID (string representation of GUID). Will return all zeroes GUID if agent is not detected on node or does not have unique ID.

agentProxy ⇒ Node: Object that is set as agent proxy in object properties or NULL.

agentVersion: String: NetXMS agent version as string.

bootTime: int64: UNIX time (number of seconds since epoch) of the moment when node was started or 0 if unknown.

bridgeBaseAddress: String: Base address of the switch formatted as 12 character string without separators. Value is only valid for bridges and switches. Special value 000000000000 indicates that address is unknown.

capabilities: int: Detected node capabilities ("Have Agent", "Support SNMP", etc.) Bitwise OR of node capability constants.

cipDeviceType: int: EtherNet/IP device type

cipDeviceTypeAsText: String: EtherNet/IP device type as text

cipExtendedStatus: int: EtherNet/IP device extended status

cipExtendedStatusAsText: String: EtherNet/IP device extended status as text

cipState: int: EtherNet/IP device state

cipStateAsText: String: EtherNet/IP device state as text

cipStatus: int: EtherNet/IP device status

cipStatusAsText: String: EtherNet/IP device status as text

cipVendorCode: int: EtherNet/IP vendor code in numeric form.

cluster ⇒ Cluster: Cluster this node is in.

components ⇒ Component: Entity MIB components of class Component.

dependentNodes: Array: Will return array with NodeDependency class objects. This array contains all objects that have current node as a proxy or data collection sources.

downSince: int64: UNIX timestamp when node went down.

driver: String: Named of selected device-specific SNMP driver.

expectedCapabilities: int: Expected capabilities bitmask for the node. Capabilities set in this mask are protected from automatic removal when protocols become temporarily unreachable. Bitwise OR of node capability constants. See setExpectedCapabilities().

Added in version 5.2

effectiveAgentProxy ⇒ Node: Object that is effective agent proxy or NULL.

effectiveIcmpProxy ⇒ Node: Object that is effective ICMP proxy or NULL.

effectiveSnmpProxy ⇒ Node: Object that is effective SNMP proxy or NULL.

flags: int: Bit mask of Node flags.

hardwareComponents: Array: Returns an array of available hardware of class HardwareComponent.

hardwareId: String: Nodes' unique hardware id

hasAgentIfXCounters: bool: TRUE if agent supports 64-bit interface counters.

hasEntityMIB: bool: TRUE if supports ENTITY-MIB.

hasServiceManager: bool: TRUE if node has service manager accessible via NetXMS agent.

hasIfXTable: bool: TRUE if supports ifXTable via SNMP (64-bit counters for interface statistics).

hasUserAgent: bool: TRUE if has user agent

hasVLANs: bool: TRUE if VLAN information available.

hasWinPDH: bool: TRUE if node supports Windows PDH parameters.

hypervisorInfo: String: Additional information about hypervisor for this node.

hypervisorType: String: Hypervisor type as string (usually hypervisor vendor or product name, like VMWare or XEN).

icmpAverageRTT: int: ICMP average response time for primary address. Will return null if no information.

icmpLastRTT: int: ICMP last response time for primary address. Will return null if no information.

icmpMaxRTT: int: ICMP maximal response time for primary address. Will return null if no information.

icmpMinRTT: int: ICMP minimal response time for primary address. Will return null if no information.

icmpPacketLoss: int: ICMP packet loss for primary address. Will return null if no information.

icmpProxy ⇒ Node: Object that is set as ICMP proxy in object properties or NULL.

interfaces: Array: Array with Interface objects, that are under this node. First object placed at index 0.

is802_1x: bool: TRUE if node supports 802.1x. Equivalent of isPAE.

isAgent: bool: TRUE if NetXMS agent detected on node

isBridge: bool: TRUE if node is a bridge

isCDP: bool: TRUE if node supports CDP (Cisco Discovery Protocol)

isDecommissioned: bool: TRUE if node is decommissioned.

isEtherNetIP: bool: TRUE if node supports EtherNet/IP (Industrial Protocol)

isExternalGateway: bool: TRUE if node is an external gateway (remotely managed node). Alias: isRemotelyManaged.

isInMaintenanceMode: bool: TRUE if node is in maintenance mode

isLLDP: bool: TRUE if node supports LLDP (Link Layer Discovery Protocol)

isLocalManagement: bool: TRUE if node is a local management server (NetXMS server)

isLocalMgmt: bool: TRUE if node is a local management server (NetXMS server)

isModbusTCP: bool: TRUE if node supports Modbus TCP

isNativeAgent: bool: TRUE if node is a native agent.

isNDP: bool: TRUE if node supports OSPF/NDP. Equivalent of isOSPF.

isOSPF: bool: TRUE if node supports OSPF/NDP. Equivalent of isNDP.

isPAE: bool: TRUE if node supports 802.1x. Equivalent of is802_1x.

isPrinter: bool: TRUE if node is a printer

isProfiNet: bool: TRUE if node supports PROFINET (Process Field Network)

isRouter: bool: TRUE if node is a router (has IP forwarding enabled)

isSMCLP: bool: TRUE if node supports SMCLP (Server Management Command Line Protocol)

isSNMP: bool: TRUE if SNMP agent detected on node

isSONMP: bool: TRUE if node supports SONMP/NDP (Synoptics/Nortel Discovery Protocol)

isSSH: bool: TRUE if SSH is connection available

isSSHCommandChannelAvailable: bool: TRUE if SSH command channel can be established to this node.

isSSHInteractiveChannelAvailable: bool: TRUE if SSH interactive (shell) channel can be established to this node.

isSTP: bool: TRUE if node supports STP (Spanning Tree Protocol)

isVirtual: bool: TRUE if node is virtual

isVRRP: bool: TURE if VRRP supported.

isWirelessAP: bool: TURE if node is wireless access point

isWirelessController: bool: TURE if node is wireless controller

lastAgentCommTime: int: Unix timestamp of last time when communication with agent was

modbusProxy ⇒ Node: MODBUS proxy object

modbusProxyId: int: MODBUS proxy object id

modbusTCPPort: int: MODBUS TCP port

modbusUnitId: int: MODBUS unit id

networkPathCheckResult ⇒ NetworkPathCheckResult: Node network path

nodeSubType: String: Node sub type

nodeType: int: Node type Node types

ospfAreas ⇒ OSPFArea: Returns OSPFArea class object

ospfNeighbors: Array: Array with OSPFArea class objects

ospfRouterId: String: OSPF router ID

physicalContainer ⇒ Object: Physical container object: Rack NetObj or Chassis Chassis

physicalContainerId: int: Physical container object id (Rack or Chassis)

platformName: String: Platform name reported by NetXMS agent

pollCountForStatusChange: int: Number of polls required before registering a status change.

primaryHostName: String: Primary host name

productCode: String: Hardware system property - product code

productName: String: Hardware system property - product name

productVersion: String: Hardware system property - product version

rack ⇒ NetObj: Will return Rack object as NetObj if node is added in rack

rackHeight: int: Object height in rack

rackId: int: Will return Rack id if node is added in rack

rackPosition: int: Object position in rack

runtimeFlags: int: Bit mask of Node runtime flags, uint32.

serialNumber: String: Serial number from hardware system property

snmpOID: String: SNMP object identifier (result of 1.3.6.1.2.1.1.2.0 request)

snmpProxy ⇒ Node: Object that is set as SNMP proxy in object properties or NULL.

snmpProxyId: int: SNMP proxy object id.

snmpSysContact: String: SNMP system contact (result of 1.3.6.1.2.1.1.4.0 request)

snmpSysLocation: String: SNMP system location (result of 1.3.6.1.2.1.1.6.0 request)

snmpSysName: String: SNMP system name (result of 1.3.6.1.2.1.1.5.0 request)

snmpVersion: int

Configured SNMP version:

0: SNMP version 1
1: SNMP version 2c
2: SNMP version 3

softwarePackages: Array: Returns array of SoftwarePackage class objects

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)

tunnel ⇒ Tunnel: Tunnel object f this node or NULL if there is no tunnel active and bound to this node.

vendor: String: Hardware vendor information

vlans: Array: Array with object VLAN objects (null if there are no VLANs)

wirelessDomain ⇒ WirelessDomain: Wireless domain of this node

wirelessDomainId: int: Wireless domain id of this node

wirelessStations: Array: Array with object WirelessStation objects (null if there are no Wireless Stations)

zone ⇒ Zone: Zone object (null if zoning is disabled)

zoneProxyAssignments: int: Number of objects where this node is selected as either primary or backup zone proxy (0 if zoning is disabled or this node is not a zone proxy).

zoneProxyStatus: bool: Status of this node as zone proxy (true if active).

zoneUIN: int: This node zone UIN

Instance methods

Inherited methods from NetObj

bind(childObject): void: Bind childObject to the current object as a child.
bindTo(parentObject): void: Bind current object to parentObject as a child.
calculateDowntime(tag, periodStart, periodEnd): Array: Calculate node downtime. Returns array of DowntimeInfo objects.
clearGeoLocation(): void: Clears GeoLocation data from the node.
createUserAgentNotification(message, startTime, endTime, showOnStartup): int: Send user agent notification. Returns message id.
delete(): void: Deletes current object.
deleteCustomAttribute(name): void: Delete custom attribute.
enterMaintenance(): void: Enable maintenance mode for the object.
expandString(string): String: Expand string by replacing macros with their values.
getCustomAttribute(name): String: Returns value of the custom attribute with the provided name.
getResponsibleUsers(tag) ⇒ array: Returns list of responsible users with specific tag.
isChild(object): bool: Returns TRUE if provided object is child of this object.
isDirectChild(object): bool: Returns TRUE if provided object is direct child of this object.
isDirectParent(object): bool: Returns TRUE if provided object is direct parent of this object.
isParent(object): bool: Returns TRUE if provided object is parent of this object.
leaveMaintenance(): void: Disable maintenance mode for the object.
manage(): void: Sets object to managed state.
readMaintenanceJournal(startTime, endTime): Array: Read maintenance entries. Returns array of MaintenanceJournalRecord objects.
rename(name): void: Rename object.
setAlias(name): void: Set object alias name.
setCategory(idOrName): void: Set object category id or name.
setComments(comment, [isMarkdown]): void: Set object comments.
setCustomAttribute(key, value, inherit=false): void: Update or create custom attribute.
setGeoLocation(newLocation): void: Sets node geographical location.
setMapImage(image): void: Sets object image for network map display.
setNameOnMap(name): void: Sets object’s name for network map display.
setStatusCalculation(type, …): void: Sets status calculation method.
setStatusPropagation(type, …): void: Sets status propagation method.
unbind(object): void: Unbind provided object from the current object.
unbindFrom(object): void: Unbind current object from the provided object.
unmanage(): void: Set object into unmanaged state.
writeMaintenanceJournal(description): void: Add entry to maintenance journal.

Inherited methods from DataCollectionTarget

applyTemplate(template): void: Apply template to node.
enableConfigurationPolling(flag): void: Enable or disable configuration polling.
enableDataCollection(flag): void: Enable or disable data collection polling.
enableStatusPolling(flag): void: Enable or disable status polling.
readInternalParameter(name): String: Reads object internal metric (metric with source "Internal").
readInternalTable(name): String: Reads object internal table metric (metric with source "Internal").
removeTemplate(template): void: Remove template from node.

callWebService(webSvcName, requestType, …) ⇒ WebServiceResponse

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

Table 1. Parameters
webSvcName	String	Web service name.
requestType	String	Request type. One of: GET, DELETE, PATCH, POST, PUT
data	String or JsonObject	Depending on request type data might be required and provided as a string or JSON object. GET and DELETE requests do not allow data, PATCH, POST, PUT require data.
contentType	String	Optional parameter, for PATCH, POST and PUT requests only. Type of provided data that will be set to "Content-Type" header of request. Default type is "application/json".
acceptCached	Boolean	Optional named parameter. If True, response stored in agent’s cache will be used. Default: false.
…	Strings	Optional additional parameter(s) that will be used in web service definition to expand %1, %2… macro.

Return

Instance of WebServiceResponse with request result.

// 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);

createSNMPTransport(port, community, context, failIfUnreachable) ⇒ SNMPTransport

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.

Table 2. Parameters
port	Integer	Optional parameter with port.
community	String	Optional parameter with community string.
context	String	Optional parameter with context.
failIfUnreachable	String	Optional parameter, is provided and is true, check that SNMP is reachable on the node before creating SNMP transport.

Added in version 4.4.1: failIfUnreachable parameter

Return

Instance of SNMPTransport or null if failed or node was not reacheable when failIfUnreachable was set to true.

enable8021xStatusPolling(flag): void

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

Table 3. Parameters
flag	Boolean	If 802.1x port state checking should be enabled.

enableAgent(flag): void

Enable or disable usage of NetXMS agent for all polls.

Table 4. Parameters
flag	Boolean	If agent usage should be enabled.

enableDiscoveryPolling(flag): void

Enable or disable discovery polling.

Table 5. Parameters
flag	Boolean	If discovery polling should be enabled.

enableEtherNetIP(flag): void

Enable or disable usage of EtherNet/IP for polls.

Table 6. Parameters
flag	Boolean	If EtherNet/IP should be enabled.

enableIcmp(flag): void

Enable or disable usage of ICMP pings for status polls.

Table 7. Parameters
flag	Boolean	If ICMP pings should be enabled.

enableModbusTcp(flag): void

Enable or disable usage of Modbus TCP for polls.

Table 8. Parameters
flag	Boolean	If Modbus TCP should be enabled.

enablePrimaryIPPing(flag): void

Enable or disable usage of ICMP ping for primary IP.

Table 9. Parameters
flag	Boolean	If primary IP ping should be enabled.

enableRoutingTablePolling(flag): void

Enable or disable routing table polling.

Table 10. Parameters
flag	Boolean	If routing table polls should be enabled.

enableSnmp(flag): void

Enable or disable usage of SNMP for all polls.

Table 11. Parameters
flag	Boolean	If SNMP communication should be enabled.

enableSmclpPropertyPolling(flag): void

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

Table 12. Parameters
flag	Boolean	If 802.1x port state checking should be enabled.

enableSsh(flag): void

Enable or disable usage of SSH

Table 13. Parameters
flag	Boolean	If SSH communication should be enabled.

enableTopologyPolling(flag): void

Enable or disable topology polling.

Table 14. Parameters
flag	Boolean	If topology polls should be enabled.

enableVnc(flag): void

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

Table 15. Parameters
flag	Boolean	If VNC detection should be enabled.

enableWinPerfCountersCache(flag): void

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

Table 16. Parameters
flag	Boolean	If reading of Windows performance counters metadata should be enabled.

executeAgentCommand(command, …): bool

Execute agent command (action) on node.

Table 17. Parameters
command	String	Command to be executed.
…	String	Optional arguments for command

Return

True if command execution is successful or false otherwise.

executeAgentCommandWithOutput(command, …): String

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

Table 18. Parameters
command	String	Command to be executed.
…	String	Optional arguments for command

Return

String with output of the command or null on failure.

executeSSHCommand(command) ⇒ array

Execute SSH command on node.

Table 19. Parameters
command	String	Command to be executed.

Return

Array of strings with output of the command or null on failure.

getBlockedPorts(protocol): Array

Get array of blocked ports for the specified protocol.

Table 20. Parameters
protocol	String	Protocol type - "tcp" or "udp"

Return

Array of integers representing blocked port numbers.

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

getInstalledPackages(filter, useRegex): Array

Get array of installed packages on the node.

Table 21. Parameters
filter	String	Optional package name filter
useRegex	Boolean	Optional. If TRUE, use regex matching for filter. Default is FALSE

Return

Array of installed packages on the node.

// Get all packages
packages = $node->getInstalledPackages();

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

getInterface(ifIdentifier) ⇒ Interface

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

Table 22. Parameters
ifIdentifier	Integer or String	Index, MAC address or name of interface.

Return

Interface object.

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"

getInterfaceByIndex(ifIndex) ⇒ Interface

Get interface object by index.

Table 23. Parameters
ifIndex	Integer	Index of interface.

Return

Interface object.

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

getInterfaceByMACAddress(ifMACAddr) ⇒ Interface

Get interface object by MAC address.

Table 24. Parameters
ifMACAddr	String	MAC address of interface.

Return

Interface object.

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

getInterfaceByName(IfName) ⇒ Interface

Get interface object by name.

Table 25. Parameters
IfName	String	Name of interface.

Return

Interface object.

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

getInterfaceName(ifIndex): String

Get interface name by index.

Table 26. Parameters
ifIndex	Integer	Index of interface.

isPortBlocked(port, protocol): bool

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

Table 27. Parameters
port	Integer	Port number (1-65535)
protocol	String	Protocol - "tcp" or "udp"

Return

TRUE if the port is blocked, FALSE otherwise.

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

getWebService(webSvcName) ⇒ WebService

Get web service object by name.

Table 28. Parameters
webSvcName	String	Name of interface.

Return

WebService object.

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

openSSHSession(user, password, keyId) ⇒ SSHSession

Open an interactive SSH session to this node.

Table 29. Parameters
user	String	Optional SSH login username
password	String	Optional SSH password
keyId	Integer	Optional SSH key identifier

Return

SSHSession object on success, or NULL on failure.

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

readAgentList(name): Array

Request agent list directly from agent on given node. Returns array of strings or NULL if failed.

Table 30. Parameters
name	String	List name.

readAgentParameter(name): String

Request metric directly from agent on given node. Returns NULL if failed.

Table 31. Parameters
name	String	Metric name.

readAgentTable(name) ⇒ Table

Requests agent table directly from agent on given node. Returns Table or NULL if failed.

Table 32. Parameters
name	String	Table name.

readDriverParameter(name): String

Request driver-specific metric from network device driver (e.g. Rital).

Table 33. Parameters
name	String	List name.

readInternalParameter(name): String

Read internal parameter

Table 34. Parameters
name	String	Parameter name

Return

Value of requested internal parameter

readInternalTable(name) ⇒ Table

Read internal table

Table 35. Parameters
name	String	Table name

Return

Value of requested internal table of class Table

readWebServiceList(name): Array

Read list from node using web service

Table 36. Parameters
name	String	Name is expected in form service:path or service(arguments):path

Return

Array with string with web service instances

readWebServiceParameter(name): String

Read from node web service parameter

Table 37. Parameters
name	String	Name is expected in form service:path or service(arguments):path

Return

String with result read from web service

setExpectedCapabilities(capabilities): void

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.

Only the following node capability flags are accepted (other bits are masked out):

NodeCapability::Agent (0x0000000002)
NodeCapability::SNMP (0x0000000001)
NodeCapability::SSH (0x0000000080)
NodeCapability::EtherNetIP (0x0000800000)

NodeCapability::ModbusTCP (0x0001000000)

Table 38. Parameters
capabilities	Integer	Bitmask of node capability flags.

Return

void

// Ensure SNMP and agent capabilities are never automatically removed
$node.setExpectedCapabilities(NodeCapability::SNMP | NodeCapability::Agent);

// Protect all supported protocol capabilities
$node.setExpectedCapabilities(
    NodeCapability::Agent | NodeCapability::SNMP |
    NodeCapability::SSH | NodeCapability::EtherNetIP |
    NodeCapability::ModbusTCP
);

// Clear expected capabilities (allow normal automatic removal)
$node.setExpectedCapabilities(0);

Added in version 5.2

setIfXTableUsageMode(mode): void

Set ifXTable usage mode 0 - use default, 1 - enable, 2 - disable

Table 39. Parameters
mode	Integer	usage mode

setPollCountForStatusChange(count): void

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

Table 40. Parameters
count	Integer	Number of polls (must be >= 0) or 0 to use system default.

Constants

Table 41. Node flags
Description	Value
DCF_DISABLE_STATUS_POLL	0x00000001
DCF_DISABLE_CONF_POLL	0x00000002
DCF_DISABLE_DATA_COLLECT	0x00000004
DCF_LOCATION_CHANGE_EVENT	0x00000008
NF_EXTERNAL_GATEWAY	0x00010000
NF_DISABLE_DISCOVERY_POLL	0x00020000
NF_DISABLE_TOPOLOGY_POLL	0x00040000
NF_DISABLE_SNMP	0x00080000
NF_DISABLE_NXCP	0x00100000
NF_DISABLE_ICMP	0x00200000
NF_FORCE_ENCRYPTION	0x00400000
NF_DISABLE_ROUTE_POLL	0x00800000
NF_AGENT_OVER_TUNNEL_ONLY	0x01000000
NF_SNMP_SETTINGS_LOCKED	0x02000000
NF_PING_PRIMARY_IP	0x04000000
NF_DISABLE_ETHERNET_IP	0x08000000
NF_DISABLE_PERF_COUNT	0x10000000

Table 42. Node runtime flags
Description	Value
DCDF_QUEUED_FOR_STATUS_POLL	0x00000001
DCDF_QUEUED_FOR_CONFIGURATION_POLL	0x00000002
DCDF_QUEUED_FOR_INSTANCE_POLL	0x00000004
DCDF_DELETE_IN_PROGRESS	0x00000008
DCDF_FORCE_STATUS_POLL	0x00000010
DCDF_FORCE_CONFIGURATION_POLL	0x00000020
DCDF_CONFIGURATION_POLL_PASSED	0x00000040
DCDF_CONFIGURATION_POLL_PENDING	0x00000080
NDF_QUEUED_FOR_TOPOLOGY_POLL	0x00010000
NDF_QUEUED_FOR_DISCOVERY_POLL	0x00020000
NDF_QUEUED_FOR_ROUTE_POLL	0x00040000
NDF_RECHECK_CAPABILITIES	0x00080000
NDF_NEW_TUNNEL_BIND	0x00100000

Node capability flags are available as node capability named constants.

Table 43. Node capability flags
Constant	Value	Description
NodeCapability::SNMP	0x0000000001	Node supports SNMP
NodeCapability::Agent	0x0000000002	NetXMS agent detected on the node
NodeCapability::Bridge	0x0000000004	Node is a network bridge
NodeCapability::Router	0x0000000008	Node is an IP router
NodeCapability::LocalManagement	0x0000000010	Node is management server (NetXMS server itself)
NodeCapability::Printer	0x0000000020	Node is a printer
NodeCapability::OSPF	0x0000000040	Node supports OSPF
NodeCapability::SSH	0x0000000080	SSH support
NodeCapability::CDP	0x0000000100	Cisco Discovery Protocol supported
NodeCapability::NDP	0x0000000200	NDP (SONMP) support detected (Nortel/Synoptics/Bay Networks topology discovery)
NodeCapability::LLDP	0x0000000400	Node supports LLDP
NodeCapability::VRRP	0x0000000800	Node supports VRRP
NodeCapability::VLAN	0x0000001000	VLAN information available on the node
NodeCapability::IEEE802_1x	0x0000002000	802.1x support detected
NodeCapability::STP	0x0000004000	Spanning Tree (IEEE 802.1d) enabled on node
NodeCapability::EntityMIB	0x0000008000	Node supports ENTITY-MIB
NodeCapability::IfXTable	0x0000010000	Node supports ifXTable via SNMP (64-bit interface counters)
NodeCapability::AgentIfXCounters	0x0000020000	Agent supports 64-bit interface counters
NodeCapability::WindowsPDH	0x0000040000	Node supports Windows PDH parameters
NodeCapability::WiFiController	0x0000080000	Node is wireless network controller
NodeCapability::SMCLP	0x0000100000	Node supports SMCLP protocol
NodeCapability::NewPolicyTypes	0x0000200000	Agent upgraded to new policy type
NodeCapability::UserAgent	0x0000400000	User agent (desktop support app) is installed
NodeCapability::EtherNetIP	0x0000800000	EtherNet/IP support
NodeCapability::ModbusTCP	0x0001000000	Modbus TCP support
NodeCapability::ProfiNet	0x0002000000	PROFINET support
NodeCapability::FileManager	0x0004000000	Node has file manager support
NodeCapability::LLDPv2	0x0008000000	LLDP v2 MIB support
NodeCapability::EmulatedEntityMIB	0x0010000000	ENTITY MIB support emulated by driver
NodeCapability::DeviceView	0x0020000000	Device view is supported
NodeCapability::WiFiAccessPoint	0x0040000000	Node is wireless access point
NodeCapability::VNC	0x0080000000	Node supports VNC connection from server or zone proxy
NodeCapability::LocalVNC	0x0100000000	Node supports VNC connection via local agent
NodeCapability::RegisteredForBackup	0x0200000000	Node is registered for device configuration backup
NodeCapability::ServiceManager	0x0400000000	Node has service manager accessible via NetXMS agent
NodeCapability::SSHInteractiveChannel	0x0800000000	Interactive (shell) SSH channel can be established
NodeCapability::SSHCommandChannel	0x1000000000	SSH command channel can be established

Table 44. Node types
Value	Description
0	Unknown
1	Physical
2	Virtual
3	Controller
4	Container