This is the documentation for the development version. There are no official binaries for it; build it from the source code in git. Download links on these pages work only after the release. For the current release, see version 7.0.

Global Constants

Status of the BusinessService class object

Constant Value Description

BusinessServiceState::OPERATIONAL

0

No failed checks

BusinessServiceState::DEGRADED

2

One of checks returned not normal, but is not failed yet

BusinessServiceState::FAILED

4

At least one of checks failed

Type of BusinessServiceCheck class

Constant Value Description

BusinessServiceType::NONE

0

None

BusinessServiceType::SCRIPT

1

Script

BusinessServiceType::DCI

2

DCI

BusinessServiceType::OBJECT

3

Object

Data types of the DCI class

Constant Value Description

DCI::INT32

0

Signed 32 bit integer

DCI::UINT32

1

Unsigned 32 bit integer

DCI::INT64

2

Signed 64 bit integer

DCI::UINT64

3

Unsigned 64 bit integer

DCI::STRING

4

String

DCI::FLOAT

5

Floating point number

DCI::NULL

6

Used internally; should not be used in the scripts

DCI::COUNTER32

7

32 bit counter

DCI::COUNTER64

8

64 bit counter

Data collection exit codes

Should be used in order to return errors in script DCIs or in transformation script.

Constant

Description

DataCollection::ERROR

DCI collection error

DataCollection::INVALID_DATA

Collected data is invalid (for example, cannot be parsed or converted to the DCI data type)

DataCollection::NO_SUCH_INSTANCE

No such instance error

DataCollection::NOT_SUPPORTED

Not supported error

DCI states of the DCI class

Constant Value Description

DCI::ACTIVE

0

Active

DCI::DISABLED

1

Disabled

DCI::UNSUPPORTED

2

Unsupported

DCI data source (origin) of the DCI class

Constant Value Description

DataSource::INTERNAL

0

Internal

DataSource::AGENT

1

Agent

DataSource::SNMP

2

SNMP

DataSource::WEB_SERVICE

3

Web service

DataSource::PUSH

4

Push data

DataSource::WINPERF

5

Windows Performance Counters

DataSource::SMCLP

6

SMCLP

DataSource::SCRIPT

7

Script

DataSource::SSH

8

SSH

DataSource::MQTT

9

MQTT

DataSource::DEVICE_DRIVER

10

Network Device driver

DataSource::MODBUS

11

Modbus

DataSource::ETHERNET_IP

12

EtherNet/IP

DataSource::CLOUD_CONNECTOR

13

Cloud connector

DataSource::OTLP

14

OpenTelemetry (OTLP)

DataSource::TRAFFIC_OBSERVER

15

Traffic observer

DataSource::NETCONF

16

NETCONF

DataSource::COMPUTED

17

Computed (values are produced by server-side engines, not polled)

Flags for DCI class

Constant Value Description

DCI::ALL_THRESHOLDS

0x00002

Process all thresholds

DCI::RAW_VALUE_OCTET_STRING

0x00004

Raw value is octet string

DCI::SHOW_ON_OBJECT_TOOLTIP

0x00008

Show DCI on object tooltip

DCI::AGGREGATE_ON_CLUSTER

0x00080

Aggregate data on cluster

DCI::TRANSFORM_AGGREGATED

0x00100

Transform aggregated data

DCI::CALCULATE_NODE_STATUS

0x00400

Used in node status calculation

DCI::SHOW_IN_OBJECT_OVERVIEW

0x00800

Show in object overview

DCI::AGGREGATE_WITH_ERRORS

0x04000

Aggregate with errors

DCI::HIDE_ON_LAST_VALUES_PAGE

0x08000

Hide on last values page

DCI::STORE_CHANGES_ONLY

0x40000

Store changed values only

DHCP lease type

Values of the type attribute of the DHCPLease class.

Constant Value Description

DHCPLeaseType::DYNAMIC

0

Dynamic lease

DHCPLeaseType::RESERVATION

1

Reservation (static address assignment)

DHCP lease state

Values of the state attribute of the DHCPLease class.

Constant Value Description

DHCPLeaseState::ACTIVE

0

Active

DHCPLeaseState::EXPIRED

1

Expired

DHCPLeaseState::DECLINED

2

Declined

DHCPLeaseState::RELEASED

3

Released

DHCPLeaseState::OFFERED

4

Offered

DHCPLeaseState::INACTIVE

5

Reservation without an active lease

Origin of Event class

Constant Value Description

EventOrigin::SYSTEM

0

System

EventOrigin::AGENT

1

Agent

EventOrigin::CLIENT

2

Client

EventOrigin::SYSLOG

3

Syslog

EventOrigin::SNMP

4

SNMP

EventOrigin::NXSL

5

NXSL

EventOrigin::REMOTE_SERVER

6

Remote server

EventOrigin::WINDOWS_EVENT

7

Windows event

