Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reworded Package manager monitoring preface #34

Merged
merged 5 commits into from
Dec 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions admin/package-manager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,34 @@ Package management
Introduction
============

Package management functionality can upload and execute installers via
|product_name| agent. This allows to perform centralized upgrade of
|product_name| agent, install other software or upload and extract archive files
The package management functionality can upload and execute installers via the
|product_name| agent. This allows to perform centralized upgrade of the
|product_name| agent, to install other software or upload and extract archive files
onto target systems.

To access package management, open :guilabel:`Configuration` perspective and
select :guilabel:`Packages`. Software packages are first uploaded to
To access package management, open the :guilabel:`Configuration` perspective and
select :guilabel:`Packages`. Software packages are first uploaded to the
|product_name| server. In order to do this, select :guilabel:`Upload to server`
and select a file.

For some types of packages additional dialog :guilabel:`Edit Package Metadata`
is displayed, allowing to specify additional metadata for a package. Whenever
For some types of packages, the additional dialog :guilabel:`Edit Package Metadata`
is displayed. This allows to specify additional metadata for a package. Whenever
possible, metadata information is filled in automatically based on information
contained in file name.
contained in file name.

You can open metadata editor by double-clicking on a package in the list. In
metadata editor `Name`, `Version` and `Description` are just informative fields,
You can open the metadata editor by double-clicking on a package in the list. In
the metadata editor `Name`, `Version` and `Description` are just informative fields,
they are not used in package processing.

`Platform` denotes for which platforms a package is applicable. Actual platform
`Platform` denotes for which platforms a package is applicable. The actual platform
of a node is compared to this field as string value using wildcard characters.
Two wildcard characters are supported: ``*`` - represents zero, one or multiple
characters. ``?`` - represents any single character. Setting `Platform` to ``*``
would mean any platform. ``Linux*`` would mean both 32 and 64 bit Linuxes.

`Type` defines package type. This defines how agent should process the package
when installing it. Meaning of `Command` field depends on package type. See
information in the below table.
`Type` defines package type. This defines how the agent should process the package
when installing it. The meaning of the `Command` field depends on the package type. See
information in the table below.

The following types of package files are supported by package management:

Expand Down Expand Up @@ -73,20 +73,20 @@ The following types of package files are supported by package management:
- Deprecated type of metadata file for NetXMS Agent Package.
* - Compressed TAR Archive
- .tgz, .tar.gz
- `Command` is optional. If specified, it defines path the archive should
be extracted to.
- `Command` is optional. If specified, it defines the path the archive should
be extracted to.
* - ZIP Archive
- .zip
- `Command` is optional. If specified, it defines path the archive should
- `Command` is optional. If specified, it defines the path the archive should
be extracted to.


To deploy a package, select one or several nodes from :guilabel:`Infrastructure
services` or :guilabel:`Entire Network`. You can also select container(s) or
subnet(s). Right-click on the selected item(s) and select :guilabel:`Deploy
services` or :guilabel:`Entire Network`. You can also select containers or
subnets. Right-click on the selected items and select :guilabel:`Deploy
package...`. Select the package and click :guilabel:`OK`.

During package deployment process server will request platform name from agent
and check if it matches `Platform` from package's metadata. Deployment process
is shown in :guilabel:`Package deployment monitor` tab that is visible on all
containers, subnets and nodes concerned.
During the package deployment process, the server will request the platform name from agent
and check if it matches `Platform` from the package metadata. The deployment process
is shown in the :guilabel:`Package deployment monitor` tab that is visible on all
relevant containers, subnets and nodes.
12 changes: 6 additions & 6 deletions admin/preface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
Introduction
############

This document covers installation, configuration, and use of |product_name|.
This document covers the installation, configuration, and use of |product_name|.

.. ifconfig:: release_type == 'oss'

|product_name| is an enterprise grade multi-platform modular open source network management
and monitoring system. It provides comprehensive event management,
performance monitoring, alerting, reporting and graphing for all layers of
IT infrastructure — from network devices to business application layer.
IT infrastructure — from network devices to the business application layer.
Having been designed with flexibility and scalability in mind, |product_name| features
a wide range of supported platforms. It is licensed under the GNU General Public
License version 2 as published by the Free Software Foundation.
Expand All @@ -19,12 +19,12 @@ This document covers installation, configuration, and use of |product_name|.
|product_name| is an enterprise grade multi-platform modular network management
and monitoring system. It provides comprehensive event management,
performance monitoring, alerting, reporting and graphing for all layers of
IT infrastructure — from network devices to business application layer.
IT infrastructure — from network devices to the business application layer.
Having been designed with flexibility and scalability in mind, |product_name| features
a wide range of supported platforms.


