Object management

Object browser

Object browser is a view in in Management Client. It presents all existing objects as a hierarchical structure. Overall description of objects can be found in concepts part: Objects.

Object browser options

Object browser has a number of options that define how object tree is displayed.

Object browser has following 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 children 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 unmanaged. 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 where 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: Network Service Monitoring.

When node is unmanaged/managed - all it’s children like interfaces and service monitoring are also unmanaged/managed. In unmanaged state metrics are not collected and no polls 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 explorer 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 rpm 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 searches of switch port to which a node is connected. During search the interfaces will be checked one by one and first successful result will be shown.

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 from selected node to node that was selected in Object selector window. IP route to… will build network map with route to selected node from node that was selected in 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 Wireless 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 unmanaged 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 where 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.

Rack

Rack is an object that visualizes server room organization in NetXMS. Node and chassis objects can be assigned to a rack in node properties, specifying position in the rack, height (number of occupied rack units), orientation (does it occupy full depth of the rack, or only present on front or back side of the rack). Front and/or rear images can be selected from Image library.

Rack visualization is available in Object Detail -> Rack view. Left click on a rack unit display a pop-up with brief information about the node or chassis. Right click will display node or chassis context menu. Double click on a chassis will open Chassis View in a separate tab.

Status of rack units is denoted with color rectangle on the left edge of the rack.

Chassis

Chassis is an object visualizing a rack-mount chassis that have plug-in modules. Chassis visualization is available in Object Detail -> Chassis view.

_images/chassis_example.png

Each node that represents chassis module can have an image that will be displayed atop of chassis image. Status of each node is denoted with color rectangle in the upper left corner or it’s image. Left click on node will display a pop-up with brief information about the node. Right click will display node context menu.

_images/chassis_module_image_properties.png

It is possible to configure the size of module’s image and it’s position on chassis image. Vertical size and position could be specified in mm or rack units (RU), while horizontal - in mm or horizontal pitch units (HP). Size calculation assumes that 1U chassis has 45mm height and 483mm width (including mounting brackets). Position (0, 0) is in the upper left corner.

You can use a graphic editor, e.g. Gimp to find position values in mm. Open chassis image in Gimp and set image width to 483 mm using Image -> Scale image. Now in the bottom left corner you can see current coordinates of mouse cursor in mm.

Chassis module images should be uploaded using Image Library Image library.

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 from 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 associated with object, so on right click associated dashboards will be displayed in the list

  • External Resources

  • Location

  • Map Appearance

  • Trusted Nodes

Interface

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, source 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 managed/unmanaged. 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 which 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 parent of an 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. Where an 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.

_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 an object in NetXMS client, and select Properties ‣ Custom Attributes tab.

_images/object_custom_attributes.png

Status calculation

Each object has it’s own status calculation properties. Status of an object calculated based on:

  • Polling results

  • Status of child objects (e.g. interfaces of node, nodes under container)

  • Active alarms, associated with the object (after an alarm is resolved or terminated, it no longer affects object status)

  • Value of status DCIs (DCI that has Use this DCI for node status calculation property enabled)

There are multiple options for status calculation that can be configured for specific objects or globally.

Status calculation has two configuration parts:

  • status propagation - the way how status from object is pushed to upper objects;

  • status calculation - the way how object is calculating it’s status based on statuses propagated by children objects. Once child object status is calculated most critical status is taken from status of underlying objects, associated alarms and status DCIs.

_images/object_status_calculation.png
For status propagation the following options are available:
  • Default - will take global configuration parameter (unchanged by default)

  • Unchanged - will propagate status value without changes

  • Fixed value: Normal, Warning, Minor, Major, Fixed - always will return fixed selected status

  • Relative with offset - will add or remove some number for

  • Severity based - will convert current status based on user configured status mapping table

For status calculation the following options are available:
  • Default - will take global configuration parameter (most critical by default)

  • Most critical - Most critical status will be taken

  • Single threshold (%) - Percentage of objects that should be in status to change status of object

  • Multiple thresholds - Same as previous but threshold is set for each status

Example of threshold status calculation

_images/object_status_threshold_example.png

Statuses of nodes in table:

Normal

Warning

Minor

Major

Critical

Node 1

1

0

0

0

0

Node 2

1

1

1

1

1

Node 3

1

1

0

0

0

Node 4

1

1

1

0

0

If “Single threshold (%)” option is selected and configuration is next:
  • 75%

In this case status of container will be Warning, as 3/4 of nodes have Warning status or worse.

If “Multiple thresholds” is selected and configuration is next:
  • Warning 80

  • Minor 50

  • Major 25

  • Critical 35

In this case status of Container will be Major as bot thresholds for Minor and Major are reached and most critical from them is taken.

Comments

Each object in Object Tree can have comment. Comment can be set in Properties of the object. It is possible to use macros for event processing in the comments.

_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

Read

View object in the tree and read it’s information. For node objects, read access allows to view collected DCI data.

Read agent data

Read SNMP data

Modify

Modify object’s properties (except access control).

Create child objects

Create child objects (or bind existing) under this object.

Delete

Delete this object.

Control

For node objects, execute object tools of type Remote Command.

Send events

Send events on behalf of this object.

View alarms

