Object management

Object browser

Object browser organize all existing objects in hierarchical structure. 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. All top level objects has only one editable attribute – name.

Overall description about objects can be found in concepts part: Objects.

Properties

Object browser has next options:
  • Show filter CTRL+F2, that shows search line that has special syntaxes for search. Syntaxes description can be found there: Filters.
  • Show status indicator CTRL+F3
  • Hide unmanaged objects
  • Hide check templates. This option will not show Business Services templates.

Filters

Buy default search is done by node name. In this type of search can be used ‘*’ and ‘?’ symbols for pattern search.

But there are few prefix that can be used for other search options:
  • ‘/’ - will search in comments
  • ‘>’ - will search by IP address

Objects

Detailed information about objects, it’s usage, parents and childes can be found in concept chapter, Objects. In this section will be described only actions and properties that can be applied on different object classes.

Subnet

Property pages:

Except common properties subnets has Map Appearance and Trusted Nodes tabs. Map Appearance tab defines images that will be used to display this object on a Network Map and drill-down object (object that will be opened when double click on this object on Network Map). Trusted Nodes is used to define object list that have access to this object from the script.

Menu items:

Full subnet can be managed or unamanged. Management status will be applied to all subnet node. If subnet is deleted and is the only parent of a node, then node also will be deleted with the subnet. Upload file menu item will upload file from server to all nodes that have agent and have access to upload directory.

Under Tools menu are available predefined object tools that will be executed on each subnet node. More about object tool configuration can be found there: Object Tools.

Execute server script will open execute server script view. Were arbitrary script can be executed. Alarms menu item will open view with all subnet nodes’ alarms. And 802.1x port state will open table with port authentication states, that can be exported to CSV.

Node

Property pages:

Except common properties node has Communications tab that is responsible for communication options with this node(like host name, agent proxy and authentication, SNMP proxy and authentication and ICMP proxy), Polling tab is responsible for disabling pols for specific node, Location is used to configure location of the node, Map Appearance tab defines images that will be used to display this object on a Network Map and drill-down object (object that will be opened when double click on this object on Network Map).

Menu items:

Usually interfaces for nodes are created automatically by Configuration poll results, but they can be also created manually with help of menu item Create interface… This interface is a physical port is used just for information purposes.

_images/create_interface.png

Information about service monitoring and Create network service… menu item can be found there: Service monitoring.

When node is unmanaged/managed - all it’s childes like interfaces and service monitoring are also unmanaged/managed. In unmanaged state metrics are not collected and no pols are scheduled.

Node can be deleted from NetXMS by Delete menu item. Node is not deleted synchronously, but it is scheduled node deletion. While node deletion all data bout this node is also collected(like metrics).

If zones are enabled, then zone can be changed using Change zone… item. File manager will open agent file manager view. By default this view will be empty, to configure it refer to Agent file management chapter. Upload file can be used to upload file from server to node. This action can be applied simultaneously to all nodes.

Take screenshot for now halfway implemented functionality. For now screenshot can be taken only from Windows machines.

Description of Edit agent’s configuration functionality can be found in Edit configuration file remotely chapter.

Poll options:

Poll Name Description
Status  
Configuration  
Configuration (full)  
Instance discovery  
Instance names  
Topology  

Under Tools menu are available predefined object tools that will be executed on selected node. More about object tool configuration can be found there: Object Tools.

Execute server script will open execute server script view. Were arbitrary script can be executed. Node can be accessed with $node variable.

MIB Explorer will open MIB expolorer view. If geolocation of the node is set, then with help of Geolocation item can be opened map with shown on it object location. Software Inventory will show full software list for nodes with Windows systems or Linux systems(that used rpn or deb packages) and have NetXMS agent installed. Service Dependency will build tree from this node with all container where this node is included. Alarms will open alarm view with alarms only for this specific node.

