Difference between revisions of "UM:Objects"

From NetXMS Wiki
Jump to navigation Jump to search
m (Text replacement - "^" to "{{deprecated}}")
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Objects}}
{{deprecated}}Information moved to documentation:
= Overview =
All network infrastructure monitored by NetXMS inside monitoring system represented as a set of objects. Each object represents one physical or logical entity (like host or network interface), or group of them. Objects organized into hierarchical structure. There are 12 different object classes:
{| class="wikitable"
| Entire Network || Abstract object representing root of IP topology tree. All subnet objects located under it. System can have only one object of this class.
|-
| Subnet || Object representing IP subnet. Typically objects of this class created automatically by the system to reflect system's knowledge of IP topology.
|-
| Node || Object representing physical host or network device. These objects can be created either manually by administrator or automatically during network discovery process.
|-
| Cluster || Object representing cluster consisted of two or more hosts.
|-
| Interface || Object representing network interface of node. These objects created automatically by the system during configuration polls.
|-
| Network Service || Object representing network service running on a node (like http or ssh).
|-
| VPN Connector || Object representing VPN tunnel endpoint. Such objects can be created to add VPN tunnels to network topology known y NetXMS server.
|-
| Service Root || Abstract object representing root of your service tree. System can have only one object of this class.
|-
| Container || Grouping object which can contain nodes, subnets, clusters, conditions, or other containers. With help of container objects you can build object's tree which represents logical hierarchy of IT services in your organization.
|-
| Condition || Object representing complicated condition – like "cpu on node1 is overloaded and node2 is down for more than 10 minutes".
|-
| Template Root || Abstract object representing root of your template tree.
|-
| Template Group || Grouping object which can contain templates or other template groups.
|-
| Template || Data collection template. See Data Collection section for more information about templates.
|}


Every object has set of attributes; some of them are common (like id and name), while other depends on object class – for example, attribute "SNMP community string" have only node objects.
https://www.netxms.org/documentation/adminguide/object-management.html
 
= Top Level Objects =
NetXMS has three top level objects – '''Entire Network''', '''Service Root''', and '''Template Root'''. These objects served as an abstract root for appropriate object tree. The following table represents possible child object classes for top level objects:
{| class="wikitable"
|-
! Object !! Possible childs
|-
| Entire Network || Subnet
|-
| Service Root ||
* Container
* Subnet
* Node
* Cluster
* Condition
|-
| Template Root ||
* Template Group
* Template
|}
All top level objects has only one editable attribute – object's name.
 
= Subnet Objects =
Subnet objects represent IP subnets. These objects created automatically by NetXMS server to represent known IP topology. Subnet objects can only contain node objects. The system places node objects inside an appropriate subnet object based on an interface configuration. Subnet objects have only one editable attribute – an object's name.
 
= Container Objects =
Container objects (or simply containers) serve as building blocks for creating logical service hierarchy. Containers can have subnets, nodes, conditions, or other containers as child objects. Containers can be created in All Services tree. Existing nodes and subnets can be added to containers by using Bind operation, and removed by using Unbind operation.
 
= Node Objects =
= Interface Objects =
= Custom Attributes =

Latest revision as of 16:13, 13 September 2022

This Wiki is deprecated and we are are currrently migrating remaining pages into product documentation (Admin Guide, NXSL Guide)

Information moved to documentation:

https://www.netxms.org/documentation/adminguide/object-management.html