EventOrigin::OPENTELEMETRY

8

OpenTelemetry

Category of HardwareComponent class

Constant Value Description

HardwareComponentCategory::OTHER

0

Other

HardwareComponentCategory::BASEBOARD

1

Baseboard

HardwareComponentCategory::PROCESSOR

2

Processor

HardwareComponentCategory::MEMORY

3

Memory

HardwareComponentCategory::STORAGE

4

Storage

HardwareComponentCategory::BATTERY

5

Battery

HardwareComponentCategory::NETWORK_ADAPTER

6

Network adapter

Expected state for Interface class

Constant Value Description

InterfaceExpectedState::UP

0

Up

InterfaceExpectedState::DOWN

1

Down

InterfaceExpectedState::IGNORE

2

Ignore

Constant Value Description

MapLinkColorSource::CustomColor

2

Link color source custom color

MapLinkColorSource::Default

0

Link color source default color

MapLinkColorSource::InterfaceStatus

5

Link color source interface status

MapLinkColorSource::InterfaceUtilization

4

Link color source interface utilization

MapLinkColorSource::ObjectStatus

1

Link color source object status

MapLinkColorSource::Script

3

Link color source script

Constant Value Description

MapLinkRoutingAlgorithm::Default

0

Map default

MapLinkRoutingAlgorithm::Direct

1

Direct

MapLinkRoutingAlgorithm::Manhattan

2

Manhattan

MapLinkRoutingAlgorithm::BendPoints

3

Bend points

Constant Value Description

MapLinkStyle::Default

0

Map default

MapLinkStyle::Solid

1

Solid line

MapLinkStyle::Dash

2

Dashed line

MapLinkStyle::Dot

3

Dotted line

MapLinkStyle::DashDot

4

Dash-dot line

MapLinkStyle::DashDotDot

5

Dash-dot-dot line

Constant Value Description

LinkLabelPosition::Center

0

Locate label at the center of the link

LinkLabelPosition::Object1

1

Locate label at the first object

LinkLabelPosition::Object2

2

Locate label at the second object

MAC address notation

Output formats for the toString() method of the MacAddress class.

Constant Value Description

MacAddressNotation::FLAT_STRING

0

No separators (001122334455)

MacAddressNotation::COLON_SEPARATED

1

Byte pairs separated by colons (00:11:22:33:44:55); default

MacAddressNotation::BYTEPAIR_COLON_SEPARATED

2

Groups of two bytes separated by colons (0011:2233:4455)

MacAddressNotation::HYPHEN_SEPARATED

3

Byte pairs separated by hyphens (00-11-22-33-44-55)

MacAddressNotation::DOT_SEPARATED

4

Groups of three hex digits separated by dots (001.122.334.455)

MacAddressNotation::BYTEPAIR_DOT_SEPARATED

5

Groups of two bytes separated by dots (0011.2233.4455)

MacAddressNotation::DECIMAL_DOT_SEPARATED

6

Decimal byte values separated by dots (0.17.34.51.68.85)

Node state

Constant Value Description

NodeState::Unreachable

0x00000001

Node is unreachable

NodeState::NetworkPathProblem

0x00000002

Network path problem

NodeState::AgentUnreachable

0x00010000

NetXMS agent unreachable

NodeState::SNMPUnreachable

0x00020000

Unreachable via SNMP

NodeState::EtherNetIPUnreachable

0x00040000

Unreachable via EtherNet/IP industrial protocol

NodeState::CacheModeNotSupported

0x00080000

Cache mode is not supported on NetXMS agent

NodeState::SNMPTrapFlood

0x00100000

SNMP trap flood detected

NodeState::ICMPUnreachable

0x00200000

Unreachable via ICMP

NodeState::SSHUnreachable

0x00400000

Unreachable via SSH

NodeState::MODBUSUnreachable

0x00800000

Unreachable via MODBUS

Object status codes

Constant Value Description

Status::NORMAL

0

Normal

Status::WARNING

1

Warning

Status::MINOR

2

Minor

Status::MAJOR

3

Major

Status::CRITICAL

4

Critical

Status::UNKNOWN

5

Unknown

Status::UNMANAGED

6

Unmanaged

Status::DISABLED

7

Disabled

Status::TESTING

8

Kept only for compatibility with existing scripts. The server never sets this status.

Alarm state values

Numeric state values used by the Alarm state attribute. These are not named NXSL constants — use the numeric values directly.

Value Description

0

Outstanding — new alarm, not yet acknowledged

1

Acknowledged — acknowledged by an operator

2

Resolved — problem resolved

3

Terminated — alarm has been closed and removed from active list

17 (0x11)

Sticky acknowledged — acknowledgement persists even when new matching events arrive

Cluster state

Constant Value Description

ClusterState::Unreachable

0x00000001

Unreachable

ClusterState::NetworkPathProblem

0x00000002