Find switch port will open view with log of searchs of switch port that with witch this node is connected. Wile search we will check one by one interfaces and will show first successful result.

802.1x port state will open table with port authentication states, that can be exported to CSV.

Topology menu item contains all options of predefined network maps for this node and some other options:

Routing table IP route from… will build network map with route form selected node to node that is selected form Object selector window. IP route to… will build network map with route to selected node from node that is selected form Object selector window. IP Neighbors will show all IP neighbors of this node.

Switch forwarding database(MAC address table) VLANs Layer 2 Topology

Radio interface Wirless stations

Last values will open Last Values view. Data Collection Configuration will open Data Collection Configuration view, that is used to configure collected metrics from node.

Mobile Device

Mobile device objects are added manually. More information about required configuration to monitor mobile devices can be found there: Monitoring mobile devices.

Property pages:

Mobile Device object has only default property page configuration.

Menu items:

Each phone object can be managed/unmanaged and deleted. In umnanaged state metrics of this device are not collected and no pols are scheduled. When mobile object is deleted all it’s data is also deleted. No history data will be left.

Execute server script will open execute server script view. Were arbitrary script can be executed. Geolocation History will open view were will be shown history of displacement of this device. From the menu can be selected the period to show on history map. Geolocation will show last known location of this device. Alarms menu item will open view with all subnet nodes’ alarms.

Last values will open Last Values view. Data Collection Configuration will open Data Collection Configuration view, that is used to configure collected metrics from node.

Chassis

Rack

Rack is an object that should be used to visualize server room organization in NetXMS. Once rack object is created nodes can be assigned to rack, by selecting rack pbject, orientation, positon, high and front, rear immages for each Node, Chassis objects in properties of the object.

Cluster

Is created to display nodes logical organization in cluster. Cluster nodes may have shared resources and networks, processes may move between nodes, so metric collection should be organized accordingly. Cluster object provides option to aggregate collected data form cluster nodes. More about data aggregation can be found there: Data aggregation.

Besides default property pages cluster has also:
  • Cluster Resources - there can be configured IP resources of the cluster. Further on Cluster view of Object Details will be shown current owner of resources
  • Cluster Networks
  • Poling
  • Dashboards - there dashboard can be asociates with object, so on right click assocciated desboards will be displayed in the list
  • External Resources
  • Location
  • Map Appearance
  • Trusted Nodes

Intrface

Network Service

VPN Connector

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 set in object properties. 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.

Besides default property pages condition has also:
  • Events and Status, were can be set activation and deactivation events, shource of this objects and status of active and inactive condition.
  • Data, were can be set DCI’s that’s data will be given to a script for condition status calculation.
  • Script tab is used to write script that will calculate if condition should be activated or deactivated.
  • Map Appearance tab defines images that will be used to display this
    object on a Network Map and drill-down object (object that will be opened when double click on this object on Network Map).
  • Trusted Nodes is used to define object list that
    have access to this object from the script.

Menu items:

Condition can be mangedunmanaged. If condition is unmanaged, evaluation of condition is not run. Condition can be deleted.

Container

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. New nodes, conditions, clusters, containers, mobile devices and racks can also be created. They can be created using required menu item of container under witch this object should appear. Containers and nodes inside them can be moved by Move to another container menu item or using drag&drop.

Besides default property pages condition has also:
  • Automatic bind about this functionality can be found there
  • Location is used to configure location of the node
  • Map Appearance tab defines images that will be used to display this
    object on a Network Map and drill-down object (object that will be opened when double
click on this object on Network Map).
  • Trusted Nodes is used to define object list that
    have access to this object from the script.

Menu items:

There are special menu item for each object that can be created in container. Objects like rack, container, mobile device, cluster are manually created objects. Node can be manually created or found by network discovery. In case if it is required to add already existing object to container use Bind… menu item. To remove node from container, but do not delete it use Unbind… menu item.