View alarms with this object as source.

Update alarms

Add comments to alarms, acknowledge alarms with this object as source.

Terminate alarms

Terminate alarms with this object as source.

Create helpdesk tickets

Create ticket in external helpdesk system

Push data

Push data for DCIs on this object.

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.

Download files

Allow user to download files from this node (from paths defined by filemngr subagent settings in agent configuration file). This access right is also checked when downloading or tail of file is done from object tools.

Upload files

Allow user to upload files to this node (to paths defined by filemngr subagent settings in agent configuration file).

Manage files

Allow user to move, rename, delete files on this node (in paths defined by filemngr subagent settings in agent configuration file).

Control maintenance mode

Take screenshot

Allow user to take screenshot of this node’s screen (Windows only).

Object Details

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

Subnet

Object Tools

It is possible to create tools for execution on objects or alarms. Configured object tools are available under Tools in object browser’s context menu or context menu of an alarm. A tool can ran a command on NetXMS server or node, obtain data from SNMP or NetXMS agent, etc…

Object tools can be executed on Containers in object browser - depending on configuration of specific object tool it will be executed in context of that container or will be executed for all objects under that container.

Tools can be managed in Configuration ‣ Object Tools. There are some predefined object tools that are available after installation of the system.

If an object tool is not needed 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 context menu. If an image (16x16 px) is configured for an object tool, it will be displayed next to object tool name in “Tools” menu.

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

Object tool types

Internal

The only operation available for now is wakeup that sends magic packet to wake up a node.

Agent Command

This tool will execute command on an agent node and will show it’s output if Command generates output option is 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

Name of agent command that will be executed. There is a number of commands built into agent and additional commands can be added by defining them in agent’s config. If command accepts parameters they are supplied it the following format: commandName param1 param2 param3...

Command generates output

If this option is selected then command execution will open a window with it’s output.

This tool requires confirmation before execution

If chosen a Yes/No pop-up with text from “Confirmation message” field will be shown before execution of tool.

Confirmation message

Contains 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

Name of the command

Command short name

Is used when Command name is too long for display.

Disable Object Tool

If chosen, tool is not shown in Object browser’s context menu and Commands in Object Details.

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 suffix of columns OID will be used as suffix for columns OID’s to match lines

Use as index for second and subsequent columns Value of first column

This option defines that value of columns OID will be used as suffix for columns OID’s to match lines

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 List

Agent List is used to get agent list from node on which it is executed and then show results in the table form. Regular expression is used to split received data to columns.

_images/obj_tool_agent_list.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’s 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.

Agent Table

Agent Table is used to get agent table 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

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.

Run in container context

If this option is selected, then tool will run only for selected container, not affecting children nodes.

Local Command

Local Command tool will execute command on the node, where Desktop Management Client is running and will show it’s output if Command generates output option is enabled.

This tool type is not visible from Web Client as it 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 command execution will open a window with output of the command.

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.

Run in container context

If this option is selected, then tool will run only for selected container, not affecting children nodes.

Server Command

Server command tool can be used to execute command on the 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

If this option is selected, then command execution will open a window with output of the command.

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.

Run in container context

If this option is selected, then tool will run only for selected container, not affecting children nodes.

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 to 500, tool will retrieve last 500 bytes of requested file. If is set to 0, complete file will be retrieved.

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 from Script Library. This tool provide full range 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.

Run in container context

If this option is selected, then tool will run only for selected container, not affecting children nodes.

Properties

Filter

Filters are used to chose on which 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 which users or groups can execute this action. If the list is empty, only administrator will be able to execute this action.

_images/obj_tool_access_control.png

Columns

Columns tab is used only for Agent List 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

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

IP address of event source object for use in URL. Expands into [addr] for IPv6 and addr for IPv4.

%U

User name of user that launched the object tool from user interface

%v

NetXMS server’s version.

%[name]

Value returned by script. You should specify name of the script from script library. It’s possible to specify script entry point separating it by /, e.g. to call a function named calculate: %[name/calculate]. Script parameters can be specified in brackets, e.g.: %[name(123,"A textual parameter")]

%{name}

Value of custom attribute.

%{name:default_value}

Value of custom attribute. If such custom attribute does not exists on a particular node, default_value is taken. If custom attribute exists, but has empty value, this empty value is taken.

%(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.

Predefined Object Tools

NetXMS is delivered with a number of predefined Object Tools. Here is the 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->Loaded subagents

Agent Table

Show information about loaded subagents

NetXMS agent should be available

Info->Agent->Configured ICMP targets

Agent Table

Show information about ICMP targets configured on this agent

NetXMS agent and ping subagent should be available

Info->Agent->Supported actions

Agent List

Show information about actions supported by agent

NetXMS agent should be available

Info->Agent->Supported lists

Agent List

Show list of lists supported by agent

NetXMS agent should be available

Info->Agent->Supported metrics

Agent List

Show list of metrics supported by agent

NetXMS agent should be available

Info->Agent->Supported tables

Agent List

Show list of tables supported by agent

NetXMS agent should be available

Info->Current processes

Agent Table

Show information about 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 List

Show information about active user sessions

NetXMS agent should be available

Info->ARP cache (Agent)

Agent List

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