Network Path Problem

ClusterState::Down

0x00010000

Down

Sensor device class

Constant

Value

Description

SensorDeviceClass::Other

0

Other

SensorDeviceClass::UPS

1

UPS

SensorDeviceClass::WaterMeter

2

Water Meter

SensorDeviceClass::ElectricityMeter

3

Electricity Meter

SensorDeviceClass::Temperature

4

Temperature

SensorDeviceClass::Humidity

5

Humidity

SensorDeviceClass::TemperatureAndHumidity

6

Temperature And Humidity

SensorDeviceClass::CO2

7

CO2

SensorDeviceClass::PowerSupply

8

Power Supply

SensorDeviceClass::Current

9

Current

SensorDeviceClass::WaterLeak

10

Water Leak

SensorDeviceClass::Smoke

11

Smoke

Sensor state

Constant Value Description

SensorState::Unreachable

0x00000001

Unreachable

SensorState::NetworkPathProblem

0x00000002

Network Path Problem

SensorState::MODBUSUnreachable

0x00800000

Unreachable via MODBUS

Seek origin

Reference position for the seek() method of the ByteStream class.

Constant Value Description

SeekOrigin::Begin

0

Seek from the beginning of the stream

SeekOrigin::Current

1

Seek from the current position

SeekOrigin::End

2

Seek from the end of the stream

Severity constants

Constant Value Description

Severity::NORMAL

0

Normal

Severity::WARNING

1

Warning

Severity::MINOR

2

Minor

Severity::MAJOR

3

Major

Severity::CRITICAL

4

Critical

Status colors

Values are RGB color strings.

Constant Value Description

StatusColor::NORMAL

rgb(0, 192, 0)

Normal

StatusColor::WARNING

rgb(0, 255, 255)

Warning

StatusColor::MINOR

rgb(231, 226, 0)

Minor

StatusColor::MAJOR

rgb(255, 128, 0)

Major

StatusColor::CRITICAL

rgb(192, 0, 0)

Critical

StatusColor::UNKNOWN

rgb(0, 0, 128)

Unknown

StatusColor::UNMANAGED

rgb(192, 192, 192)

Unmanaged

StatusColor::DISABLED

rgb(128, 64, 0)

Disabled

StatusColor::TESTING

rgb(255, 128, 255)

Kept only for compatibility with existing scripts. The server never sets the matching status.

Change Code

Node attributes change code

Constant Value

ChangeCode::NONE

0

ChangeCode::ADDED

1

ChangeCode::UPDATED

2

ChangeCode::REMOVED

3

Node Capability

Node capability flags. Used with Node attributes capabilities and expectedCapabilities, and with Node::setExpectedCapabilities() method.

Constant Value Description

NodeCapability::SNMP

0x0000000001

Node supports SNMP

NodeCapability::Agent

0x0000000002

Node supports NetXMS native agent

NodeCapability::Bridge

0x0000000004

Node is a bridge

NodeCapability::Router

0x0000000008

Node is a router

NodeCapability::LocalManagement

0x0000000010

Local management capability

NodeCapability::Printer

0x0000000020

Node is a printer

NodeCapability::OSPF

0x0000000040

OSPF support

NodeCapability::SSH

0x0000000080

SSH support

NodeCapability::CDP

0x0000000100

Cisco Discovery Protocol support

NodeCapability::NDP

0x0000000200

Nortel (Synoptics/Bay Networks) topology discovery

NodeCapability::LLDP

0x0000000400

Link Layer Discovery Protocol support

NodeCapability::VRRP

0x0000000800

VRRP support

NodeCapability::VLAN

0x0000001000

VLAN information available

NodeCapability::IEEE802_1x

0x0000002000

802.1x support enabled on node

NodeCapability::STP

0x0000004000

Spanning Tree (IEEE 802.1d) enabled on node

NodeCapability::EntityMIB

0x0000008000

Supports ENTITY-MIB

NodeCapability::IfXTable

0x0000010000

Supports ifXTable (64-bit interface counters)

NodeCapability::AgentIfXCounters

0x0000020000

Agent supports 64-bit interface counters

NodeCapability::WindowsPDH

0x0000040000

Node supports Windows performance counters (PDH)

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

NodeCapability::AgentLLDP

0x2000000000

Agent exposes LLDP.Neighbors table

NodeCapability::NETCONF

0x4000000000

Node supports NETCONF protocol

NodeCapability::DHCPServer

0x10000000000

Node is a DHCP server and provides scope and lease information

NodeCapability::SNMPGetBulk

0x20000000000

SNMP agent on node supports GETBULK requests

Other constants

NXSL::BuildTag

Current server build tag

NXSL::Classes

Array containing all NXSL classes

NXSL::Functions

Array containing names of all NXSL functions

NXSL::SystemIsBigEndian

TRUE if system is big endian otherwise FALSE

NXSL::Version

Current server version