This document only covers core platform, product-specific extensions are documented in corresponding manuals.
This document only covers the core platform. Product-specific extensions are documented in their corresponding manuals.


.. ifconfig:: release_type == 'oss'
Expand Down Expand Up @@ -57,9 +57,9 @@ The following typographical conventions are used in this manual.
+----------------------------------+------------------------------------------+
| :kbd:`Control-M` | Keyboard shortcut |
+----------------------------------+------------------------------------------+
| :term:`DCI` | Term which could be found in glossary |
| :term:`DCI` | Term which can be found in the glossary |
+----------------------------------+------------------------------------------+
| :menuselection:`&File --> &Exit` | Menu selection path, you must click on |
| :menuselection:`&File --> &Exit` | Menu selection path. You must click on |
| | :guilabel:`File`, then :guilabel:`Exit` |
+----------------------------------+------------------------------------------+

Expand Down
36 changes: 19 additions & 17 deletions admin/ssh-monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,33 @@ SSH monitoring
SSH configuration
-----------------

|product_name| can execute commands via SSH connection and save the output as DCI values.
|product_name| can execute commands via an SSH connection and save the output as DCI values.

SSH connection are always established via agent. For this to work, ``ssh.nsm`` subagent should be enabled in agent config file.
SSH connections are always established via an agent. For this to work, the ``ssh.nsm`` subagent should be enabled in the agent config file.

Subagent uses built-in libssh. It reads configuration in standard ssh format from ~/.ssh/config.
It's also possible to specify custom location for configuration file by adding ``ConfigFile=`` into ``[SSH]`` section of agent configuration file.
The subagent uses the built-in libssh. It reads the configuration in standard ssh format from ~/.ssh/config.
It is also possible to specify a custom location for the configuration file by adding ``ConfigFile=``
to the ``[SSH]`` section of the agent configuration file.

If zoning is not used, agent running on |product_name| server is used for SSH connections.
If zoning is used, zone proxies are used (and if a zone has no proxies configured, agent on |product_name| server is used as last resort).
If zoning is not used, the agent running on the |product_name| server is used for SSH connections.
If zoning is used, zone proxies are used. If a zone has no proxies configured, the agent on
the |product_name| server is used as a last resort.

Username and password are specified in :menuselection:`Node properties -> Communications -> SSH`. Same properties
page can used to specify ssh port for node, proxy for ssh polling and ssh key if required.
If proxy node is specified on this property page, connection will be performed via that node only.
The username and password are specified in :menuselection:`Node properties -> Communications -> SSH`. The same properties
page can used to specify an ssh port for node, the proxy for ssh polling and an ssh key if required.
If a proxy node is specified on this property page, the connection will be performed via that node only.

.. figure:: _images/ssh_monitoring_node_properties.png

In DCI properties ``SSH`` origin should be chosen. Parameter is the actual ssh command that is executed.
In DCI properties the ``SSH`` origin should be chosen. The parameter is the actual ssh command that is executed.

Only first line of the output is stored as DCI value. For numeric data type output is parsed from beginning till first non-numeric character.
Only the first line of the output is stored as a DCI value. For numeric data type output is parsed from its beginning until the first non-numeric character.

.. figure:: _images/ssh_monitoring_dci_properties.png

There's also ``SSH.Command(*)`` metric of origin ``NetXMS Agent`` that works in a similar way,
but target and credentials are specified as arguments. It's also necessary to manually specify Source node,
otherwise agent of the monitored node will be used for establishing ssh connection.
There is also the ``SSH.Command(*)`` metric of origin ``NetXMS Agent`` that works in a similar way,
but where target and credentials are specified as arguments. It is also necessary to manually specify the Source node,
otherwise the agent of the monitored node will be used for establishing the ssh connection.

.. list-table::
:widths: 100 50
Expand All @@ -40,13 +42,13 @@ otherwise agent of the monitored node will be used for establishing ssh connecti
* - Metric Name
- Description
* - SSH.Command(\ *target*\ ,\ *login*\ ,\ *password*\ ,\ *command*\ ,\ *[pattern]*\ ,\ *[ssh_key_id]*\)
- ``%{node_primary_ip}`` macro can be used to specify node's primary IP address as *target*.
- ``%{node_primary_ip}`` macro can be used to specify the nodes primary IP address as *target*.


SSH key configuration
---------------------

SSH key can be added in :menuselection:`Configuration ->SSH key configuration` and then used in object configuration
for SSH connection.
An SSH key can be added in :menuselection:`Configuration ->SSH key configuration` and then used in the object configuration
for the SSH connection.

