netxms/netxms-doc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Agent configuration file parameters updated. Minor fixes.

Browse source
This commit is contained in:
Filipp Sudanov 2020-02-28 17:40:06 +02:00
parent 01bc450b09
commit 52eecd137b
24 changed files with 498 additions and 443 deletions
Download patch file Download diff file Expand all files Collapse all files

2
admin/advanced.rst
View file

@ -499,7 +499,7 @@ Requirements
Setup
-----
1. Download netxms-websvc-VERSION.war (example: netxms-websvc-2.2.15.war) file form http://www.netxms.org/download page.
1. Download netxms-websvc-VERSION.war (example: netxms-websvc-2.2.15.war) file from http://www.netxms.org/download page.
2. Copy the downloaded .war file to your web server.
3. Create a :file:`nxapisrv.properties` file and place it in the property file location of your
web server and specify the |product_name| Server address with the property.

56
admin/agent-management.rst
View file

@ -264,12 +264,12 @@ Agent Policies:
Agent Policies
==============
Agent policies are additional configuration created by user (agent configuration or files) that
are uploaded and updated on agent when template is manually or automatically applied on
Agent policies are additional configuration created by user (agent configuration or files) that
are uploaded and updated on agent when template is manually or automatically applied on
the node. Agent policies belong to templates, so they are applied to nodes to which a
corresponding template is applied.
corresponding template is applied.
To create policy, right click a template and select :menuselection:`Agent policies`. Click plus
To create policy, right click a template and select :menuselection:`Agent policies`. Click plus
icon to create a new policy, give it a name, choose correct policy type and
click :guilabel:`OK`. Existing policy can be modified by right-clicking it and
selecting :menuselection:`Edit` from the menu or by double clicking on it.
@ -303,8 +303,8 @@ database and issues necessary commands.
Agent configuration policy
--------------------------
Agent configuration policy provides option to populate agent configuration with additional
parts. Main agent configuration is merged with additional rules from policy.
Agent configuration policy provides option to populate agent configuration with additional
parts. Main agent configuration is merged with additional rules from policy.
Using policy for configuration file maintenance has advantages that configuration
is edited in centralized way and gives granular control on the configuration that each node gets.
More information about different agent configuration options can be found in above chapters.
@ -390,7 +390,7 @@ Example:
.. note:
File delivery policy uses :ref:`File Manager<agent_file_managment>` to uplad files
so :guilabel:`filemgr` subagnt should be loaded and root folders should be defined
so :guilabel:`filemgr` subagnt should be loaded and root folders should be defined
to provide write access to folders.
@ -613,9 +613,9 @@ Agent Proxy node configuration
In case it is required to monitor nodes behind firewall, it can be configured
access to one of subnet nodes and used this node as a proxy node for others.
Proxy node can be set while node creation or in :guilabel:`Communications` tab
Proxy node can be set during node creation or in :guilabel:`Communications` tab
of node properties. To configure proxy node select node in object selector
:guilabel:`|product_name| Agent Proxy`.
:guilabel:`NetXMS Agent Proxy`.
.. figure:: _images/create_node.png
@ -633,7 +633,7 @@ be set to :guilabel:`yes`.
Agent External Metrics
======================
Other option to define new Metric that can be collected form node is to use
Other option to define new Metric that can be collected from node is to use
``ExternalParameter``/``ExternalParameterShellExec``, or ``ExternalList``, or
``ExternalParametersProvider`` configuration parameters to define command that will
be executed on a node and it's output will be provided as a Metric. This functionality
@ -647,7 +647,7 @@ ExternalParameter/ExternalParameterShellExec
--------------------------------------------
``ExternalParameter`` defines name of the metric and command that is executed synchronously
when this metric is requested by server. There can be provided parameters form DCI
when this metric is requested by server. There can be provided parameters from DCI
configuration, that will be available like $1, $2, $3..., $9 variables. To accept
arguments metric name should contain "(*)" symbols after name. Only first line of
script output will be given as a result of execution(metric value).
@ -686,7 +686,7 @@ ExternalList
``ExternalList`` defines name of the list metric and command that is executed
synchronously when this metric is requested by server. There can be provided parameters
form DCI configuration, that will be available like $1, $2, $3..., $9 variables. To
from DCI configuration, that will be available like $1, $2, $3..., $9 variables. To
accept arguments metric name should contain "(*)" symbols after name. Lines of list
are separated with new line.
@ -700,23 +700,6 @@ are separated with new line.
# With DCI parameters
ExternalList=Name(*):command $1 $2
ExternalParameter
-----------------
``ExternalParameter`` defines name of the metric and command that is executed
synchronously when this metric is requested by server. There can be provided parameters
form DCI configuration, that will be available like $1, $2, $3..., $9 variables. To
accept arguments metric name should contain "(*)" symbols after name.
.. code-block:: cfg
# Example
# Without DCI parameters
ExternalParameter=Name:command
# With DCI parameters
ExternalParameter=Name(*):command $1 $2
ExternalParametersProvider
--------------------------
@ -724,9 +707,8 @@ ExternalParametersProvider
``ExternalParametersProvider`` defines command(script) and execution interval in seconds. Defined
script will be executed as per interval and agent will cache parameter list. When server
will request one of provided parameters it's value will be read from the agent cache.
Main purpose is to providing data from long-running processes, or return multiple
values at once. This approach can be also used for getting table database results in
parameter way(like columnName=value).
Main purpose is to provide data from long-running processes, or return multiple
values at once.
Script should print one or more "Parameter=Value" pairs to standard output. Multiple
pairs should be separated by new line. If parameter takes argument, it should be
@ -756,9 +738,15 @@ ExternalTable
-------------
``ExternalTable`` defines name of the table metric, table metric description, column separator,
instance column and command. Command is executed synchronously when this metric is requested by server.
instance column(s) and command. Instance column(s), descriptions and separator are optional.
If separator is not specified, default value of ``,`` is used.
Instance column should contain unique identifier for each table row. If several instance columns are used, then
combination of these columns should be unique. This is necessary for building graphs and for threshold violation event generation.
Command is executed synchronously when this metric is requested by server.
Each table line is separated with new line symbol. First line in returned text used as a name of the columns
and all next lines will be used like table data. There can be provided parameters form DCI configuration,
and all next lines will be used like table data. Parameters from DCI configuration can be provided,
that will be available like $1, $2, $3..., $9 variables. To accept arguments metric name should contain
"(*)" symbols after name.

136
admin/appendix.rst
View file