Using Manage/Unmanage all nodes will be managed/unmanaged under container. Container can be deleted. If deleted container was the only one parent of the object, then this object will be also deleted. Upload file… will upload file from server to all nodes under container, same as each tool under Tools menu item will be executed on each node.

Execute server script will open execute server script view. Were arbitrary script can be executed. Geolocation will show location of container on geographic map.

Alarms will open alarm view with all active alarms for all children of this container. 802.1x port state will open table with port authentication states of all devices that are under this container. This information can be exported to CSV.

Automatic bind option

For each container can be configured automatic binding rules. This can be done in Automatic Bind Rules tab of container properties.

..figure:: _images/automatic_bind_rules.png

There can be defined if script should be used for automatic binding, if script should be used for node unbinding and can be written script it selves.

This script will be executed each configuration poll of each node.

Common object properties

General

Each object has General tab in properties. There can be checked object class and ID, and changed object name. Each object has unique ID in the system. Object can be accessed by this ID.

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, and select Properties ‣ Custom Attributes tab.

_images/object_custom_attributes.png

Status calculation

Each object has it’s own status calculation properties. By default status is calculated based on polling results, status of underlying objects, associated alarms and status DCIs. But there can be used different options of status calculation.

Status calculation has two configuration parts: status propagation and status calculation.

_images/object_status_calculation.png
For status propagation are available next options:
  • Default
  • Unchanged
  • Fixed value: Normal, Warning, Minor, Major, Fixed
  • Relative with offset
  • Severity based
For status calculation are available next options:
  • Default
  • Most critical
  • Single threshold (%)
  • Multiple thresholds

Comments

Each object in Object Tree can have comment. Comment can be set in Properties of the object.

_images/object_comments.png

Access control

Object access rights controls access to NetXMS objects. Permissions given to an object inherited by all child objects, unless specifically blocked by turning off Inherit access rights from parent object(s) option in object’s access control properties. Permissions given at different levels of the object tree summarize to form effective user rights for the object.

_images/object_acess_rights.png

The following object access rights can be granted:

Access Right Description
Access control Modify access control list for this object. Please note that user with this access right can grant any other access rights to own account.
Acknowledge alarms Acknowledge alarms with this object as source.
Control For node objects, execute object tools of type Remote Command.
Create child objects Create child objects (or bind existing) under this object.
Create helpdesk tickets Create ticket in external helpdesk system
Delete Delete this object.
Modify Modify object’s properties (except access control).
Push data Push data for DCIs on this object.
Read View object in the tree and read it’s information. For node objects, read access allows to view collected DCI data.
Send events Send events on behalf of this object.
Terminate alarms Terminate alarms with this object as source.
View alarms View alarms with this object as source.
Download file Allow user to download files from this node(from paths defined by filemng subagent). This access right is check also when download or tail of file is done from object tools.
Upload file Allow user to upload files to this node(from paths defined by filemng subagent)
Manage files Allow user to move, rename, delete files from this node(from paths defined by filemng subagent)

Object Details

Object details view provides main information about object. Each object has Overview tab that gisplays general information about object (like: ID, GUID, Class, and status of the object) and Comments.

Subnet

Object Tools

There can be created tools that will be executed on objects. Tools can be managed in “Object Tools” view. Tools are shown under “Tools” item of node menu. There are some predefined object tools:

_images/object_tools.png

If object tool should be removed for some time it can be just disabled and then enabled when required. When object tool is disabled it is not shown under “Tools” item of node menu. There is also common option to set image for each object tool in the tool properties.

Tool can have input fields, filder depending on execution object, macro substitution and personal access control configuration.

Object tool types

Internal

Commands that are defined in Management Console. The only command available for now is Wakeup node.

Agent Command

This tool will execute command on an agent node and will show it’s output if Command generates output option will be enabled.

