Object Classes Reference
This page lists all object classes available in NetXMS, their type identifiers, descriptions, and valid child objects. For details on object hierarchy, properties, and operations, see Object Model.
Infrastructure Objects
These objects represent physical and logical elements of your network infrastructure.
| Class | Type ID | Description | Valid Children |
|---|---|---|---|
Entire Network |
4 |
Abstract root of the IP topology tree. Automatically created during system installation; only one instance exists per system. |
Zone (if zoning enabled); Subnet (if zoning disabled) |
Zone |
6 |
Group of (usually interconnected) IP networks without overlapping addresses. Commonly used in large multi-site environments, especially when sites have duplicate IP address spaces. |
Subnet |
Subnet |
1 |
IP subnet, typically auto-created from interface addresses discovered during configuration polls. The only user-editable attribute is the name. |
Node (membership is automatic, derived from interface addresses, not manual binding) |
Node |
2 |
Physical or virtual host, network equipment, or any other IP-capable device. Created manually or through network discovery. Primary data collection target. |
Interface, Network Service, VPN Connector |
Interface |
3 |
Network interface of a node. Usually auto-created during configuration polls; can also be created manually. Properties include IP address, MAC address, link speed, and administrative/operational status. |
— |
Cluster |
14 |
Logical grouping of nodes that aggregates data from member nodes. Supports cluster resource tracking, shared DCI instances, and status aggregation. |
Node |
Chassis |
35 |
Physical chassis such as a blade server enclosure. Can be placed in a rack for visual representation. See Chassis details. |
Node |
Rack |
32 |
Physical equipment rack. Provides visual representation of installed equipment for capacity planning. See Rack details. |
Node, Chassis |
Circuit |
30 |
Network circuit or link composed of multiple interfaces. Generates events when interface state changes and supports auto-bind rules. See Circuit details. |
Interface |
Sensor |
37 |
Polled data collection target representing a physical device attached to a gateway node, addressed by Modbus unit ID (device address). Supports status and configuration polls and Modbus origin DCIs. |
— |
Traffic Observer |
40 |
Data collection target for network traffic analysis. Can be created only when the TRAFFIC server component is registered. |
Observation Point |
Observation Point |
41 |
Traffic observation point belonging to a Traffic Observer. |
— |
Access Point |
33 |
Thin wireless access point managed by a wireless controller. Auto-created when a controller node is polled. |
— |
Mobile Device |
31 |
Mobile device managed through the NetXMS mobile agent. |
— |
Wireless Domain |
34 |
Wireless network consisting of wireless controllers and their managed thin access points. |
Access Point, Node |
Cloud Domain |
38 |
Cloud infrastructure connector that provides resource discovery and monitoring for a cloud environment. |
Resource |
Resource |
39 |
Cloud resource discovered and managed by a Cloud Domain. Can contain nested resources to represent hierarchical cloud structures. |
Resource |
VPN Connector |
12 |
VPN tunnel endpoint for interfaceless tunnels (e.g., IPsec). Created manually on a node. Not needed for VPN technologies that create their own network interfaces. To model a VPN link, create a VPN Connector on each endpoint node and link them together; the server will include this connection in topology maps, root cause analysis, and event correlation. |
— |
Network Service |
11 |
Network service running on a node (HTTP, POP3, SMTP, SSH, Telnet, or custom TCP service). Created manually to monitor service availability. |
— |
Organizational Objects
These objects provide logical grouping and visual organization.
| Class | Type ID | Description | Valid Children |
|---|---|---|---|
Service Root |
7 |
Abstract root of the infrastructure service tree. Created automatically during installation; one instance per system, default name "Infrastructure Services". |
Access Point, Chassis, Circuit, Cluster, Cloud Domain, Collector, Condition, Container, Mobile Device, Node, Rack, Resource, Sensor, Subnet, Traffic Observer, Wireless Domain |
Container |
5 |
Grouping object for building a logical hierarchy of IT infrastructure. Supports auto-bind rules via NXSL scripts. |
Access Point, Chassis, Circuit, Cluster, Cloud Domain, Collector, Condition, Container, Mobile Device, Node, Rack, Resource, Sensor, Subnet, Traffic Observer, Wireless Domain |
Collector |
29 |
Container with data collection capabilities. Combines organizational grouping with the ability to collect metrics like a node. Supports auto-bind rules. |
Access Point, Chassis, Circuit, Cluster, Cloud Domain, Collector, Condition, Container, Mobile Device, Node, Rack, Resource, Sensor, Subnet, Traffic Observer, Wireless Domain |
Condition |
13 |
Evaluates an NXSL expression over DCI values to produce a synthetic status. Input DCIs are accessible as |
— |
Template Objects
These objects manage data collection and policy templates.
| Class | Type ID | Description | Valid Children |
|---|---|---|---|
Template Root |
10 |
Abstract root of the template tree. Created automatically during installation. |
Template, Template Group |
Template Group |
9 |
Grouping object for organizing templates in a hierarchical structure. |
Template, Template Group |
Template |
8 |
Defines data collection items and agent policies that can be applied to multiple target objects. When an object is linked as a child of a template, that template is applied to the object. See Templates. |
Access Point, Chassis, Circuit, Cluster, Cloud Domain, Collector, Mobile Device, Node, Observation Point, Resource, Sensor, Traffic Observer |
Asset Management Objects
These objects support hardware asset tracking.
| Class | Type ID | Description | Valid Children |
|---|---|---|---|
Asset Root |
18 |
Abstract root of the hardware asset management tree. Created automatically during installation. |
Asset, Asset Group |
Asset Group |
17 |
Grouping object for organizing assets in a hierarchical structure. |
Asset, Asset Group |
Asset |
16 |
Hardware asset record. Can be linked to infrastructure objects (Node, Rack, Chassis, Access Point, Mobile Device, Sensor) for tracking. |
— |
Network Map Objects
| Class | Type ID | Description | Valid Children |
|---|---|---|---|
Network Map Root |
19 |
Abstract root of the network map tree. Created automatically during installation. |
Network Map, Network Map Group |
Network Map Group |
20 |
Grouping object for organizing network maps. |
Network Map, Network Map Group |
Network Map |
21 |
Visual representation of network topology or custom layout of monitored objects. |
— |
Dashboard Objects
| Class | Type ID | Description | Valid Children |
|---|---|---|---|
Dashboard Root |
22 |
Abstract root of the dashboard tree. Created automatically during installation. |
Dashboard, Dashboard Group, Dashboard Template |
Dashboard Group |
36 |
Grouping object for organizing dashboards in a hierarchical structure. |
Dashboard, Dashboard Group, Dashboard Template |
Dashboard |
23 |
Customizable visualization panel displaying charts, maps, tables, and other widgets. Can contain nested dashboards. |
Dashboard, Dashboard Group |
Dashboard Template |
24 |
Dashboard template that applies dashboard layouts to target objects via auto-bind rules, similar to how data collection templates work. |
— |
Business Service Objects
These objects support service-level monitoring and SLA tracking. See SLA and Availability Monitoring.
| Class | Type ID | Description | Valid Children |
|---|---|---|---|
Business Service Root |
27 |
Abstract root of the business service tree. Created automatically during installation. |
Business Service, Business Service Prototype |
Business Service |
28 |
Models a business service for SLA and availability tracking. Status is calculated from check objects and child services. |
Business Service, Business Service Prototype |
Business Service Prototype |
15 |
Template for auto-creating business service instances via instance discovery (Agent List, Agent Table, or Script). |
— |
Object Type Constants
For use in NXSL scripts and object queries, see Object Type Constants in the Managing Objects page.