@ -109,21 +109,21 @@ Agent configuration file (nxagentd.conf)
- Description
- Default Value
* - Action
- Define action, which can be later executed by management server. To cation can
be given parameters from the server. They can be accessed as ``$1``, ``$2``...
variables.
- Define action, which can be later executed by management server.
Parameters to the action can be provided from the
server. They can be accessed as ``$1``, ``$2``... variables.
- No defaults
* - ActionShellExec
- Same as Action, but on Windows platform agent will use shell to execute command
instead of normal process creation. There is no difference between Action and
ActionShellExec on UNIX platforms.To cation can be given parameters from the
ActionShellExec on UNIX platforms. Parameters to the action can be provided from the
server. They can be accessed as ``$1``, ``$2``... variables.
- No defaults
* - AppAgent
- The registered name of application with built in subagent library that can be as subagent by agent.
- No defaults
* - AutoStartUserAgent
- Enable (yes) or disable (no) automatic start of User Agent (Windows only). If enabled, Agent will check on it's start and periodically afterwards, if User Agent is running in each user session and will start it if needed. For this to work, Agent should be started under local SYSTEM user.
- Enable (yes) or disable (no) automatic start of User Support Application (Windows only). If enabled, Agent will check on it's start, if User Support Application is running in each user session and will start it if needed. For this to work, Agent should be started under local SYSTEM user.
- no
* - BackgroundLogWriter
- Enable (yes) or disable (no) log writer as separate background thread. Has no effect if logging is done through syslog or Windows Event Log.
@ -166,6 +166,9 @@ Agent configuration file (nxagentd.conf)
* - EnableActions
- Enable (yes) or disable (no) action execution by agent.
- yes
* - EnableArbitraryCommandExecution
- Enables server to run any shell command on the agent without specifying it as action in agent's config file.
- no
* - EnabledCiphers
- Controls what ciphers agent can use for connection encryption. A value for this parameter is a cipher code. To enable more than one cipher, the codes should be summed up.
@ -182,9 +185,15 @@ Agent configuration file (nxagentd.conf)
**EnabledCiphers = 5**
- 63
* - EnableControlConnector
- Enables named pipe used by the agent to receive shutdown and delayed restart commands. A command is sent by another instance of agent, launched with -k or -K parameter. Used on Windows during upgrade process.
- yes
* - EnableProxy
- Enable (yes) or disable (no) agent proxy functionality.
- no
* - EnablePushConnector
- Enables named pipe / unix socket used by the agent to receive data sent by nxapush command line tool.
- yes
* - EnableSNMPProxy
- Enable (yes) or disable (no) SNMP proxy functionality.
- no
@ -194,18 +203,25 @@ Agent configuration file (nxagentd.conf)
* - EnableSubagentAutoload
- Enable (yes) or disable (no) automatic loading of subagent(s) depending on the platform on which the agent is running.
- yes
* - EnableSyslogProxy
- Enable (yes) or disable (no) Syslog proxy functionality.
- no
* - EnableTCPProxy
- Enable TCP proxy functionality that allows to forward TCP connections inside the connection between |product_name| server and agent.
An example utility called TcpProxyApp that forwards local ports is provided.
- no
* - EnableWatchdog
- Enable (yes) or disable (no) automatic agent restart in case of unexpected shutdown.
- no
* - ExecTimeout
- Timeout in milliseconds for external metric execution.
- 2000
* - ExternalMasterAgent
- ID that is checked when external subagent connects to master agent. Should have same value as ``ExternalSubagent`` parameter in external subagent configuration file.
- No defaults
* - ExternalList
- Add list handled by external command. To add multiple parameters, you should use multiple``ExternalList`` entries.
- No defaults
* - ExternalMasterAgent
- ID that is checked when external subagent connects to master agent. Should have same value as ``ExternalSubagent`` parameter in external subagent configuration file.
- No defaults
* - ExternalParameter
- Adds metric handled by external command. To add multiple parameters, you should use multiple ``ExternalParameter`` entries.
- No defaults
@ -214,7 +230,7 @@ Agent configuration file (nxagentd.conf)
agent will use shell to execute specified command instead of system process execution
API. This difference presented only on Windows system, on other systems
ExternalParameter and ExternalParameterShellExec behaves identically.
-
- No defaults
* - ExternalParametersProvider
- Adds list of metrics that are cached by the agent and returned to server per request. Metrics should be returned in *metric=value* format each pair in new line.
- No defaults
@ -224,25 +240,30 @@ Agent configuration file (nxagentd.conf)
* - ExternalSubagent
- ID of external subagent. Should be same as ``ExternalMasterAgent`` in master agent configuration file.
- No defaults
* - ExternalTable
- Adds table metric handled by external command. To add multiple parameters, you should use multiple ``ExternalTable`` entries.
See :ref:`agent-external-parameter` for more information.
- No defaults
* - FileStore
- Directory to be used for storing files uploaded by management server(s). It's value is set to environment variable NETXMS_FILE_STORE that is available to all processed launched by agent.
- :file:`/tmp` on UINX
- :file:`/tmp` on UNIX
:file:`C:\\` on Windows
* - FullCrashDumps
- Enable (yes) or disable (no) full crash dump generation. Windows only
- no
* - GroupId
- GroupId under which |product_name| agent is started (Unix only). See also ``UserId`` parameter.
- No defaults
* - ListenAddress
- IP address that the agent should listen on. If 0.0.0.0 or * is specified as listen address, agent will listen on all available IP addresses.
- 0.0.0.0
* - ListenPort
- TCP port to be used for incoming requests.
- 4700
* - LogFailedSQLQueries
- Enable (yes) or disable (no) failed SQL queries logging
- No
* - LogFile
- Agent's log file. To write log to syslog (or Event Log on Windows), use {syslog} as file name.
- {syslog}
- :file:`/var/log/nxagentd` on UNIX
:file:`{syslog}` on Windows
* - LogHistorySize
- Defines how many old log files should be kept after log rotation.
- 4
@ -258,6 +279,9 @@ Agent configuration file (nxagentd.conf)
* - LogUnresolvedSymbols
- If set to yes, all dynamically resolved symbols, which failed to be resolved, will be logged.
- no
* - LongRunningQueryThreshold
- Expressed in milliseconds. If a query to agent's local database or DBQuery subagent query takes longer then this time, the query will be logged to agent log file.
- 250
* - MasterServers
- List of management servers, which have full access to agent. Hosts listed in this group can upload files to agent and initiate agent upgrade, as well as perform any task allowed for hosts listed in Servers and ControlServers. Both IP addresses and DNS names can be used. Multiple servers can be specified in one line, separated by commas. If this parameter is used more than once, servers listed in all occurrences will have access to agent.
- Empty list
@ -267,6 +291,9 @@ Agent configuration file (nxagentd.conf)
* - MaxSessions
- Maximum number of simultaneous communication sessions. Possible value can range from 2 to 1024.
- 32
* - OfflineDataExpirationTime
- Applicable only if Agent Cache Mode is on. Defines the duration (in days) for how collected data will be stored in agent's database if there is no connection to NetXMS server.
- 10
* - PlatformSuffix
- String to be added as suffix to the value of ``System.PlatformName`` parameter.
- Empty string
@ -276,6 +303,9 @@ Agent configuration file (nxagentd.conf)
* - RequireEncryption
- If set to yes, a host connected to an agent will be forced to use encryption, and if encryption is not supported by a remote host, the connection will be dropped. If an agent was compiled without encryption support, this parameter has no effect.
- no
* - ServerConnection
- IP address or host name of |product_name| server for tunnel agent connection
- No defaults
* - Servers
- A list of management servers, which have read access to this agent. Both IP addresses and DNS names can be used. Multiple servers can be specified in one line, separated by commas. If this parameter is used more than once, servers listed in all occurrences will have access to agent.
- Empty list
@ -303,9 +333,33 @@ Agent configuration file (nxagentd.conf)
* - SubAgent
- Subagent to load. To load multiple subagents, you should use multiple SubAgent parameters. Subagents will be loaded in the same order as they appear in configuration file.
- No defaults
* - SyslogListenPort
- Listening port number for syslog proxy functionality.
- 514
* - SystemName
- If tunnel agent connection is used, the system appears in :guilabel:`Agent Tunnel Manager` under that name.
- ``localhost`` is used by default
* - TunnelKeepaliveInterval
- Interval (in seconds) between keepalive packets over tunnel agent connection.
- 30
* - UserAgentExecutable
- Name of User Support Application executable used by AutoStartUserAgent and UserAgentWatchdog parameters.
- nxuseragent.exe
* - UserAgentWatchdog
- Enable (yes) or disable (no) automatic restart of User Support Application (Windows only). If enabled, Agent will check once per minute, if User Support Application is running in each user session and will start it if needed. For this to work, Agent should be started under local SYSTEM user.
- no
* - UserId
- Username under which |product_name| agent is started (Unix only). See also ``GroupId`` parameter.
- No defaults
* - WaitForProcess
- If specified, an agent will pause initialization until given process starts.
- No defaults
* - WriteLogAsJson
- Enable (yes) or disable (no) writing log file in JSON format.
- no
* - ZoneUIN
- Allows to set agent's zone explicitly. This can be useful when agent forwards syslog or SNMP traps of devices, that belong to a particular zone. Agent will include zone UIN along with the trap message that will allow correct matching of traps.
- No defaults
.. note::
All boolean parameters understand "Yes/No", "On/Off" and "True/False" values.
@ -380,12 +434,6 @@ Server configuration file (netxmsd.conf)
* - ListenAddress
- Interface address which should be used by server to listen for incoming connections. Use value 0.0.0.0 or * to use all available interfaces.
- 0.0.0.0
* - LogFailedSQLQueries
- Control logging of failed SQL queries. Possible values: yes or no.
- yes
* - LogFailedSQLQueries
- Enable (yes) or disable (no) failed SQL queries logging
- No
* - LogFile
- Server's log file. To write log to syslog (or Event Log on Windows), use {syslog} as file name.
- {syslog}
@ -448,7 +496,7 @@ These parameters can be changed in
- 2000
- Yes
* - AgentDefaultSharedSecret
- String that will be used as a shared secret in case if agent will required authentication.
- String that will be used as a shared secret in case if agent will require authentication.
- netxms
- No
* - AgentUpgradeWaitTime
@ -732,14 +780,26 @@ These parameters can be changed in
- Interval of housekeeper'a running (in seconds). Housekeeper deletes old log lines, old DCI data, cleans removed objects and does VACUUM for PostgreSQL.
- 3600
- Yes
* - IcmpPingSize
* - ICMP.CollectPollStatistics
- Collect ICMP poll statistics for all nodes by default. See :ref:`icmp-ping` chapter for information.
- 1
- No
* - ICMP.PingSize
- Size of ICMP packets (in bytes, excluding IP header size) used for status polls.
- 46
- Yes
* - IcmpPingTimeout
* - ICMP.PingTimeout
- Timeout for ICMP ping used for status polls (in milliseconds).
- 1500
- Yes
* - ICMP.PollingInterval
- Interval between ICMP statistic collection polls (in seconds)
- 60
- No
* - ICMP.StatisticPeriod
- Time period for collecting ICMP statistics (in number of polls).
- 60
- No
* - InternalCA
- Enable (1) or disable (0) internal certificate authority.
- 0
@ -1105,11 +1165,11 @@ These parameters can be changed in
- http://www.netxms.org/download/netxms-%version%.exe
- No
* - XMPPLogin
- Login name that will be used to authentication on XMPP server.
- Login name that will be used for authentication on XMPP server.
- netxms@localhost
- Yes
* - XMPPPassword
- Password that will be used to authentication on XMPP server.
- Password that will be used for authentication on XMPP server.
- netxms
- Yes
* - XMPPPort
@ -1285,7 +1345,7 @@ Syntax:
nxget [options] host [parameter [parameter ...]]
Where *host* is the name or IP address of the host running NetXMS agent; and
Where *host* is the name or IP address of the host running |product_name| agent; and
*parameter* is a parameter or a list name, depending on given options. By default,
nxget will attempt to retrieve the value of one given parameter, unless given
options override it.
@ -2099,7 +2159,7 @@ Data type: Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Network interface administrative status (1 = enabled, 2 = disabled, 3 = testing)
@ -2112,7 +2172,7 @@ Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of input bytes on interface
@ -2125,7 +2185,7 @@ Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of output bytes on interface
@ -2138,7 +2198,7 @@ Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Description of interface
@ -2151,7 +2211,7 @@ Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of input errors on interface
@ -2164,7 +2224,7 @@ Data type: Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Link status of interface
@ -2177,7 +2237,7 @@ Data type: Integer
Supported Platforms: Windows, AIX, HP-UX
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Net.Interface.OperStatus(*)
@ -2188,7 +2248,7 @@ Data type: Integer
Supported Platforms: Windows, Linux, Solaris, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Network interface operational status (0 = down, 1 = up)
@ -2201,7 +2261,7 @@ Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of output errors on interface
@ -2214,7 +2274,7 @@ Data type: UInt32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of input packets on interface
@ -2227,7 +2287,7 @@ Data type: UInt32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of output packets on interface
@ -2240,7 +2300,7 @@ Data type: UInt32
Supported Platforms: Windows, Solaris, AIX, HP-UX
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Net.IP.Forwarding

