Difference between revisions of "UM:Objects"

From NetXMS Wiki
Jump to navigation Jump to search
(Replaced content with "Information moved to documentation: https://www.netxms.org/documentation/userguide")
Line 1: Line 1:
{{DISPLAYTITLE:Objects}}
Information moved to documentation:
= Overview =


{{Objects}}
https://www.netxms.org/documentation/userguide
 
= Object Classes =
 
== Top Level Objects ==
 
NetXMS has eight top level objects – '''Entire Network''', '''Service Root''', '''Template Root''', '''Policy Root''', '''Network Map Root''', '''Dashboard Root''', '''Report Root''', and '''Business Service 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 ||
* Zone
* Subnet
|-
| Service Root ||
* Container
* Subnet
* Node
* Cluster
* Condition
|-
| Template Root ||
* Template Group
* Template
|-
| Policy Root ||
* Policy Group
* Policy
|-
| Network Map Root ||
* Network Map Group
* Network Map
|-
| Dashboard Root ||
* Dashboard
|-
| Report Root ||
* Report Group
* Report
|-
| Business Service Root ||
* Business Service
|}
All top level objects has only one editable attribute – object's name.
 
== Subnet ==
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 ==
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 '''Infrastructure Services''' tree. Existing nodes and subnets can be added to containers by using '''Bind''' operation, and removed by using '''Unbind''' operation.
 
== Condition ==
 
Conditions may represent more complicated status checks because each condition can have a script attached. Interval for evaluation of condition status is configured in [[Server Configuration Variables]] as ConditionPollingInterval with default value 60 seconds. Input values for the condition script can be added in the Data tab. Such values are accessible via $1, $2, ... variables inside the script. If the script returns 0, an activation event with the defined severity is created. If the script returns any other value, then a deactivation event is created.
 
== Node ==
 
Node objects (or ''nodes'') represent computers and other network-enabled devices (such as routers and switches) in your network. They have a lot of attributes controlling all aspects of interaction between NetXMS server and managed node. For example, the attributes specify what data must be collected, how node status must be checked, which protocol versions to use etc. Node objects contain one or more interface objects. The system creates interface objects automatically during configuration polls.
 
== Interface ==
Interface objects represent network interfaces of managed computers and devices. Usually these objects created automatically by management server during configuration polls.
 
== VPN Connector ==
 
VPN Connector objects are created manually. In case if there is a VPN connection linking two different networks open between two firewalls that are added to the system as objects, a user can create a VPN Connector object on each of the firewall objects and link one to another. The
network topology will now show that those two networks are connected and the system will take this condition into account during problem analysis and event correlation.
 
== Network Service ==
 
Network Service object is always created under a node and represents a network service (such as HTTP or SSH), which is accessible online (via TCP IP). Network Service objects are always created manually. When creating a new Network Service, a user has to set a protocol type for it.
Currently, the system works with the following protocols - HTTP, POP3, SMTP, Telnet, and SSH. In addition to that, it is also possible to define a Custom protocol type. For Custom protocol, a user should define the TCP port number and the system will be checking whether that port is available. For the predefined standard services the system will also check whether an appropriate response is returned. In case of SMTP, the system will send a test mail, in case of POP3 – try to log in with a certain user, in case of HTTP – check whether the contents of a desired web page correspond to a certain given template. As soon as the Network Service object is created, it will be automatically included into the status poll. Each time when the status poll for the particular node is carried out, all Network Service objects are polled for a reply. If an object's reply corresponds to a certain condition, its status is set as NORMAL. If an object is not responding, its status will be hanged to CRITICAL. For more information on object statuses and object status estimation, please refer to Object Status chapter.
 
== Template ==
 
Template object represents a template for data collection. For more information, please refer to [[UM:Data_Collection#Templates|Templates]] chapter.
 
== Template Group ==
 
Grouping object, which can contain templates or other template groups, in a form of template tree.
 
== Report ==
 
Creates a PDF document from data stored in database and a jasper report file controlling structure and formatting of the output. Example of jasper file can be downloaded from https://svn.netxms.org/public/netxms/trunk/reports/IP%20Inventory.jrxml. Jasper report file can be generated for example by [http://community.jaspersoft.com/project/ireport-designer iReport Designer].
 
Report functionality is not enabled by default due to licensing restrictions. See [[How to compile report-generator]] for detailed instructions.
 
= Object Status =
 
Each object has a status. Object's status can be one of the following:
 
{| class="wikitable"
|-
! Icon !! Text !! Description
|-
| [[File:status_normal.png]] || Normal || Object is in normal state.
|-
| [[File:status_warning.png]] || Warning || Warning(s) exist for the object.
|-
| [[File:status_minor.png]] || Minor || Minor problem(s) exist for the object.
|-
| [[File:status_major.gif]] || Major || Major problem(s) exist for the object.
|-
| [[File:status_critical.png]] || Critical || Critical problem(s) exist for the object.
|-
| [[File:status_unknown.png]] || Unknown || Object's status is unknown to the management server.
|-
| [[File:status_unmanaged.png]] || Unmanaged || Object is set to "unmanaged" state.
|-
| [[File:status_disabled.png]] || Disabled || Object is administratively disabled (only applicable to interface objects).
|-
| [[File:status_testing.png]] || Testing || Object is in testing state (only applicable to interface objects).
|}
 
Status of the object calculated based on polling results, status of underlying objects, and associated alarms. For some object classes, like Report or Template, status is irrelevant. Status of such objects is always "Normal".
 
= Access Control =
 
= Custom Attributes =
Every object can have custom attributes defined either by user or integrated application via NetXMS API. Custom attributes distinguished by names (an attribute name can contain up to 127 printable characters), and have string values of unlimited length. However, if you wish to access custom attributes in NXSL scripts as properties of node object, you should name them conforming to NXSL identifier naming constraints.
To create or change value of custom attribute manually, right-click object in NetXMS console, select "Properties", then select "Custom Attributes" tab.

Revision as of 16:04, 24 November 2017

Information moved to documentation:

https://www.netxms.org/documentation/userguide

Retrieved from "https://wiki.netxms.org/index.php?title=UM:Objects&oldid=1611"