meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Last revisionBoth sides next revision
documentation:software_interface [2020/12/16 11:16] – vordocumentation:software_interface [2020/12/16 11:17] – old revision restored (2020/11/13 12:10) vor
Line 1: Line 1:
 ====== Software interface ====== ====== Software interface ======
  
-There are several software interfaces available to monitor the status of the RECS<sup>(r)</sup>%%|%%Box system. These are the Management Web****GUI and a REST API providing XML based monitoring and management functionality. The Nagios NRPE interface was removed in RECS<sup>(r)</sup>%%|%%Box 4 products.+There are several software interfaces available to monitor the status of the RECS<sup>(r)</sup>%%|%%Box system. These are the Management Web****GUI, a REST API providing XML based monitoring and management functionality and a native NRPE based Nagios interface.
  
 ===== Management WebGUI ===== ===== Management WebGUI =====
Line 283: Line 283:
 Information about the success or failure of management requests are returned via HTTP status codes. Please have a look at [[http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html|RFC2616]] for an overview about the defined HTTP status codes. Information about the success or failure of management requests are returned via HTTP status codes. Please have a look at [[http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html|RFC2616]] for an overview about the defined HTTP status codes.
  
 +===== Nagios API =====
 +
 +The software integration work to monitor the RECS<sup>(r)</sup>%%|%%Box System is quite simple as the the TOR-Master provides monitoring information in the Nagios native NRPE format. So only the NRPE plugin has to be installed and configured as follows. Here, a sample output can be found:
 +
 +<code bash>$ /usr/lib/nagios/plugins/check_nrpe -H 10.11.12.244 \
 +            -c check_temp -a 10.11.12.244 10 2 70:104 105:
 +
 +OK - Temperature: 29 C|temp=29,000000;70:104;105;70,000000;105,000000
 +</code>
 +
 +The options are used as following: \\
 +
 +^ Option ^ Description ^
 +| ''-H'' | Host to ask for data, this is always the IP of the TOR-Master (example: 10.11.12.244) |
 +| ''-c'' | Plugin to run. Can be ''check_temp'' or ''check_power'' |
 +| ''-a'' | Arguments to pass to the plugin, see more details in tables below |
 +
 +Arguments for ''check_temp'' plugin: \\
 +
 +^ Argument example ^ Description ^
 +| ''10.11.12.244'' | Get sensor values from device with this IP (RCU/RPU) |
 +| ''10'' | Get sensor values from this baseboard (''1'' - ''18'') |
 +| ''2'' | Get values from this sensor (''max'', ''inlet'', ''outlet'', ''0'', ''1'', ''2'', ''3'', ''4'') |
 +| ''70:104'' | Range of warning threshold |
 +| ''105'' | Range critical threshold (ending with '':'' means open end) |
 +
 +Arguments for the ''check_power'' plugin: \\
 +
 +^ Argument example ^ Description ^
 +| ''10.11.12.244'' | Get sensor values from device with this IP (RCU/RPU) |
 +| ''10'' | Get sensor values from this baseboard (''1'' - ''18'') |    
 +| ''2'' | Get sensor values from this node (''1'', ''2'', ''3'', ''4'') |
 +| ''80:109'' | Range of warning threshold [Watt] |
 +| ''110:'' | Range of critical threshold [Watt] (ending with '':'' means open end|