8
admin/data-collection.rst
View file

@ -95,7 +95,7 @@ Origin
Origin of data (method of obtaining data). Possible origins are:
- :guilabel:`|product_name| agent`
- :guilabel:`NetXMS agent`
- :guilabel:`SNMP agent`
- :guilabel:`CheckPoint SNMP agent`
- :guilabel:`Windows Performance Counter`
@ -144,7 +144,7 @@ significant increase of your database size and possible performance degradation.
Can be selected one of options:
- :guilabel:`Fixed intervals (default)` - default value will be taken form :guilabel:`DefaultDCIPollingInterval` server configuration parameter.
- :guilabel:`Fixed intervals (default)` - default value will be taken from :guilabel:`DefaultDCIPollingInterval` server configuration parameter.
- :guilabel:`Fixed intervals (custom)` - value entered on the DCI properties page will be taken.
- :guilabel:`Use advanced scheduling` - schedules configured in :guilabel:`Advanced Schedule` page will be used
@ -160,7 +160,7 @@ degradation.
Possible options:
- :guilabel:`Use default retention time` - default value will be taken form :guilabel:`DefaultDCIRetentionTime` server configuration parameter.
- :guilabel:`Use default retention time` - default value will be taken from :guilabel:`DefaultDCIRetentionTime` server configuration parameter.
- :guilabel:`Use default retention time` - value entered on the DCI properties page will be taken.
- :guilabel:`Do not save collected data to database` - will not save collected data to database, but will store last value in memory
@ -220,7 +220,7 @@ Data aggregation
~~~~~~~~~~~~~~~~
This section is responsible for cluster data aggregation way.
:guilabel:`Aggregate values from cluster nodes` option means, that DCI form cluster
:guilabel:`Aggregate values from cluster nodes` option means, that DCI from cluster
will be collected on each node separately and aggregated on cluster using one of the
aggregation options.

2
admin/database-monitoring.rst
View file

@ -832,7 +832,7 @@ Configuration file
Parameters
----------
There are 2 types of parameters: serverStatus parameters, that are generated form response on a subagent start
There are 2 types of parameters: serverStatus parameters, that are generated from response on a subagent start
and predefined for database status.
Description of serverStatus parameters can be found there: `serverStatus <http://docs.mongodb.org/manual/reference/command/serverStatus/>`_.

4
admin/grafana-integration.rst
View file

@ -5,7 +5,7 @@ Grafana integration
###################
|product_name| Grafana integration provides the possibility to display important data using
the Grafana platform and the :ref:`|product_name| WebAPI <rest-api>`.
the Grafana platform and the :ref:`NetXMS WebAPI <rest-api>`.
Integration with Grafana
========================
@ -29,7 +29,7 @@ See https://grafana.com/plugins/radensolutions-netxms-datasource/installation
For installation from source:
1. Clone the |product_name| Grafana datasource GitHub repository from https://github.com/netxms/grafana.
2. Copy the files from the repository to :file:`GRAFANA_HOME/data/plugins/datasources/|product_name|`
2. Copy the files from the repository to :file:`GRAFANA_HOME/data/plugins/datasources/netxms`
3. Restart your Grafana server.
4. Login to your Grafana web interface and add the |product_name| datasource in the Data Sources section.

28
admin/icmp-ping.rst
View file

@ -4,6 +4,22 @@
ICMP ping
=========
The following options exist to monitor systems using ICMP pings:
* ICMP response statistic collection
* Metrics provided by ping subagent
ICMP response statistic collection
==================================
Ping subagent
=============
This subagent can be used to measure ICMP ping response times from one location to another.
Measurements can be either scheduled by the agent itself or requested by the server.
@ -25,7 +41,7 @@ Metrics available on request:
Automatic configuration of targets
Metrics
=======
-------
When loaded, PING subagent adds the following parameters to agent:
@ -38,8 +54,8 @@ When loaded, PING subagent adds the following parameters to agent:
| Icmp.LastPingTime(*target*) | Last ICMP ping response time from *target*. Argument *target* can be either IP address or name |
| | specified in Target configuration record (see below). |
+-----------------------------------------+-----------------------------------------------------------------------------------------------------+
| Icmp.PacketLoss(*target*) | ICMP ping packet loss (in percents) for *target*. Argument *target* can be either IP address or |
| | name specified in Target configuration record (see below). |
| Icmp.PacketLoss(*target*) | ICMP ping packet loss (in percents) for *target* for last minute. Argument *target* can be either |
| | IP address or name specified in Target configuration record (see below). |
+-----------------------------------------+-----------------------------------------------------------------------------------------------------+
| Icmp.Ping(*target*, *timeout*, *psize*) | ICMP ping response time from *target*. Agent will send echo request as soon as it receives |
| | request for parameter's value, and will return response time for that particular request. Argument |
@ -61,7 +77,7 @@ When loaded, PING subagent adds the following parameters to agent:
Tables
======
------
+-----------------+---------------------------------------------+
| Table | Description |
@ -79,7 +95,7 @@ Tables
+-----------------+---------------------------------------------+
Lists
=====
-----
+-----------------+---------------------------------------+
| List | Description |
@ -88,7 +104,7 @@ Lists
+-----------------+---------------------------------------+
Configuration file
==================
------------------
All configuration parameters related to PING subagent should be placed into **[PING]** section of agent's configuration file.
The following configuration parameters are supported:

8
admin/installation.rst
View file

@ -343,7 +343,7 @@ Desktop Management Console:
nxmc-VERSION-win32-x64.zip, for example nxmc-1.2.17-win32-x64.zip).
2. Extract zip in preferred directory.
3. Run nxmc file form extracted catalog.
3. Run nxmc file from extracted catalog.
Web Management Console:
@ -382,7 +382,7 @@ file already exists or if /CENTRALCONFIG option is used. These options are follo
* - /CONFIGENTRY=value
- It can be used to add any parameter to configuration file during initial install. You can specify it multiple times to add multiple lines. Section names can be added as well.
* - /DIR=path
- Set installation directory (default is C:\|product_name|)
- Set installation directory (default is C:\NetXMS)
* - /LOCALCONFIG
- Use local configuration file (it is the default)
* - /LOG
@ -419,7 +419,7 @@ Agent
-----
To install Android agent download netxms-mobile-agent-VERSION.apk (example:
netxms-mobile-agent-1.2.17.apk) file form http://www.netxms.org/download page.
netxms-mobile-agent-1.2.17.apk) file from http://www.netxms.org/download page.
Check that installation of applications from unknown sources is allowed in security
settings of your phone. Run this installer on required device.
@ -438,7 +438,7 @@ Console
-------
To install Android console download netxms-console-VERSION.apk (example:
netxms-console-1.2.17.apk) file form http://www.netxms.org/download page. Check that
netxms-console-1.2.17.apk) file from http://www.netxms.org/download page. Check that
installation of applications from unknown sources is allowed in security settings of
your phone. Run this installer on required device.

10
admin/object-management.rst
View file

@ -166,10 +166,10 @@ exported to CSV.
node and some other options:
:guilabel:`Routing table`
:guilabel:`IP route from...` will build network map with route form selected node to
node that is selected form Object selector window.
:guilabel:`IP route from...` will build network map with route from selected node to
node that was selected in Object selector window.
:guilabel:`IP route to...` will build network map with route to selected node from
node that is selected form Object selector window.
node that was selected in Object selector window.
:guilabel:`IP Neighbors` will show all IP neighbors of this node.
:guilabel:`Switch forwarding database(MAC address table)`
@ -228,7 +228,7 @@ 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
be organized accordingly. Cluster object provides option to aggregate collected data from
cluster nodes. More about data aggregation can be found there: :ref:`data-agregation`.
Besides default property pages cluster has also:
@ -370,7 +370,7 @@ status :term:`DCIs<DCI>`. But there can be used different options of status calc
Status calculation has two configuration parts:
- status propagation - the way how status form object is pushed to upper objects;
- 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 :term:`DCIs<DCI>`.
.. figure:: _images/object_status_calculation.png

298
admin/quickstart.rst
View file

@ -5,8 +5,8 @@
Quick start
###########
In this section will be described basic configuration that should be done
after server and agent clean install. Also will be shown monitoring configuration
In this section will be described basic configuration that should be done
after server and agent clean install. Also will be shown monitoring configuration
for some common metrics like CPU of FS.
Default Credentials
@ -21,25 +21,25 @@ Password: netxms
Basic agent configuration
=========================
Minimal configuration that should be set for agent is server address and path
to log file. Action differ depending on a platform where agent is installed.
On Windows systems configuration file is automatically generated and populated
by installer, on UNIX systems it should be created/edited manually.
Minimal configuration that should be set for agent is server address and path
to log file. Action differ depending on a platform where agent is installed.
On Windows systems configuration file is automatically generated and populated
by installer, on UNIX systems it should be created/edited manually.
Minimal required configuration is done for agent.
Minimal required configuration is done for agent.
Windows
-------
In case if while installation MasterServer was set correctly no action is
required form user.
In case if while installation MasterServer was set correctly no action is
required from user.
Automatically generated configuration file can be found there:
Automatically generated configuration file can be found there:
:file:`installation directory\\etc\\nxagentd.conf`.
Configuration file for Windows should look like this:
.. code-block:: cfg
.. code-block:: cfg
#
# Sample agent’s configuration file
@ -53,7 +53,7 @@ UNIX/Linux
After agent is installed on a UNIX/Linux system it is required to create/edit file
:file:`/etc/nxagentd.conf`. This file should contain at least this information:
.. code-block:: cfg
.. code-block:: cfg
#
# Sample agent’s configuration file
@ -65,29 +65,29 @@ After agent is installed on a UNIX/Linux system it is required to create/edit fi
Basic server tuning
===================
Server has 2 types of configuration: configuration file parameters and server
Server has 2 types of configuration: configuration file parameters and server
configuration variables.
For server configuration file minimal requirements are path to log file, database
driver name and all required credentials depending on database. Location and
required actions depends on what OS is used. More about OS specific configuration
search in OS subsections of this chapter.
For server configuration file minimal requirements are path to log file, database
driver name and all required credentials depending on database. Location and
required actions depends on what OS is used. More about OS specific configuration
search in OS subsections of this chapter.
List of possible database drivers:
List of possible database drivers:
* db2.ddr
* informix.ddr
* mssql.ddr
* informix.ddr
* mssql.ddr
* mysql.ddr Driver for MySQL database.
* odbc.ddr ODBC connectivity driver (you can connect to MySQL, PostgreSQL, MS SQL, and Oracle via ODBC).
* oracle.ddr Driver for Oracle database.
* pgsql.ddr Driver for PostgreSQL database.
* sqlite.ddr Driver for embedded SQLite database.
There are quite a few important server parameters to be set right after installation.
These parameters are accessible through the :guilabel:`Server Configuration` window
in the console. To open it, click on :menuselection:`Configuration --> Server Configuration`.
To edit a setting, double click on the row in the table or right-click and select
There are quite a few important server parameters to be set right after installation.
These parameters are accessible through the :guilabel:`Server Configuration` window
in the console. To open it, click on :menuselection:`Configuration --> Server Configuration`.
To edit a setting, double click on the row in the table or right-click and select
:guilabel:`Edit`. The following parameters may need to be changed:
.. tabularcolumns:: |p{0.4 \textwidth}|p{0.6 \textwidth}|
@ -95,22 +95,22 @@ To edit a setting, double click on the row in the table or right-click and selec
================================ ==============================================
Parameter Description
================================ ==============================================
``PollerThreadPoolMaxSize`` This parameter represents maximum thread pool
size. From this pool will be taken threads for
all types of polls: Status
poll, Configuration poll, etc. In case of
big load on a server number of threads will be
increased till this size. When load come back
to normal, number of threads will be
``PollerThreadPoolMaxSize`` This parameter represents maximum thread pool
size. From this pool will be taken threads for
all types of polls: Status
poll, Configuration poll, etc. In case of
big load on a server number of threads will be
increased till this size. When load come back
to normal, number of threads will be
automatically decreased to base size.
If you plan to monitor large number of hosts
increase this parameter from the default value
to approximately 1/5 of host count.
``PollerThreadPoolBaseSize`` This parameter represents base thread pool
size. From this pool will be taken threads for
all types of polls: Status
poll, Configuration poll, etc. This is minimal
number of threads that will always run.
``PollerThreadPoolBaseSize`` This parameter represents base thread pool
size. From this pool will be taken threads for
all types of polls: Status
poll, Configuration poll, etc. This is minimal
number of threads that will always run.
If you plan to monitor large number of hosts
increase this parameter from the default value
to approximately 1/10 of host count.
@ -122,21 +122,21 @@ Parameter Description
enable |product_name| built-in syslog server.
================================ ==============================================
Minimal required configuration is done for server.
Minimal required configuration is done for server.
Windows
-------
For Windows systems this information is added to configuration file while
installation procedure. It can be check that all data was set correctly
in this file: :file:`'installation directory'\\etc\\nxagentd.conf'`.
For Windows systems this information is added to configuration file while
installation procedure. It can be check that all data was set correctly
in this file: :file:`'installation directory'\\etc\\netxmsd.conf`.
Example of sample Windows configuration for mysql:
.. code-block:: cfg
.. code-block:: cfg
#
# Sample configuration file for |product_name| server
# Sample server configuration file
#
DBDriver = mysql.ddr
@ -144,37 +144,35 @@ Example of sample Windows configuration for mysql:
DBName = netxms_db
DBLogin = netxms
DBPassword = password
LogFailedSQLQueries = yes
LogFile = {syslog}
UNIX/Linux
----------
For UNIX based systems :file:`/etc/netxmsd.conf` file should be
created/populated manually.
For UNIX based systems :file:`/etc/netxmsd.conf` file should be
created/populated manually.
Configuration file example for oracle database:
.. code-block:: cfg
.. code-block:: cfg
DBDriver = oracle.ddr
DBServer = ServerIP/Hostname.DomainName #Here is service (full database name), not SID
DBName = netxms
DBLogin = netxms
DBPassword = PaSwD
LogFailedSQLQueries = yes
LogFile = /var/log/netxmsd
SMTP
====
SMTP configuration is done to create actions that will send e-mails on
defined events. This configuration is done through the
:guilabel:`Server Configuration` window in the console. To open it, click
on :menuselection:`Configuration --> Server Configuration`. To edit a
setting, double click on the row in the table or right-click and select
SMTP configuration is done to create actions that will send e-mails on
defined events. This configuration is done through the
:guilabel:`Server Configuration` window in the console. To open it, click
on :menuselection:`Configuration --> Server Configuration`. To edit a
setting, double click on the row in the table or right-click and select
:guilabel:`Edit`. The following parameters may need to be changed:
.. tabularcolumns:: |p{0.4 \textwidth}|p{0.6 \textwidth}|
@ -182,90 +180,90 @@ setting, double click on the row in the table or right-click and select
================================ ==============================================
Parameter Description
================================ ==============================================
``SMTPFromAddr`` Address that will be shown as a sender address
``SMTPFromAddr`` Address that will be shown as a sender address
when notification from |product_name| will come.
``SMTPFromName`` Name that will be shown as a sender name
``SMTPFromName`` Name that will be shown as a sender name
when notification from |product_name| will come.
``SMTPRetryCount`` Number of retries that |product_name| will try to do
in case if message sending will fail.
``SMTPServer`` Server IP address or DNS name where |product_name|
will send request for message dispatch.
================================ ==============================================
``SMTPRetryCount`` Number of retries that |product_name| will try to do
in case if message sending will fail.
``SMTPServer`` Server IP address or DNS name where |product_name|
will send request for message dispatch.
================================ ==============================================
.. _quick_start_credentials_SNMP:
SNMP Defaults
=============
For :term:`SNMP` can be configured some default values for authorization. It is
required if you will have many :term:`SNMP` devices with similar credentials.
For :term:`SNMP` can be configured some default values for authorization. It is
required if you will have many :term:`SNMP` devices with similar credentials.
This information is set on :guilabel:`Network Discovery` view.
This information is set on :guilabel:`Network Discovery` view.
SNMP Communities
----------------
In this section you can add SNMP community strings to be tested during
connection to the SNMP device that requires authorization.
connection to the SNMP device that requires authorization.
SNMP USM Credentials
--------------------
In this section you can add SNMP version 3 credentials to be tested during
connection to the SNMP device that requires authorization.
connection to the SNMP device that requires authorization.
Actions and Alarms
==================
In this section will be shown how to configure alarm and email notifications
generation on predefined SYS_THRESHOLD_REACHED event. And alarm resolve on
SYS_THRESHOLD_REARMED event.
In this section will be shown how to configure alarm and email notifications
generation on predefined SYS_THRESHOLD_REACHED event. And alarm resolve on
SYS_THRESHOLD_REARMED event.
First it should be created :guilabel:`Send E-Mail` action in
:guilabel:`Action Configuration` view. There we will set recipient of e-mail,
subject and body of e-mail. In body of e-mail will be used
:ref:`event-processing-macros`. It means that when message will be sent, macros
"%n" will be substituted with name of the node and "%m" will be substituted with
event message. Value of event message is personal for each event and can be found in
event description.
First it should be created :guilabel:`Send E-Mail` action in
:guilabel:`Action Configuration` view. There we will set recipient of e-mail,
subject and body of e-mail. In body of e-mail will be used
:ref:`event-processing-macros`. It means that when message will be sent, macros
"%n" will be substituted with name of the node and "%m" will be substituted with
event message. Value of event message is personal for each event and can be found in
event description.
.. figure:: _images/send_email_action.png
Next step is to add processing policies. It is done in
:guilabel:`Event Processing Policy` view. We will add this rules before all other rules
as it it is planed that this rules will be most commonly used ones.
Next step is to add processing policies. It is done in
:guilabel:`Event Processing Policy` view. We will add this rules before all other rules
as it it is planed that this rules will be most commonly used ones.
It should be added rule that will send email and create Alarm on SYS_THRESHOLD_REACHED
rule from any node. In alarm message is added key that will be used in alarm
resolve. Key is combined from text id "SYS_THRESHOLD_REACHED\ _", id of DCI and
ID of node. This should be enough to resolve correct alarm. After that should be
created one more rule for alarm resolve with the same key as for alarm creation.
After all configuration is done :guilabel:`Event Processing Policy` view should be
saved.
It should be added rule that will send email and create Alarm on SYS_THRESHOLD_REACHED
rule from any node. In alarm message is added key that will be used in alarm
resolve. Key is combined from text id "SYS_THRESHOLD_REACHED\ _", id of DCI and
ID of node. This should be enough to resolve correct alarm. After that should be
created one more rule for alarm resolve with the same key as for alarm creation.
After all configuration is done :guilabel:`Event Processing Policy` view should be
saved.
.. figure:: _images/quickstart_epp.png
Passive discovery
=================
It is recommended to enable passive discovery when it is required to add all nodes
in local network. In case if |product_name| server has access to switches and routers
via SNMP, all devices in network will be added automatically by discovery process.
It is recommended to enable passive discovery when it is required to add all nodes
in local network. In case if |product_name| server has access to switches and routers
via SNMP, all devices in network will be added automatically by discovery process.
To enable passive network discovery open :guilabel:`Network Discovery` view.
There in :guilabel:`General` section select :guilabel:`Passive only` option and
check that all default SNMP credentials are set as described in
:ref:`quick_start_credentials_SNMP` section. Other options that can be set
To enable passive network discovery open :guilabel:`Network Discovery` view.
There in :guilabel:`General` section select :guilabel:`Passive only` option and
check that all default SNMP credentials are set as described in
:ref:`quick_start_credentials_SNMP` section. Other options that can be set
depending on requirements:
* Option to use SNMP trap source for further network discovery
* Option to set filer that will define rules for not adding nodes to
* Option to set filer that will define rules for not adding nodes to
|product_name| server
In our configuration we will not use filter to add all node available on our
network and turn on option to use SNMP trap source address for discovery.
After all configuration is done remember to save it.
In our configuration we will not use filter to add all node available on our
network and turn on option to use SNMP trap source address for discovery.
After all configuration is done remember to save it.
Notes
-----
@ -282,9 +280,9 @@ Please note that for successful network discovery your network must meet the
following requirements:
- |product_name| server must have access to switches and routers via SNMP.
- All your network devices credentials(community string and password for v3)
should be added to default credential list in :guilabel:`Network Discovery`
view.
- All your network devices credentials(community string and password for v3)
should be added to default credential list in :guilabel:`Network Discovery`
view.
Manually add node
=================
@ -306,91 +304,91 @@ will be placed into appropriate subnets automatically. As soon as you add a new
node to the system, |product_name| server will start regular polling to determine the
node status.
Add DCI thresholds
Add DCI thresholds
==================
In this section is described how to configure CPU usage monitoring using agent metric and
using SNMP metric and interface incoming traffic. There will be also shown threshold
configuration for each DCI. This threshold will generate SYS_THRESHOLD_REACHED event
when defined condition is meet and SYS_THRESHOLD_REARMED when collected data exists
range of condition.
In this section is described how to configure CPU usage monitoring using agent metric and
using SNMP metric and interface incoming traffic. There will be also shown threshold
configuration for each DCI. This threshold will generate SYS_THRESHOLD_REACHED event
when defined condition is meet and SYS_THRESHOLD_REARMED when collected data exists
range of condition.
Earlier we already described how to configure email notifications and alarm generation,
resolve based on this events. In this chapter is described data collection and
event generation based on collected data.
Earlier we already described how to configure email notifications and alarm generation,
resolve based on this events. In this chapter is described data collection and
event generation based on collected data.
To add DCI for a node open :guilabel:`Data Collection Configuration` view from object
menu. And select form drop-down menu :guilabel:`New parameter`.
To add DCI for a node open :guilabel:`Data Collection Configuration` view from object
menu. And select from drop-down menu :guilabel:`New parameter`.
CPU usage
---------
Add CPU usage metric form agent parameters:
Add CPU usage metric from agent parameters:
1. Check that as origin is selected |product_name| Agent.
2. Click on :guilabel:`Select` button
3. Type in the input box "CPU"
1. Check that as origin is selected |product_name| Agent.
2. Click on :guilabel:`Select` button
3. Type in the input box "CPU"
.. figure:: _images/quickstart_search_cpu.png
Parameter Selection
.. figure:: _images/quickstart_general_cpu.png
Properties
4. Select :guilabel:`System.CPU.Usage`
5. Go to :guilabel:`Threshold` tab
6. Click :guilabel:`Add`
7. Set that if last one polled value is gather than 85, then generate
SYS_THRESHOLD_REACHED event, when value is back to normal generate
SYS_THRESHOLD_REARMED event.
5. Go to :guilabel:`Threshold` tab
6. Click :guilabel:`Add`
7. Set that if last one polled value is gather than 85, then generate
SYS_THRESHOLD_REACHED event, when value is back to normal generate
SYS_THRESHOLD_REARMED event.
.. figure:: _images/quickstart_threashold_cpu.png
Threshold
8. Click :guilabel:`OK`
Add CPU usage metric form SNMP parameters:
Add CPU usage metric from SNMP parameters:
1. Check that as origin is selected |product_name| Agent.
2. Click on :guilabel:`Select` button
3. Type in the input box ".1.3.6.1.4.1.9.9.109.1.1.1.1.4"(this OID can may be not
1. Check that as origin is selected |product_name| Agent.
2. Click on :guilabel:`Select` button
3. Type in the input box ".1.3.6.1.4.1.9.9.109.1.1.1.1.4"(this OID can may be not
available for some devices)
4. Click :guilabel:`Walk`
.. figure:: _images/quickstart_walk_result_dci.png
Mib Walk Result
5. Select CPU that should be monitored in our case it is
5. Select CPU that should be monitored in our case it is
".1.3.6.1.4.1.9.9.109.1.1.1.1.4.1"
.. figure:: _images/quickstart_walk_dci.png
Select Window For SNMP DCI
6. Click :guilabel:`OK`
.. figure:: _images/quickstart_general_trafic.png
Properties
7. Go to :guilabel:`Threshold` tab
8. Click :guilabel:`Add`
9. Set that if last one polled value is gather than 85, then generate
SYS_THRESHOLD_REACHED event, when value is back to normal generate
SYS_THRESHOLD_REARMED event.
7. Go to :guilabel:`Threshold` tab
8. Click :guilabel:`Add`
9. Set that if last one polled value is gather than 85, then generate
SYS_THRESHOLD_REACHED event, when value is back to normal generate
SYS_THRESHOLD_REARMED event.
.. figure:: _images/quickstart_threashold_cpu.png
Threshold
10. Click :guilabel:`OK`
Now you configured data collection of metric :guilabel:`System.CPU.Usage` that
Now you configured data collection of metric :guilabel:`System.CPU.Usage` that
will be collected every 60 seconds, data will be stored for 30 days, with 1 threshold
that will be activated when CPU usage is mote than 85%.
@ -398,11 +396,9 @@ that will be activated when CPU usage is mote than 85%.
Interface traffic
-----------------
There is shortcut to create all required DCIs for interface traffic. Select interfaces
for which should be created traffic collection DCIs and select form drop-down menu
:guilabel:`Create data collection items`. There can be created automatically all
required DCIs by selecting required checkbooks.
There is shortcut to create all required DCIs for interface traffic. Select interfaces
for which should be created traffic collection DCIs and select from drop-down menu
:guilabel:`Create data collection items`. There can be created automatically all
required DCIs by selecting required checkbooks.
.. figure:: _images/quickstart_create_trafic_dci.png

2
admin/remote-file-management.rst
View file

@ -99,7 +99,7 @@ Other options
~~~~~~~~~~~~~
- It is possible to move files and folders with help of drag and drop.
- To refresh all view should be used view refresh button(not form folder menu). But in this case all expanded folders will be closed.
- To refresh all view should be used view refresh button (not form folder menu). But in this case all expanded folders will be closed.
Advanced File Management
========================

2
admin/schedule.rst
View file

@ -37,7 +37,7 @@ Example: Warning-C.wav,/destination/location/Warning-C.wav
Script Execution
================
Task is named :guilabel:`Execute.Script`. This task executes script form library. Selected
Task is named :guilabel:`Execute.Script`. This task executes script from library. Selected
node is set as :guilabel:`$node` variable in the script.
Parameters:

4
admin/scripting.rst
View file

@ -32,7 +32,7 @@ Execute Server Script
=====================
This view allows to execute arbitrary script. Script can be manually created just before execution,
and afterwards saved, can be taken from the script library, can be used modified script form the
and afterwards saved, can be taken from the script library, can be used modified script from the
script library and afterwards saved or saved as. If this view is opened on a node, then in the
script is available ``$node`` variable with node object.
@ -129,7 +129,7 @@ Example
~~~~~~~
More examples can be found on a
`|product_name| wiki <https://wiki.netxms.org/wiki/Using_nxshell_to_automate_bulk_operations>`_.
`NetXMS wiki <https://wiki.netxms.org/wiki/Using_nxshell_to_automate_bulk_operations>`_.
.. code-block:: python

12
admin/server-management.rst
View file

@ -21,7 +21,7 @@ Configuration file example:
.. code-block:: cfg
#
# Sample configuration file for |product_name| server
# Sample server configuration file
#
DBDriver = mysql.ddr
@ -29,7 +29,6 @@ Configuration file example:
DBName = netxms_db
DBLogin = netxms
DBPassword = password
LogFailedSQLQueries = yes
LogFile = {syslog}
.. _server-tunnel-cert-conf:
@ -85,7 +84,7 @@ Certificate can be obtained in two ways:
Possible server file configuration:
.. list-table::
:widths: 30 70 60
:widths: 50 70 60
:header-rows: 1
* - Parameter
@ -107,6 +106,11 @@ Possible server file configuration:
- Can be omitted if key is included in server certificate file.
Possible server variable configuration:
.. list-table::
:widths: 50 70 60
:header-rows: 1
* - Parameter
- Description
- Default
@ -147,7 +151,7 @@ does not contain any information about file access right assignment or certifica
stateOrProvinceName = Riga
localityName = Riga
organizationName = netxms.org
commonName = |product_name| Server
commonName = Monitoring Server
[v3_ca]
basicConstraints = CA:TRUE

2
admin/snmp.rst
View file

@ -30,7 +30,7 @@ There are next options available for results:
- Copy value of selected line to clipboard
- Export selected lines to CSV
- Show selection in MIB tree
- Create DCI form selected item
- Create DCI from selected item
SNMP Trap Configuration
=======================

222
admin/upgrade.rst
View file

@ -20,24 +20,24 @@ Management console
Desktop Management Console:
1. Download the latest version from http://www.netxms.org/download. You will need
Linux installer(named nxmc-VERSION-linux-gtk-x86.tar.gz or
1. Download the latest version from http://www.netxms.org/download. You will need
Linux installer(named nxmc-VERSION-linux-gtk-x86.tar.gz or
nxmc-VERSION-linux-gtk-x64.tar.gz, for example nxmc-1.2.17-linux-gtk-x64.tar.gz).
2. Extract and replace old management console with the new one.
:command:`tar zxvf nxmc-VERSION-linux-gtk-x86.tar.gz -C /DIRECTORY`
3. Run nxmc file form extracted catalog.
3. Run nxmc file from extracted catalog.
Web Management Console:
1. Download latest version of WAR file from Web Interface Binaries section
http://www.netxms.org/download/ (named nxmc-VERSION.war, for example
1. Download latest version of WAR file from Web Interface Binaries section
http://www.netxms.org/download/ (named nxmc-VERSION.war, for example
nxmc-1.2.17.war).
2. Replace old WAR file with the new one.
2. Replace old WAR file with the new one.
Upgrading on Red Hat, Fedora, CentOS or ScientificLinux
=======================================================
@ -56,38 +56,38 @@ Server
2. Unpack the archive:
:command:`$ tar zxvf netxms-1.2.15.tar.gz`
3. Change directory to netxms-version and run configure script:
:command:`$ cd netxms-1.2.15`
:command:`$ sh ./configure --with-server --with-mysql`
Be sure to include all options that were used at installation time.
4. Run make:
:command:`$ make`
5. Stop |product_name| server.
6. Stop |product_name| agent.
5. Stop |product_name| server.
6. Stop |product_name| agent.
7. Check database for possible inconsistencies:
:command:`$ nxdbmgr check`
Proceed to the next step only if database checker does not report any errors!
8. Run make install:
:command:`$ make install`
9. Upgrade database:
:command:`$ nxdbmgr upgrade`
10. Start |product_name| agent.
11. Start |product_name| server.
@ -95,35 +95,35 @@ Server
Agent
~~~~~
1. Download the latest version from http://www.netxms.org/download, if you don't
have it. You will need source archive (named netxms-VERSION.tar.gz, for example
netxms-1.2.15.tar.gz). Please note that in the following steps VERSION will be
1. Download the latest version from http://www.netxms.org/download, if you don't
have it. You will need source archive (named netxms-VERSION.tar.gz, for example
netxms-1.2.15.tar.gz). Please note that in the following steps VERSION will be
used as a substitution for an actual version number.
2. Unpack the archive:
2. Unpack the archive:
:command:`tar zxvf netxms-1.2.15.tar.gz`
3. Change directory to netxms-version and run configure script:
:command:`cd netxms-1.2.15`
:command:`sh ./configure --with-agent`
Be sure to include all options that were used at installation time.
:command:`sh ./configure --with-agent`
Be sure to include all options that were used at installation time.
4. Run make and make install:
:command:`make`
5. Stop |product_name| agent.
5. Stop |product_name| agent.
6. Run make install:
:command:`make install`
:command:`make install`
7. Run agent:
:command:`$ /usr/local/bin/nxagentd -d`
Management console
@ -131,24 +131,24 @@ Management console
Desktop Management Console:
1. Download the latest version from http://www.netxms.org/download. You will need
Linux installer(named nxmc-VERSION-linux-gtk-x86.tar.gz or
1. Download the latest version from http://www.netxms.org/download. You will need
Linux installer(named nxmc-VERSION-linux-gtk-x86.tar.gz or
nxmc-VERSION-linux-gtk-x64.tar.gz, for example nxmc-1.2.17-linux-gtk-x64.tar.gz).
2. Extract and replace old management console with the new one.
:command:`tar zxvf nxmc-VERSION-linux-gtk-x86.tar.gz -C /DIRECTORY`
3. Run nxmc file form extracted catalog.
3. Run nxmc file from extracted catalog.
Web Management Console:
1. Download latest version of WAR file from Web Interface Binaries section
http://www.netxms.org/download/ (named nxmc-VERSION.war, for example
1. Download latest version of WAR file from Web Interface Binaries section
http://www.netxms.org/download/ (named nxmc-VERSION.war, for example
nxmc-1.2.17.war).
2. Replace old WAR file with the new one.
2. Replace old WAR file with the new one.
Upgrading on Windows
====================
@ -167,7 +167,7 @@ Server
.. code-block:: cfg
C:\|product_name|\bin> nxdbmgr check
C:\NetXMS\bin> nxdbmgr check
Proceed to the next step only if database checker does not report any errors!
@ -181,22 +181,22 @@ Proceed to the next step only if database checker does not report any errors!
.. code-block:: cfg
C:\|product_name|\bin> nxdbmgr upgrade
C:\NetXMS\bin> nxdbmgr upgrade
6. Start |product_name| server, if it is not already started.
Agent
~~~~~
We highly recommend using centralized agent upgrade feature for agent upgrades.
We highly recommend using centralized agent upgrade feature for agent upgrades.
However, if you decide to upgrade agent manually, it can be done in just a few steps:
1. Download the latest version from http://www.netxms.org/download, if you don't
have it. You will need Windows Agent installer (named nxagent-VERSION.exe or
1. Download the latest version from http://www.netxms.org/download, if you don't
have it. You will need Windows Agent installer (named nxagent-VERSION.exe or
nxagent-VERSION-x64.exe, for example nxagent-1.2.0.exe).
2. Run |product_name| agent installer and follow the prompts. Normally, you will not need
to change any settings on installation wizard dialog windows. Alternatively, you
2. Run |product_name| agent installer and follow the prompts. Normally, you will not need
to change any settings on installation wizard dialog windows. Alternatively, you
can run installer with /SILENT option to disable any prompts:
:command:`C:\Download> nxagent-1.2.0.exe /SILENT`
@ -206,20 +206,20 @@ Management console
Desktop Management Console:
1. Download the latest version from http://www.netxms.org/download. You will need
Windows installer(named nxmc-VERSION-win32-x86.zip or
1. Download the latest version from http://www.netxms.org/download. You will need
Windows installer(named nxmc-VERSION-win32-x86.zip or
nxmc-VERSION-win32-x64.zip, for example nxmc-1.2.17-win32-x64.zip).
2. Replace old old folder with content of the zip.
3. Run nxmc.exe file form extracted catalog.
2. Replace old old folder with content of the zip.
3. Run nxmc.exe file from extracted catalog.
Web Management Console:
1. Download latest version of WAR file from Web Interface Binaries section
http://www.netxms.org/download/ (named nxmc-VERSION.war, for example
1. Download latest version of WAR file from Web Interface Binaries section
http://www.netxms.org/download/ (named nxmc-VERSION.war, for example
nxmc-1.2.17.war).
2. Replace old WAR file with the new one. Default path: INSTALLATION_DIR\webapps.
Generic upgrade using source tarball
@ -232,38 +232,38 @@ Server
2. Unpack the archive:
:command:`$ tar zxvf netxms-1.2.15.tar.gz`
3. Change directory to netxms-version and run configure script:
:command:`$ cd netxms-1.2.15`
:command:`$ sh ./configure --with-server --with-mysql`
Be sure to include all options that were used at installation time.
4. Run make:
:command:`$ make`
5. Stop |product_name| server.
6. Stop |product_name| agent.
5. Stop |product_name| server.
6. Stop |product_name| agent.
7. Check database for possible inconsistencies:
:command:`$ nxdbmgr check`
Proceed to the next step only if database checker does not report any errors!
8. Run make install:
:command:`$ make install`
9. Upgrade database:
:command:`$ nxdbmgr upgrade`
10. Start |product_name| agent.
11. Start |product_name| server.
@ -271,37 +271,37 @@ Server
Agent
-----
1. Download the latest version from http://www.netxms.org/download, if you don't
have it. You will need source archive (named netxms-VERSION.tar.gz, for example
netxms-1.2.15.tar.gz). Please note that in the following steps VERSION will be
1. Download the latest version from http://www.netxms.org/download, if you don't
have it. You will need source archive (named netxms-VERSION.tar.gz, for example
netxms-1.2.15.tar.gz). Please note that in the following steps VERSION will be
used as a substitution for an actual version number.
2. Unpack the archive:
2. Unpack the archive:
:command:`tar zxvf netxms-1.2.15.tar.gz`
3. Change directory to netxms-version and run configure script:
:command:`cd netxms-1.2.15`
:command:`sh ./configure --with-agent`
Be sure to include all options that were used at installation time.
:command:`sh ./configure --with-agent`
Be sure to include all options that were used at installation time.
4. Run make and make install:
:command:`make`
5. Stop |product_name| agent.
5. Stop |product_name| agent.
6. Run make install:
:command:`make install`
:command:`make install`
7. Run agent:
:command:`$ /usr/local/bin/nxagentd -d`
.. _agent-remote-update:
Centralized agent upgrade
@ -310,10 +310,10 @@ Centralized agent upgrade
Steps to update agent remotely:
1. Download |product_name| agent installer from http://www.netxms.org/download/
2. Download the appropriate NPI file for your agent installer(NPI file is just a reference to actual package file. You should have it as well in the same directory as NPI file.)
3. Open "Package Manager"
.. figure:: _images/package_manager.png
3. Open "Package Manager"
.. figure:: _images/package_manager.png
4. Chose "Install new package..."
5. Browse for NPI file
6. When new package appeared - right click on it and chose "Deploy to managed nodes..."

2
admin/ups-monitoring.rst
View file

@ -155,7 +155,7 @@ Other option to monitor UPS is using SNMP. |product_name| already includes MIBs
like APC UPS and standard UPS MIB.
Description for possible OIDs and some additional information for APC UPS configuration
can be found on a
`|product_name| wiki <https://wiki.netxms.org/wiki/UPS_Monitoring_(APC)_via_SNMP>`_.
`NetXMS wiki <https://wiki.netxms.org/wiki/UPS_Monitoring_(APC)_via_SNMP>`_.
Please check :ref:`import-mib` for MIB loading and :ref:`dci-configuration` for
metric collection.

10
admin/user-management.rst
View file

@ -471,13 +471,13 @@ Log when LDAP sync passed correctly:
[11-Sep-2014 16:28:08.354] [DEBUG] LDAPConnection::syncUsers(): User added: dn: CN=zev333,CN=Users,CN=Customers,DC=Northwind,DC=Extranet, login name: zev333, full name: (null), description: (null)
[11-Sep-2014 16:28:08.354] [DEBUG] LDAPConnection::syncUsers(): Found dn: CN=user,CN=Users,CN=Customers,DC=Northwind,DC=Extranet
[11-Sep-2014 16:28:08.354] [DEBUG] LDAPConnection::syncUsers(): User added: dn: CN=user,CN=Users,CN=Customers,DC=Northwind,DC=Extranet, login name: user, full name: (null), description: (null)
[11-Sep-2014 16:28:08.354] [DEBUG] LDAPConnection::closeLDAPConnection(): Disconnect form ldap.
[11-Sep-2014 16:28:08.354] [DEBUG] LDAPConnection::closeLDAPConnection(): Disconnect from ldap.
[11-Sep-2014 16:28:08.354] [DEBUG] UpdateLDAPUsers(): User added: dn: CN=zev333,CN=Users,CN=Customers,DC=Northwind,DC=Extranet, login name: zev333, full name: (null), description: (null)
[11-Sep-2014 16:28:08.354] [DEBUG] UpdateLDAPUsers(): User added: dn: CN=user,CN=Users,CN=Customers,DC=Northwind,DC=Extranet, login name: user, full name: (null), description: (null)
[11-Sep-2014 16:28:08.354] [DEBUG] RemoveDeletedLDAPEntry(): Ldap uid=john,ou=People,dc=nodomain entry was removed form DB.
[11-Sep-2014 16:28:08.354] [DEBUG] RemoveDeletedLDAPEntry(): Ldap uid=zev,ou=People,dc=nodomain entry was removed form DB.
[11-Sep-2014 16:28:08.354] [DEBUG] RemoveDeletedLDAPEntry(): Ldap uid=kasio,ou=People,dc=nodomain entry was removed form DB.
[11-Sep-2014 16:28:08.355] [DEBUG] RemoveDeletedLDAPEntry(): Ldap uid=usr1,ou=People,dc=nodomain entry was removed form DB.
[11-Sep-2014 16:28:08.354] [DEBUG] RemoveDeletedLDAPEntry(): Ldap uid=john,ou=People,dc=nodomain entry was removed from DB.
[11-Sep-2014 16:28:08.354] [DEBUG] RemoveDeletedLDAPEntry(): Ldap uid=zev,ou=People,dc=nodomain entry was removed from DB.
[11-Sep-2014 16:28:08.354] [DEBUG] RemoveDeletedLDAPEntry(): Ldap uid=kasio,ou=People,dc=nodomain entry was removed from DB.
[11-Sep-2014 16:28:08.355] [DEBUG] RemoveDeletedLDAPEntry(): Ldap uid=usr1,ou=People,dc=nodomain entry was removed from DB.
Login credentials incorrect:

2
admin/visualisation.rst
View file

@ -654,7 +654,7 @@ as predefined from graph view menu. The following dialog will appear:
In :guilabel:`Graph name` field, enter desired name for your predefined graph.
It will appear in predefined graph tree exactly as written here. You can use
``->`` character pair to create subtree. For example, if you name your graph
``|product_name| Server->System->CPU utilization (iowait)`` it will appear in the tree
``NetXMS Server->System->CPU utilization (iowait)`` it will appear in the tree
as following:
.. figure:: _images/predefined_graph_tree.png

35
appendix.rst
View file

@ -234,9 +234,6 @@ Agent configuration file (nxagentd.conf)
* - ListenPort
- TCP port to be used for incoming requests.
- 4700
* - LogFailedSQLQueries
- Enable (yes) or disable (no) failed SQL queries logging
- No
* - LogFile
- Agent's log file. To write log to syslog (or Event Log on Windows), use {syslog} as file name.
- {syslog}
@ -377,12 +374,6 @@ Server configuration file (netxmsd.conf)
* - ListenAddress
- Interface address which should be used by server to listen for incoming connections. Use value 0.0.0.0 or * to use all available interfaces.
- 0.0.0.0
* - LogFailedSQLQueries
- Control logging of failed SQL queries. Possible values: yes or no.
- yes
* - LogFailedSQLQueries
- Enable (yes) or disable (no) failed SQL queries logging
- No
* - LogFile
- Server's log file. To write log to syslog (or Event Log on Windows), use {syslog} as file name.
- {syslog}
@ -1282,7 +1273,7 @@ Syntax:
nxget [options] host [parameter [parameter ...]]
Where *host* is the name or IP address of the host running NetXMS agent; and
Where *host* is the name or IP address of the host running |product_name| agent; and
*parameter* is a parameter or a list name, depending on given options. By default,
nxget will attempt to retrieve the value of one given parameter, unless given
options override it.
@ -2096,7 +2087,7 @@ Data type: Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Network interface administrative status (1 = enabled, 2 = disabled, 3 = testing)
@ -2109,7 +2100,7 @@ Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of input bytes on interface
@ -2122,7 +2113,7 @@ Data type: Unsigned Integer 64-bit
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of output bytes on interface
@ -2135,7 +2126,7 @@ Data type: String
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Description of interface
@ -2148,7 +2139,7 @@ Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of input errors on interface
@ -2161,7 +2152,7 @@ Data type: Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Link status of interface
@ -2174,7 +2165,7 @@ Data type: Integer
Supported Platforms: Windows, AIX, HP-UX
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Net.Interface.OperStatus(*)
@ -2185,7 +2176,7 @@ Data type: Integer
Supported Platforms: Windows, Linux, Solaris, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Network interface operational status (0 = down, 1 = up)
@ -2198,7 +2189,7 @@ Data type: Unsigned Integer
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of output errors on interface
@ -2211,7 +2202,7 @@ Data type: UInt32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of input packets on interface
@ -2224,7 +2215,7 @@ Data type: UInt32
Supported Platforms: Windows, Linux, Solaris, AIX, HP-UX, FreeBSD, NetBSD, OpenBSD
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Number of output packets on interface
@ -2237,7 +2228,7 @@ Data type: UInt32
Supported Platforms: Windows, Solaris, AIX, HP-UX
Parameters:
1. Interface name or interface index. Index can be obtained form ``Net.InterfaceList`` list.
1. Interface name or interface index. Index can be obtained from ``Net.InterfaceList`` list.
Net.IP.Forwarding

8
concept/index.rst
View file

@ -1,6 +1,6 @@
####################
NetXMS Concept Guide
####################
############################
|product_name| Concept Guide
############################
.. warning::
@ -9,7 +9,7 @@ NetXMS Concept Guide
.. toctree::
:maxdepth: 3
:glob:
preface
architecture_overview
objects

4
concept/preface.rst
View file

@ -6,8 +6,8 @@ Preface
Purpose of this document
========================
What is NetXMS
==============
What is |product_name|
======================
Supported operating systems and databases

78
user/mobile-console.rst
View file

@ -5,20 +5,20 @@ Mobile Console
##############
.. Used version on wiki: 14:17, 7 September 2014‎ Marco Incalcaterra
.. Used version on wiki: 14:17, 7 September 2014‎ Marco Incalcaterra
NetXMS mobile console is a monitoring tool for Android devices running version 2.2.
and later.
|product_name| mobile console is a monitoring tool for Android devices running version 2.2.
and later.
Currently, only a small subset of the functions present in the Desktop/Web edition
are implemented, mainly read/only operations. The next paragraphs briefly describes
each section.
Currently, only a small subset of the functions present in the Desktop/Web edition
are implemented, mainly read/only operations. The next paragraphs briefly describes
each section.
Main window
===========
Here you can see how appears the main window and the underneath levels.
Here you can see how appears the main window and the underneath levels.
.. figure:: _images/360px-MobCons-main.png
@ -35,17 +35,17 @@ Here you can see how appears the main window and the underneath levels.
From the main window it is possible to get access to the following menu items:
* :guilabel:`Settings`: select this item to configure the console.
* :guilabel:`Reconnect`: select this item to force a reconnection to the server to gather new
* :guilabel:`Reconnect`: select this item to force a reconnection to the server to gather new
collected data.
* :guilabel:`Disconnect & Exit`: select this item to stop the console and exit from the app.
Underneath levels have menu that are context dependent, a detailed description can be
Underneath levels have menu that are context dependent, a detailed description can be
found in each section.
Alarms
======
Alarms section is used to list and manage all pending alarms, eventually filtered on a
Alarms section is used to list and manage all pending alarms, eventually filtered on a
particular node/container. Through this view it is possible to manage alarms:
* :guilabel:`Actions`:
@ -63,16 +63,16 @@ particular node/container. Through this view it is possible to manage alarms:
* :guilabel:`Sort by node name descending`: sort list using node name that generated the event as criteria, descending.
* :guilabel:`Select all`: select all the alarms from the list
* :guilabel:`Unselect all`: clear any selection of alarms from the list
Dashboard
=========
Dashboards are defined by administrator and allow to combine any available
visualization components with data from multiple sources in order to create
high-level views to see network (or parts of it) health at a glance. Not all
elements are currently available for the mobile console, dashboards are properly
refreshed according to their schedule. Due to dashboard size, keep in mind that
Smartphones cannot be the best device to show them, a tablet is much more suitable
Dashboards are defined by administrator and allow to combine any available
visualization components with data from multiple sources in order to create
high-level views to see network (or parts of it) health at a glance. Not all
elements are currently available for the mobile console, dashboards are properly
refreshed according to their schedule. Due to dashboard size, keep in mind that
Smartphones cannot be the best device to show them, a tablet is much more suitable
device. Here an example:
.. figure:: _images/360px-MobCons-dashboard.png
@ -81,13 +81,13 @@ device. Here an example:
Nodes
=====
This section is used to list and manage all nodes (all network infrastructure monitored
by NetXMS are represented as a set of objects. Each object represents one physical or
logical entity, or group of them). Objects can be organized into hierarchical
structure, the Nodes section is used to explore them. In the right bottom corner
of the icon there is a symbol that indicates the status of the node/container
following the same simbology used on the desktop console. Clicking on a container
will show the items inside, continuing to click up to an object will show a set of
This section is used to list and manage all nodes (all network infrastructure monitored
by |product_name| are represented as a set of objects. Each object represents one physical or
logical entity, or group of them). Objects can be organized into hierarchical
structure, the Nodes section is used to explore them. In the right bottom corner
of the icon there is a symbol that indicates the status of the node/container
following the same simbology used on the desktop console. Clicking on a container
will show the items inside, continuing to click up to an object will show a set of
swipeable pages:
* :guilabel:`Overview`: here are presented the main info associated to this node, such as the name, the primary IP, the status, etc.
@ -97,7 +97,7 @@ swipeable pages:
* :guilabel:`Sticky acknowledge`: sticky acknowledge the alarm.
* :guilabel:`Resolve:` resolve the alarm.
* :guilabel:`Terminate`: terminate the alarm.
* :guilabel:`View last values`: jump to the node info section to view the last values
* :guilabel:`View last values`: jump to the node info section to view the last values
for the node that generated the alarm.
* :guilabel:`Select all`: select all the alarms from the list
* :guilabel:`Unselect all`: clear any selection of alarms from the list
@ -131,9 +131,9 @@ swipeable pages:
Graphics
========
Predefined graphics are defined by administrator and can be used to view collected
data in a graphical form (as a line chart). Currently, the mobile console doesn’t
autorefresh the content of the graphic selected. Here an example of a predefined
Predefined graphics are defined by administrator and can be used to view collected
data in a graphical form (as a line chart). Currently, the mobile console doesn’t
autorefresh the content of the graphic selected. Here an example of a predefined
graphs:
.. figure:: _images/360px-MobCons-predgraph.png
@ -142,9 +142,9 @@ graphs:
MACaddress
==========
This section is used to list previously searched MAC addresses or to start a new
search by scanning a barcode value (this feature needs the installation of Barcode
Scanner from Zxing Team – freely available on the Google Play), by input it manually
This section is used to list previously searched MAC addresses or to start a new
search by scanning a barcode value (this feature needs the installation of Barcode
Scanner from Zxing Team – freely available on the Google Play), by input it manually
or by getting it directly from a node via the “Find Switch port” command.
@ -159,7 +159,7 @@ Global settings
* :guilabel:`Autostart on boot`: check to automatically start the agent on boot (to be effective, app must not be moved to SD card).
Connection
==========
@ -177,9 +177,9 @@ Allows selecting the parameters used to connect to the server:
Scheduler
---------
Enables the possibility to define periodic connections to the server. If the scheduler
is not enabled the app will try to connect to the server every time it detects a new
connection (data or WiFi) and remains always connected as far as the connection
Enables the possibility to define periodic connections to the server. If the scheduler
is not enabled the app will try to connect to the server every time it detects a new
connection (data or WiFi) and remains always connected as far as the connection
remains active:
* :guilabel:`Enable scheduler`: check this to enable the scheduler.
@ -233,12 +233,12 @@ Allows to select the preferred multipliers to be used to show values. Allowed op
Graph text size
---------------
Allows to set the text size to be used for axis labels (if the default value is too
Allows to set the text size to be used for axis labels (if the default value is too
small for high density devices).
Show legend in graphs
---------------------
Allows to select to show or not the legend in the top right angle of the graphs. Since
legend can be intrusive, especially when there are several lines plotted, user can
Allows to select to show or not the legend in the top right angle of the graphs. Since
legend can be intrusive, especially when there are several lines plotted, user can
select to disable the legend.

6
user/objects.rst
View file

@ -129,10 +129,10 @@ exported to CSV.
node and some other options:
:guilabel:`Routing table`
:guilabel:`IP route from...` will build network map with route form selected node to
node that is selected form Object selector window.
:guilabel:`IP route from...` will build network map with route from selected node to
node that is selected from Object selector window.
:guilabel:`IP route to...` will build network map with route to selected node from
node that is selected form Object selector window.
node that is selected from Object selector window.
:guilabel:`IP Neighbors` will show all IP neighbors of this node.
:guilabel:`Switch forwarding database(MAC address table)`