meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
documentation:software_interface [2020/12/16 11:17] – old revision restored (2020/11/13 12:10) vor | documentation:software_interface [2020/12/16 11:19] (current) – removed vor | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Software interface ====== | ||
- | There are several software interfaces available to monitor the status of the RECS< | ||
- | |||
- | ===== Management WebGUI ===== | ||
- | |||
- | The Management Web****GUI is established on every RECS< | ||
- | |||
- | In general these symbols have the following meaning on every page: \\ | ||
- | |||
- | |{{ : | ||
- | |{{ : | ||
- | |{{ : | ||
- | |||
- | 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: | ||
- | [[documentation: | ||
- | [[documentation: | ||
- | [[documentation: | ||
- | |||
- | 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. | ||
- | |||
- | ==== Overview ==== | ||
- | |||
- | All units that are installed in the rack and that are managed by the software are summarized on this page. | ||
- | The total power usage is summed up over all managed units. | ||
- | |||
- | < | ||
- | {{ : | ||
- | |||
- | ==== 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: | ||
- | |||
- | < | ||
- | |||
- | A quick menu to control a node can be opened by klicking on the gear next to an CXP node. In this menu the node can be switched on and off and the KVM can be switched to the node. | ||
- | |||
- | < | ||
- | |||
- | <WRAP round tip> | ||
- | Apalis nodes do not show a management pop-up button due to size constraints.\\ Click on the node button while pressing the " | ||
- | </ | ||
- | |||
- | <WRAP round tip> | ||
- | When pressing the " | ||
- | </ | ||
- | |||
- | === Node management === | ||
- | |||
- | On this page the selected node can be controlled and detailed status values and graphs can be seen.\\ | ||
- | By klicking on the arrow, pointing downwards in the upper bar next to the nodename, the other nodes of the unit can be chosen. | ||
- | |||
- | < | ||
- | |||
- | ==== Global settings ==== | ||
- | |||
- | All IP< | ||
- | The firmware for the whole RECS< | ||
- | For the update process **all modules will be powered off!**\\ | ||
- | |||
- | < | ||
- | |||
- | ==== 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 java tab of the log page all messages regarding the software can be found. | ||
- | |||
- | < | ||
- | |||
- | 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. | ||
- | |||
- | ===== Redfish API ===== | ||
- | |||
- | The documentation of the RECS< | ||
- | |||
- | ===== REST API ===== | ||
- | |||
- | ==== Access ==== | ||
- | |||
- | The RECS< | ||
- | |||
- | Accessing the REST API requires HTTP Basic authentication. The authenticated user has to be in the " | ||
- | |||
- | ==== Components ==== | ||
- | |||
- | The RECS< | ||
- | |||
- | ^ Attribute ^ Description ^ | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |||
- | Many resources also return lists of components. These are named according to the scheme < | ||
- | |||
- | Example of a backplaneList: | ||
- | |||
- | <code xml>< | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | </ | ||
- | |||
- | === Node === | ||
- | |||
- | Example XML: | ||
- | |||
- | <code xml>< | ||
- | actualPEGPowerUsage=" | ||
- | baseBoardId=" | ||
- | lastSensorUpdate=" | ||
- | highestTemperature=" | ||
- | |||
- | The following table shows the possible attributes (some are optional) and their meaning: \\ | ||
- | |||
- | ^ Attribute ^ Description ^ Unit ^ Data type ^ | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |||
- | In accordance to the component node the API offers nodeList which returns multiple instances of node. | ||
- | |||
- | === Backplane === | ||
- | |||
- | Example XML: | ||
- | |||
- | <code xml>< | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | |||
- | The attributes have the following meaning: \\ | ||
- | |||
- | ^ Attribute ^ Description ^ Unit ^ Data type ^ | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |||
- | In accordance to the component backplane the API offers backplaneList which returns multiple instances of backplane. | ||
- | |||
- | === Baseboard === | ||
- | |||
- | Example XML: | ||
- | |||
- | <code xml>< | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | |||
- | The attributes have the following meaning: \\ | ||
- | |||
- | ^ Attribute ^ Description ^ Unit ^ Data type ^ | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |||
- | In accordance to the component baseboard the API offers baseboardList which returns multiple instances of baseboard. | ||
- | |||
- | === RCU === | ||
- | |||
- | Example XML: | ||
- | |||
- | <code xml>< | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | |||
- | The attributes have the following meaning: \\ | ||
- | |||
- | ^ Attribute ^ Description ^ Unit ^ Data type ^ | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |||
- | In accordance to the component rcu the API offers rcuList which returns multiple instances of rcu. | ||
- | |||
- | === Rack === | ||
- | |||
- | Example XML: | ||
- | |||
- | <code xml>< | ||
- | < | ||
- | </ | ||
- | |||
- | The attributes have the following meaning: \\ | ||
- | |||
- | ^ Attribute ^ Description ^ Unit ^ Data type ^ | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |||
- | In accordance to the component rack the API offers rackList which returns multiple instances of rack. | ||
- | |||
- | ==== Resources ==== | ||
- | |||
- | The resources are split into monitoring resources (for pure information gathering) and management resources (for changing the system configuration or state). | ||
- | |||
- | === Monitoring === | ||
- | |||
- | For monitoring the following resources are available: \\ | ||
- | |||
- | ^ Attribute ^ Description ^ HTTP Method ^ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |||
- | === Management === | ||
- | |||
- | The management of individual components can be found under the " | ||
- | |||
- | ^ Attribute ^ Description ^ HTTP method ^ Parameter ^ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |''/ | ||
- | |||
- | === Errors === | ||
- | |||
- | Information about the success or failure of management requests are returned via HTTP status codes. Please have a look at [[http:// | ||
- | |||
- | ===== Nagios API ===== | ||
- | |||
- | The software integration work to monitor the RECS< | ||
- | |||
- | <code bash>$ / | ||
- | -c check_temp -a 10.11.12.244 10 2 70:104 105: | ||
- | |||
- | OK - Temperature: | ||
- | </ | ||
- | |||
- | The options are used as following: \\ | ||
- | |||
- | ^ Option ^ Description ^ | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | |||
- | Arguments for '' | ||
- | |||
- | ^ Argument example ^ Description ^ | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | |||
- | Arguments for the '' | ||
- | |||
- | ^ Argument example ^ Description ^ | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' | ||
- | | '' |