_images/obj_tool_agent_command.png
Field name Description
Name Name that will be shown in node menu. Submenu can be created with “->” notation.
Description Description is shown in “Object Tools” view. Should be used to describe tool purpose.
Command Command name that should be executed on a agent node, this command should be defined in agent’s config. To this command can be given parameters in format: commandName param1 param2 param3...
Command generated output If this option is selected, then on command execution will be opened window with it’s output.
This tool requires confirmation before execution If chosen, before execution of tool will be shown Yes/No pop-up with text from “Confirmation message” field.
Confirmation message Can be set the message that will be shown in confirmation pop-up.
Show this tool in node commands If this option is selected, then this tool will be shown for applicable nodes on Object Details view as node command.
Command name This will be shown as a name of the command.
Command short name Is used when usual name is too long for display.
Disable Object Tool If chosen, tool is not shown in node menu.

SNMP Table

SNMP Table is used to get SNMP table from node on which it is executed and then show results in the table form.

_images/obj_tool_snmp_table.png
Field name Description
Name Name that will be shown in node menu. Submenu can be created with “->” notation.
Description Description is shown in “Object Tools” view. Should be used to describe tool purpose.
Title Title of view where table will be shown.
Use as index for second and subsequent columns OID suffix of first column This option defines that as suffix for columns OID’s to match lines will be used suffix of columns OID
Use as index for second and subsequent columns Value of first column This option defines that as suffix for columns OID’s to match lines will be used value of columns OID
This tool requires confirmation before execution If chosen, before execution of tool will be shown Yes/No pop-up with text from “Confirmation message” field.
Confirmation message Can be set the message that will be shown in confirmation pop-up.
Show this tool in node commands If this option is selected, then this tool will be shown for applicable nodes on Object Details view as node command.
Command name This will be shown as a name of the command.
Command short name Is used when usual name is too long for display.
Disable Object Tool If chosen, tool is not shown in node menu.

Agent Table

Agent Table is used to get agent list from node on which it is executed and then show results in the table form.

_images/obj_tool_agent_table.png
Field name Description
Name Name that will be shown in node menu. Submenu can be created with “->” notation.
Description Description is shown in “Object Tools” view. Should be used to describe tool purpose.
Title Title of view where table will be shown.
Parameter Name of list
Regular expression Regular expression that will parse each line of list to separate it on columns defined in Columns tab.
This tool requires confirmation before execution If chosen, before execution of tool will be shown Yes/No pop-up with text from “Confirmation message” field.
Confirmation message Can be set the message that will be shown in confirmation pop-up.
Show this tool in node commands If this option is selected, then this tool will be shown for applicable nodes on Object Details view as node command.
Command name This will be shown as a name of the command.
Command short name Is used when usual name is too long for display.
Disable Object Tool If chosen, tool is not shown in node menu.

URL

URL tool opens URL in web browser.

_images/obj_tool_url.png
Field name Description
Name Name that will be shown in node menu. Submenu can be created with “->” notation.
Description Description is shown in “Object Tools” view. Should be used to describe tool purpose.
URL URL that should be passed to browser to be opened.
This tool requires confirmation before execution If chosen, before execution of tool will be shown Yes/No pop-up with text from “Confirmation message” field.
Confirmation message Can be set the message that will be shown in confirmation pop-up.
Show this tool in node commands If this option is selected, then this tool will be shown for applicable nodes on Object Details view as node command.
Command name This will be shown as a name of the command.
Command short name Is used when usual name is too long for display.
Disable Object Tool If chosen, tool is not shown in node menu.

Local Command

Local Command tool will execute command on the local node and will show it’s output if Command generates output option will be enabled.

This tool type is not visible from Web Console as there is not possible to execute command on web page receiver’s machine.