.. figure:: _images/ssh_key_configuration.png
48 changes: 24 additions & 24 deletions admin/ups-monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,42 @@
UPS monitoring
==============

There are two options to monitor UPS: first is through USB or serial connection with
help of subagent and second one is through the network with help of SNMP.
There are two options to monitor a UPS: the first is through a USB or serial connection with
help of a subagent and the second one is through the network with help of SNMP.

Subagent can be used for monitoring UPS (Uninterruptible Power Supply) attached
to serial or USB port on computer where |product_name| agent is running. USB-attached devices
currently supported only on Windows platform, serial is supported on all platforms.
A subagent can be used for monitoring a UPS (Uninterruptible Power Supply) attached
to a serial or USB port on a computer where the |product_name| agent is running. USB-attached devices
are currently only supported on the Windows platform. Serial devices are supported on all platforms.
One subagent can monitor multiple attached devices.


USB or serial UPS monitoring
============================

You can monitor UPS devices attached to the hosts via serial cable or USB via UPS
subagent. Once you have your UPS attached to the host and |product_name| agent installed,
you should configure UPS subagent. First, add the following line to agent's
You can monitor UPS devices attached to the hosts via serial cable or USB via the UPS
subagent. Once you have your UPS attached to the host and the |product_name| agent installed,
you should configure the UPS subagent. First, add the following line to the agents
configuration file main section:

.. code-block:: ini

SubAgent = ups.nsm

Second, configure attached UPS devices. Create ``UPS`` section, and for each UPS
device attached to the host add line in the following format:
Second, configure the attached UPS devices. Create a ``UPS`` section and for each UPS
device attached to the host add a line in the following format:

.. code-block:: ini

Device = id:port:protocol

``id`` is an arbitrary but unique number in range 0 to 127, which is used to
``id`` is an arbitrary but unique number in the range 0 to 127, which is used to
distinguish multiple UPS devices in further requests.

``device`` is either name of the serial port (e.g. `COM1:` or `/dev/ttyS0`) or
serial number of the USB device (keyword `ANY` can be used instead of exact serial
number to select first available).
``device`` is either the name of the serial port (e.g. `COM1:` or `/dev/ttyS0`) or
the serial number of the USB device. The keyword `ANY` can be used instead of an exact serial
number to select the first available port.

``protocol`` specify which communication protocol should be used. Supported protocols:
``protocol`` specifies which communication protocol should be used. Supported protocols are:

* APC
* BCMXCP - Some of the HP/Compaq, PowerWare, etc.
Expand All @@ -49,8 +49,8 @@ number to select first available).
* USB - HID UPS devices (currently Windows only)


Sample configuration section for two devices attached via serial ports, one is APC device
(configured as device 0) and one is HP device (configured as device 1):
A sample configuration section for two devices attached via serial ports where one is an APC device
(configured as device 0) and one is a HP device (configured as device 1):

.. code-block:: ini

Expand All @@ -60,7 +60,7 @@ Sample configuration section for two devices attached via serial ports, one is A
Device = 1:/dev/ttyS1:BCMXCP


Once UPS subagent is configured, you can start to monitor UPS devices status via
Once the UPS subagent is configured, you can start monitoring the UPS device status via
metrics provided by it:

.. list-table::
Expand Down Expand Up @@ -123,18 +123,18 @@ metrics provided by it:


Please note that not all metrics are supported by all UPS devices. Many old or
simple models will support only basic things like UPS.OnlineStatus metric. Most
simple models will support only basic metrics like UPS.OnlineStatus. The most
typical approach is to monitor UPS.OnlineStatus for going to 1 or 2, and then
send notifications to administrators and shutdown affected hosts if needed. You
can also monitor UPS.EstimatedRuntime metric for the same purposes if your
devices support it.
can also monitor the UPS.EstimatedRuntime metric for the same purpose, if your
device supports it.

SNMP UPS monitoring
===================

Other option to monitor UPS is using SNMP. |product_name| already includes MIBs for some UPS,
like APC UPS and standard UPS MIB.
Description for possible OIDs and some additional information for APC UPS configuration
Another option is to monitor the UPS using SNMP. |product_name| already includes MIBs for some UPSs,
like APC UPS and the standard UPS MIB.
The description for possible OIDs and some additional information for APC UPS configuration
can be found on a
`NetXMS wiki <https://wiki.netxms.org/wiki/UPS_Monitoring_(APC)_via_SNMP>`_.

Expand Down
Loading
Loading