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
doc_trecs:software_interface [2023/11/24 14:27] – complete rework with new images and REST-API update bildoc_trecs:software_interface [2023/11/28 08:54] (current) – [Components] bil
Line 15: Line 15:
 On the left side is a menu, which can be toggled by clicking the menu button in the upper left corner of the screen. The menu contains the following items: On the left side is a menu, which can be toggled by clicking the menu button in the upper left corner of the screen. The menu contains the following items:
  
-[[documentation:software_interface#Dashboard|Dashboard]]: General overview of the managed system, installed nodes and health status\\ +[[doc_trecs:software_interface#Dashboard|Dashboard]]: General overview of the managed system, installed nodes and health status\\ 
-[[documentation:software_interface#Management|Management]]: Power control and monitoring for all nodes and fans\\ +[[doc_trecs:software_interface#Management|Management]]: Power control and monitoring for all nodes and fans\\ 
-[[documentation:software_interface#Network|Network]]: VLAN-Configuration and of management network\\ +[[doc_trecs:software_interface#Network|Network]]: VLAN-Configuration and of management network\\ 
-[[documentation:software_interface#Composition|Composition]]: Configuration of PCIe resources\\ +[[doc_trecs:software_interface#Composition|Composition]]: Configuration of PCIe resources\\ 
-[[documentation:software_interface#Users|Users]]: User management\\ +[[doc_trecs:software_interface#Users|Users]]: User management\\ 
-[[documentation:software_interface#Settings|Settings]]: System-wide configuration settings\\ +[[doc_trecs:software_interface#Settings|Settings]]: System-wide configuration settings\\ 
-[[documentation:software_interface#Time|Time]]: System time settings\\ +[[doc_trecs:software_interface#Time|Time]]: System time settings\\ 
-[[documentation:software_interface#Firmware|Firmware]]: Firmware updates and overview of software versions\\ +[[doc_trecs:software_interface#Firmware|Firmware]]: Firmware updates and overview of software versions\\ 
-[[documentation:software_interface#Logs|Logs]]: Logs from the management software about system health and java messages.\\+[[doc_trecs:software_interface#Logs|Logs]]: Logs from the management software about system health and java messages.\\
  
 ==== Dashboard ==== ==== Dashboard ====
Line 37: Line 37:
 Multiple nodes can be controled at once via the panel "Batch-Control Nodes".\\ Multiple nodes can be controled at once via the panel "Batch-Control Nodes".\\
 The view also shows fan monitoring data and allows a detailed look at the temperature map of the system's baseboard.\\ The view also shows fan monitoring data and allows a detailed look at the temperature map of the system's baseboard.\\
-By clicking on a node label, the respective [[documentation:software_interface#Node Management|Node Management]] view is opened.\\+By clicking on a node label, the respective [[doc_trecs:software_interface#Node Management|Node Management]] view is opened.\\
 Furthermore the view displays the summarized system health status. Furthermore the view displays the summarized system health status.
  
Line 151: Line 151:
 Response: Response:
 <code xml> <code xml>
-<rcu name="RCUMaster (192.168.XX.YY)" fanSpeed="100" fanProfile="Manual" health="OK" ip="192.168.XX.YY" kvmNode="RCU_10995770589198_BB_1_0" lastSensorUpdate="1700812747947" type="TRECS" id="RCU_10995770589198">+<rcu name="RCUMaster (192.168.XX.YY)" fanSpeed="100" fanProfile="Manual" health="OK" ip="192.168.XX.YY" kvmNode="RCU_10995770589198_BB_1_0" lastSensorUpdate="1700812747947" type="t.RECS" id="RCU_10995770589198">
   <temperature>   <temperature>
     <sensor name="Node average temperature" unit="°C" health="OK">35.60748455616409</sensor>     <sensor name="Node average temperature" unit="°C" health="OK">35.60748455616409</sensor>
Line 207: Line 207:
 Response: Response:
 <code xml> <code xml>
-<baseboard type="TRECS" expansionBoardInserted="false" health="OK" lastSensorUpdate="1700825809191" rcuPosition="1" id="RCU_10995770589198_BB_1">+<baseboard type="t.RECS" expansionBoardInserted="false" health="OK" lastSensorUpdate="1700825809191" rcuPosition="1" id="RCU_10995770589198_BB_1">
   <fan>RCU_10995770589198_Fan_TRECS_1</fan>   <fan>RCU_10995770589198_Fan_TRECS_1</fan>
   <fan>RCU_10995770589198_Fan_TRECS_2</fan>   <fan>RCU_10995770589198_Fan_TRECS_2</fan>
Line 258: Line 258:
 |''power'' |List of power sensors|W|Double |''power'' |List of power sensors|W|Double
 |''temperature'' |List of temperature sensors|°C|Double| |''temperature'' |List of temperature sensors|°C|Double|
-|''voltage'' |List of temperature sensors|V|Double|+|''voltage'' |List of voltage sensors|V|Double|
  
  
Line 270: Line 270:
 Response: Response:
 <code xml> <code xml>
-<node baseboardPosition="0" health="OK" lastSensorUpdate="1700825860193" name="Node 1" type="COMHPC_SERVER" maxPowerUsage="44" powerState="On" id="RCU_10995770589198_BB_1_0">+<node baseboardPosition="0" health="OK" lastSensorUpdate="1700825860193" name="Node 1" type="COM-HPC Server" maxPowerUsage="44" powerState="On" id="RCU_10995770589198_BB_1_0">
   <baseboard>RCU_10995770589198_BB_1</baseboard>   <baseboard>RCU_10995770589198_BB_1</baseboard>
   <deamon/>   <deamon/>
Line 277: Line 277:
     <sensor name="Node 1 power" unit="W" health="OK">121,2</sensor>     <sensor name="Node 1 power" unit="W" health="OK">121,2</sensor>
   </power>   </power>
-  <processor> +  <processor instructionSet="x86-64" architecture="x86" type="CPU" cores="4" threads="8" maxSpeedMHz="2800" manufacturer="Intel" model="Xeon E3-1505M v5" />
-    <manufacturer>Intel</manufacturer> +
-    <model>Xeon E3-1505M v5</model> +
-    <instructionSet>X86_64</instructionSet> +
-    <maxSpeedMHz>2800</maxSpeedMHz> +
-    <processorArchitecture>X86</processorArchitecture> +
-    <processorType>CPU</processorType> +
-    <totalCores>4</totalCores> +
-    <totalThreads>8</totalThreads> +
-  </processor>+
   <temperature>   <temperature>
     <sensor name="Node 1 inlet temperature" unit="°C" health="OK">23.0416142616874</sensor>     <sensor name="Node 1 inlet temperature" unit="°C" health="OK">23.0416142616874</sensor>
Line 319: Line 310:
 |''processor'' |List of processors of this node with detailed information|-|-| |''processor'' |List of processors of this node with detailed information|-|-|
 |''temperature'' |List of temperature sensors|°C|Double| |''temperature'' |List of temperature sensors|°C|Double|
-|''voltage'' |List of temperature sensors|V|Double|+|''voltage'' |List of voltage sensors|V|Double|
  
-The API offers nodeList which returns a list of node IDs.+The API offers nodeList, which returns a list of the IDs of all nodes within the system.
  
 Request: Request:
Line 347: Line 338:
 Response: Response:
 <code xml> <code xml>
-<fan position="TRECS_1" installed="true" nominalSpeed="100" rpm="11766.0" health="OK" lastSensorUpdate="0" id="RCU_10995770589198_Fan_TRECS_1" />+<fan position="TRECS_1" installed="true" nominalSpeed="100" rpm="11766" health="OK" lastSensorUpdate="0" id="RCU_10995770589198_Fan_TRECS_1" />
 </code> </code>
  
Line 361: Line 352:
 |''id''|ID for referencing the component|-|String| |''id''|ID for referencing the component|-|String|
  
-The API offers nodeList which returns a list of node IDs.+The API offers fanList, which returns a list of the IDs of all fans within the system.
  
 Request: Request: