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
Next revision		Previous revision
Last revisionBoth sides next revision
documentation:software_interface [2016/11/03 13:58] – vordocumentation:software_interface [2020/12/16 11:17] – old revision restored (2020/11/13 12:10) vor
Line 15: Line 15:
 Figure 1 shows the first call of the Management Web****GUI. It is organized into three columns. The first is on the left-hand side and contains the following: Figure 1 shows the first call of the Management Web****GUI. It is organized into three columns. The first is on the left-hand side and contains the following:
  
-[[documentation:management_webgui#overview|Overview:]] General overview of all managed RCU<sup></sup>s, RPU<sup></sup>s, installed nodes and health status\\ +[[documentation:software_interface#Overview|Overview:]] General overview of all managed RCU<sup></sup>s, RPU<sup></sup>s, installed nodes and health status\\ 
-[[documentation:management|Management:]] Selection of every managed RCU and RPU in the rack with a sensor view button for the Arneb\\ +[[documentation:software_interface#Management|Management:]] Selection of every managed RCU and RPU in the rack with a sensor view button for the Arneb\\ 
-[[documentation:global_settings|Global settings:]] IP filter and firmware update\\ +[[documentation:software_interface#Global settings|Global settings:]] IP filter and firmware update\\ 
-[[documentation:log_viewer|Log:]] Logs from the management software about system health and java messages. The logs can be downloaded as a zipfile\\+[[documentation:software_interface#Log Viewer|Log:]] Logs from the management software about system health and java messages. The logs can be downloaded as a zipfile\\
  
 The second colum contains the buttons and sliders to manipulate the system. While the third colum is mostly for history information like power usage and temperature graphs. The second colum contains the buttons and sliders to manipulate the system. While the third colum is mostly for history information like power usage and temperature graphs.
Line 30: Line 30:
 {{ :documentation:web-gui-overview.jpg?direct&500 |Management Overview}}</imgcaption> {{ :documentation:web-gui-overview.jpg?direct&500 |Management Overview}}</imgcaption>
  
-===== Management =====+==== Management ====
  
 An overview of the selected unit can be seen in this tab. The fans can be regulated by dragging the slider to the desired percentage. And multiple nodes can be selected. By klicking on a node the[[documentation:management#node management|Node management]] page of the node is shown. An overview of the selected unit can be seen in this tab. The fans can be regulated by dragging the slider to the desired percentage. And multiple nodes can be selected. By klicking on a node the[[documentation:management#node management|Node management]] page of the node is shown.
Line 48: Line 48:
 </WRAP> </WRAP>
  
-==== Node management ====+=== Node management ===
  
 On this page the selected node can be controlled and detailed status values and graphs can be seen.\\ On this page the selected node can be controlled and detailed status values and graphs can be seen.\\
Line 55: Line 55:
 <imgcaption web-gui-cxp-node-view|>{{ :documentation:web-gui-cxp-node-view.jpg?direct&500 |Node management}}</imgcaption> <imgcaption web-gui-cxp-node-view|>{{ :documentation:web-gui-cxp-node-view.jpg?direct&500 |Node management}}</imgcaption>
  
-===== Global settings =====+==== Global settings ====
  
 All IP<sup></sup>s that are allowed to access the Nagios interface have to be listet here.\\ All IP<sup></sup>s that are allowed to access the Nagios interface have to be listet here.\\
Line 63: Line 63:
 <imgcaption web-gui-global_settings|>{{ :documentation:web-gui-global_settings.jpg?direct&500 |Golobal settings tab}}</imgcaption> <imgcaption web-gui-global_settings|>{{ :documentation:web-gui-global_settings.jpg?direct&500 |Golobal settings tab}}</imgcaption>
  
-===== Log viewer =====+==== Log viewer ====
  
 In the system healths tab of the log page the status changes of the sensors, fan and boards can be seen. In the system healths tab of the log page the status changes of the sensors, fan and boards can be seen.
Line 75: Line 75:
 Several filters can be set for both tabs at the top.\\ Several filters can be set for both tabs at the top.\\
 At the bottom the whole log can be downloaded as a ZIP file containing the individual logfiles. At the bottom the whole log can be downloaded as a ZIP file containing the individual logfiles.
 +
 +===== Redfish API =====
 +
 +The documentation of the RECS<sup>(r)</sup>%%|%%Box Redfish API can be seen at [[https://christmann.github.io/recs-redfish-api/index.html|Github]].
  
 ===== REST API ===== ===== REST API =====
Line 99: Line 103:
 Example of a backplaneList: Example of a backplaneList:
  
-<code><backplaneList>+<code xml><backplaneList>
 <backplane position="1" id="RCU_84055620466592_BP_1" infrastructurePower="0.0"> <backplane position="1" id="RCU_84055620466592_BP_1" infrastructurePower="0.0">
 <temperatures>24.0</temperatures> <temperatures>24.0</temperatures>
Line 113: Line 117:
 Example XML: Example XML:
  
-<code><node baseBoardPosition="0" maxPowerUsage="44" actualNodePowerUsage="32.426884399865166" +<code xml><node baseBoardPosition="0" maxPowerUsage="44" actualNodePowerUsage="32.426884399865166" 
 actualPEGPowerUsage="15.12053962324833" actualPowerUsage="47.54742402311349" architecture="x86"  actualPEGPowerUsage="15.12053962324833" actualPowerUsage="47.54742402311349" architecture="x86" 
 baseBoardId="RCU_84055620466592_BB_1" health="OK" id="RCU_84055620466592_BB_1_0" inletTemperature="20.0"  baseBoardId="RCU_84055620466592_BB_1" health="OK" id="RCU_84055620466592_BB_1_0" inletTemperature="20.0" 
Line 146: Line 150:
 Example XML: Example XML:
  
-<code><backplane position="1" id="RCU_84055620466592_BP_1" infrastructurePower="0.0">+<code xml><backplane position="1" id="RCU_84055620466592_BP_1" infrastructurePower="0.0">
 <temperatures>24.0</temperatures> <temperatures>24.0</temperatures>
 <temperatures>25.0</temperatures> <temperatures>25.0</temperatures>
Line 168: Line 172:
 Example XML: Example XML:
  
-<code><baseBoard rcuPosition="6" baseboardType="APLS" id="RCU_84055620466592_BB_6" infrastructurePower="9.8" rcuId="RCU_84055620466592">+<code xml><baseBoard rcuPosition="6" baseboardType="APLS" id="RCU_84055620466592_BB_6" infrastructurePower="9.8" rcuId="RCU_84055620466592">
 <nodeId>RCU_84055620466592_BB_6_1</nodeId> <nodeId>RCU_84055620466592_BB_6_1</nodeId>
 <nodeId>RCU_84055620466592_BB_6_2</nodeId> <nodeId>RCU_84055620466592_BB_6_2</nodeId>
Line 196: Line 200:
 Example XML: Example XML:
  
-<code><rcu rcuType="ANTARES" fanSpeed="60" rackId="RCK_1" name="RECSMaster (RCU) on 192.168.56.195" rackPosition="0" id="RCU_84055620466592">+<code xml><rcu rcuType="ANTARES" fanSpeed="60" rackId="RCK_1" name="RECSMaster (RCU) on 192.168.56.195" rackPosition="0" id="RCU_84055620466592">
 <backplaneId>RCU_84055620466592_BP_1</backplaneId> <backplaneId>RCU_84055620466592_BP_1</backplaneId>
 <baseBoardId>RCU_84055620466592_BB_1</baseBoardId> <baseBoardId>RCU_84055620466592_BB_1</baseBoardId>
Line 226: Line 230:
 Example XML: Example XML:
  
-<code><rack description="Default rack" id="RCK_1">+<code xml><rack description="Default rack" id="RCK_1">
 <rcuId>RCU_84055620466592</rcuId> <rcuId>RCU_84055620466592</rcuId>
 </rack></code> </rack></code>
Line 283: Line 287:
 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: 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>$ /usr/lib/nagios/plugins/check_nrpe -H 10.11.12.244 \ +<code bash>$ /usr/lib/nagios/plugins/check_nrpe -H 10.11.12.244 \ 
-            -c check_temp -a 10.11.12.244 10 2 30 40+            -c check_temp -a 10.11.12.244 10 2 70:104 105:
  
-OK - Temperature: 29 C|temp=29,000000;30;40;10,000000;105,000000+OK - Temperature: 29 C|temp=29,000000;70:104;105;70,000000;105,000000
 </code> </code>
  
Line 294: Line 298:
 | ''-H'' | Host to ask for data, this is always the IP of the TOR-Master (example: 10.11.12.244) | | ''-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'' | | ''-c'' | Plugin to run. Can be ''check_temp'' or ''check_power'' |
-| ''-a'' | Options to pass to the plugin, see more details in tables below |+| ''-a'' | Arguments to pass to the plugin, see more details in tables below |
  
-Options for ''check_temp'' plugin: \\+Arguments for ''check_temp'' plugin: \\
  
-^ Option example ^ Description ^+^ Argument example ^ Description ^
 | ''10.11.12.244'' | Get sensor values from device with this IP (RCU/RPU) | | ''10.11.12.244'' | Get sensor values from device with this IP (RCU/RPU) |
 | ''10'' | Get sensor values from this baseboard (''1'' - ''18'') | | ''10'' | Get sensor values from this baseboard (''1'' - ''18'') |
 | ''2'' | Get values from this sensor (''max'', ''inlet'', ''outlet'', ''0'', ''1'', ''2'', ''3'', ''4'') | | ''2'' | Get values from this sensor (''max'', ''inlet'', ''outlet'', ''0'', ''1'', ''2'', ''3'', ''4'') |
-| ''30'' | Upper warning threshold | +| ''70:104'' | Range of warning threshold | 
-| ''40'' | Upper critical threshold |+| ''105'' | Range critical threshold (ending with '':'' means open end) |
  
-Options for the ''check_power'' plugin: \\+Arguments for the ''check_power'' plugin: \\
  
-^ Option example ^ Description ^+^ Argument example ^ Description ^
 | ''10.11.12.244'' | Get sensor values from device with this IP (RCU/RPU) | | ''10.11.12.244'' | Get sensor values from device with this IP (RCU/RPU) |
 | ''10'' | Get sensor values from this baseboard (''1'' - ''18'') |     | ''10'' | Get sensor values from this baseboard (''1'' - ''18'') |    
 | ''2'' | Get sensor values from this node (''1'', ''2'', ''3'', ''4'') | | ''2'' | Get sensor values from this node (''1'', ''2'', ''3'', ''4'') |
-| ''30'' | Upper warning threshold [Watt] | +| ''80:109'' | Range of warning threshold [Watt] | 
-| ''40'' | Upper critical threshold [Watt] |+| ''110:'' | Range of critical threshold [Watt] (ending with '':'' means open end|