_images/obj_tool_local_command.png
Field name Description
Name Name that will be shown in node menu. Submenu can be created with “->” notation.
Description Description is shown in “Object Tools” view. Should be used to describe tool purpose.
Command Command that should be executed on a local machine
Command generated output If this option is selected, then on command execution will be opened window with it’s output.
This tool requires confirmation before execution If chosen, before execution of tool will be shown Yes/No pop-up with text from “Confirmation message” field.
Confirmation message Can be set the message that will be shown in confirmation pop-up.
Show this tool in node commands If this option is selected, then this tool will be shown for applicable nodes on Object Details view as node command.
Command name This will be shown as a name of the command.
Command short name Is used when usual name is too long for display.
Disable Object Tool If chosen, tool is not shown in node menu.

Server Command

Server command tool can be used to execute command on a server.

_images/obj_tool_server_command.png
Field name Description
Name Name that will be shown in node menu. Submenu can be created with “->” notation.
Description Description is shown in “Object Tools” view. Should be used to describe tool purpose.
Command Command that should be executed on a server
Command generated output *Not yet implemented for server actions*
This tool requires confirmation before execution If chosen, before execution of tool will be shown Yes/No pop-up with text from “Confirmation message” field.
Confirmation message Can be set the message that will be shown in confirmation pop-up.
Show this tool in node commands If this option is selected, then this tool will be shown for applicable nodes on Object Details view as node command.
Command name This will be shown as a name of the command.
Command short name Is used when usual name is too long for display.
Disable Object Tool If chosen, tool is not shown in node menu.

Download File

Download file tool can be used to monitor agent logs. This tool will retrieve the content of the file from agent.

_images/obj_tool_get_file.png
Field name Description
Name Name that will be shown in node menu. Submenu can be created with “->” notation.
Description Description is shown in “Object Tools” view. Should be used to describe tool purpose.
Remote File Name Name of file that will be retrieved. In Windows systems should be with double back slash as a separator(C:\log\log.log). Can be used strftime(3C) macros
Limit initial download size Limits the size of download file. If is set not to 500 tool will retrieve last 500 bytes of requested file. If is set to 0, then will retrieve full file.
Follow file changes If chosen, “File View” will be updated when file will be populated with new data.
This tool requires confirmation before execution If chosen, before execution of tool will be shown Yes/No pop-up with text from “Confirmation message” field.
Confirmation message Can be set the message that will be shown in confirmation pop-up.
Show this tool in node commands If this option is selected, then this tool will be shown for applicable nodes on Object Details view as node command.
Command name This will be shown as a name of the command.
Command short name Is used when usual name is too long for display.
Disable Object Tool If chosen, tool is not shown in node menu.

Server Script

Server Script tool can be used to execute NXSL script form Script Librarry. This fool provide full renge of capabilities that are available thought NXSL scripting.

_images/obj_tool_script.png
Field name Description
Name Name that will be shown in node menu. Submenu can be created with “->” notation.
Description Description is shown in “Object Tools” view. Should be used to describe tool purpose.
Script Name of the script from the Script Library
Command generates output If chosen, new window with script execution result will be opened.
This tool requires confirmation before execution If chosen, before execution of tool will be shown Yes/No pop-up with text from “Confirmation message” field.
Confirmation message Can be set the message that will be shown in confirmation pop-up.
Show this tool in node commands If this option is selected, then this tool will be shown for applicable nodes on Object Details view as node command.
Command name This will be shown as a name of the command.
Command short name Is used when usual name is too long for display.
Disable Object Tool If chosen, tool is not shown in node menu.

Macro Substitution

Action, file download, local command, and URL tool types allows macro substitution. Any string starting with percent sign considered macro name and is expanded. The following macros recognized:

Macro Description
%a IP address of event source object.
%g Globally unique identifier (GUID) of event source object.
%i Unique ID of event source object in hexadecimal form. Always prefixed with 0x and contains exactly 8 digits (for example 0x000029AC).
%I Unique ID of event source object in decimal form.
%n Name of event source object.
%U User name of executer
%v NetXMS server’s version.
%[name] Value returned by script. You should specify name of the script from script library.
%{name} Value of custom attribute.
%(name) Value of input field.
%<name> Parameter with given name.
%% Insert % character.

If object tool called from alarm’s pop-up menu the following additional macros are available:

Macro Description
%A Alarm’s text (can be used only in actions to put text of alarm from the same event processing policy rule).
%c Event’s code.
%m Event’s message text (meaningless in event template).
%N Event’s name.
%s
Event’s severity code as number. Possible values are:
  • 0 - Normal
  • 1 - Warning
  • 2 - Minor
  • 3 - Major
  • 4 - Critical
%S Event’s severity code as text.
%y
Alarm state as number. Possible values are:
  • 0 - Outstanding
  • 1 - Acknowledged
  • 2 - Resolved
  • 3 - Terminated
%Y Alarm’s id.

Internal object tool is special case of object tools. Macro expansions not performed for Internal object tools.

For any unknown macro name system will try to read custom attribute with given name (attribute search is case sensitive). If attribute with given name not found, empty string will be inserted.

Properties

Filter

Filters are used to chose on witch nodes to show object tool. There are 5 types of filtering. Show object tool:

  1. if agent available on a node
  2. if node supports SNMP
  3. if node SNMP OID matches with provided string
  4. if nodes OS matches provided comma separated regular expression list
  5. if provided template name matches provided comma separated regular expression list
_images/obj_tool_filter.png

Access Control

In Access Control tab can be defined witch users or groups can execute this action. If no list will be empty - only administrator will be able to execute this action.

_images/obj_tool_access_control.png

Columns

Columns tab is used only for Agent Table and SNMP Table object tool types.

For SNMP Table it describes name and type of matching OID from response message.

_images/obj_tool_columns1.png
_images/obj_tool_columns2.png

Input fields

There is option to add input fields for object tool commands. This fields are defined on the Input fields view and added to command in %(name) format. More about formats can be found in Macro Substitution chapter.

Input field can be one of this types:

  • Text
  • Password
  • Number
_images/object_tools_input_fields.png

Predefined Object Tools

NetXMS is deviled with some predefined Object Tools. There is full list of them:

Name Type Description Filter
Connect‣Open web browser URL Open embedded web browser to node  
Connect->Open web browser (HTTPS) URL Open embedded web browser to node using HTTPS  
Info->Agent->Subagent list Agent Table Show list of loaded subagents NetXMS agent should be available
Info->Agent->Configured ICMP targets Agent Table Show list of actions supported by agent NetXMS agent should be available
Info->Agent->Supported actions Agent Table Show list of actions supported by agent NetXMS agent should be available
Info->Agent->Supported lists Agent Table Show list of lists supported by agent NetXMS agent should be available
Info->Agent->Supported parameters Agent Table Show list of parameters supported by agent NetXMS agent should be available
Info->Process list Agent Table Show list of currently running processes NetXMS agent should be available
Info->Routing table (SNMP) SNMP Table Show IP routing table NetXMS should support SNMP
Info->Switch forwarding database (FDB) SNMP Table Show switch forwarding database NetXMS should support SNMP
Info->Active user sessions Agent Table Show list of active user sessions NetXMS agent should be available
Info->ARP cache (Agent) Agent Table Show ARP cache NetXMS agent should be available
Info->Topology table (CDP) SNMP Table Show topology table (CDP) NetXMS should support SNMP
Info->Topology table (LLDP) SNMP Table Show topology table (LLDP) NetXMS should support SNMP
Info->Topology table (Nortel) SNMP Table Show topology table (Nortel protocol) NetXMS should support SNMP
Restart system Action Restart target node via NetXMS agent NetXMS agent should be available
Shutdown system Action Shutdown target node via NetXMS agent NetXMS agent should be available
Wakeup node Internal Wakeup node using Wake-On-LAN magic packet  
Restart agent Action Restart NetXMS agent on target node NetXMS agent should be available