mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-06-12 08:10:12 +00:00
Separate out the hardware management section into multiple files.
This allows us to better describe certain commands in more detail. rcons file has changes pertaining to OpenBMC specific information advanced hardware commands have not been revised, but I went through the basic commands.
This commit is contained in:
Victor Hu
@ -13,7 +13,7 @@ IBM OpenPower Servers
|
||||
|
||||
configure/index.rst
|
||||
discovery/index.rst
|
||||
management.rst
|
||||
management/index.rst
|
||||
diskful/index.rst
|
||||
diskless/index.rst
|
||||
statelite/index.rst
|
||||
|
||||
@ -1,124 +0,0 @@
|
||||
Hardware Management
|
||||
===================
|
||||
|
||||
Basic Operation
|
||||
---------------
|
||||
|
||||
The Beacon Light
|
||||
````````````````
|
||||
|
||||
Most of modern enterprise level server machines have LEDs installed on their front panel and/or rear panel, which are called beacon lights. When this light has been turned on, the system administrator can use this light to indicate one physical machine out of a bunch of enclosures in a server frame. It makes life easier.
|
||||
|
||||
With xCAT, the end user can turn the beacon light on or off with the commands show below. ::
|
||||
|
||||
rbeacon cn1 on
|
||||
rbeacon cn1 off
|
||||
|
||||
The current state of the beacon light can not be queried remotely. As a workaround, one can always use the ``rbeacon`` command to turn all the beacon lights in one frame off, and then turn a particular beacon light on. ::
|
||||
|
||||
rbeacon a_group_of_cn off
|
||||
rbeacon cn5 on
|
||||
|
||||
Remote Power Control
|
||||
````````````````````
|
||||
|
||||
The next important thing is to control the power of a remote physical machine. For this purpose, ``rpower`` command is involved. ::
|
||||
|
||||
rpower cn1 on
|
||||
rpower cn1 off
|
||||
|
||||
In order to reboot a remote physical machine, run ::
|
||||
|
||||
rpower cn1 boot
|
||||
|
||||
Or do a hardware reset, run ::
|
||||
|
||||
rpower cn1 reset
|
||||
|
||||
Get the current rpower state of a machine, refer to the example below. ::
|
||||
|
||||
# rpower cn1 state
|
||||
cn1: Running
|
||||
|
||||
Remote Console
|
||||
``````````````
|
||||
|
||||
Most enterprise level servers do not have video adapters installed with the machine. Meaning, the end user can not connect a monitor to the machine and get display output. In most cases, the console can be viewed using the serial port or LAN port, through Serial-over-LAN. Serial cable or network cable are used to get a command line interface of the machine. From there, the end user can get the basic machine booting information, firmware settings interface, local command line console, etc.
|
||||
|
||||
In order to get the command line console remotely. xCAT provides the ``rcons`` command.
|
||||
|
||||
#. Make sure the ``conserver`` is configured by running ``makeconservercf``.
|
||||
|
||||
#. Check if the ``conserver`` is up and running ::
|
||||
|
||||
ps ax | grep conserver
|
||||
|
||||
#. If ``conserver`` is not running, start ::
|
||||
|
||||
[sysvinit] service conserver start
|
||||
[systemd] systemctl start conserver.service
|
||||
|
||||
or restart, if changes to the configuration were made ::
|
||||
|
||||
[sysvinit] service conserver restart
|
||||
[systemd] systemctl restart conserver.service
|
||||
|
||||
|
||||
#. After that, you can get the command line console for a specific machine with the ``rcons`` command ::
|
||||
|
||||
rcons cn1
|
||||
|
||||
Advanced operation
|
||||
------------------
|
||||
|
||||
Remote Hardware Inventory
|
||||
`````````````````````````
|
||||
|
||||
When you have a lot of physical machines in one place, the most important thing is identify which is which. Mapping the model type and/or serial number of a machine with its host name. Command ``rinv`` is involved in such a situation. With this command, most of the important information to distinct one machine from all the others can be obtained remotely.
|
||||
|
||||
To get all the hardware information, which including the model type, serial number, firmware version, detail configuration, et al. ::
|
||||
|
||||
rinv cn1 all
|
||||
|
||||
As an example, in order to get only the information of firmware version, the following command can be used. ::
|
||||
|
||||
rinv cn1 firm
|
||||
|
||||
Remote Hardware Vitals
|
||||
``````````````````````
|
||||
|
||||
Collect runtime information from running physical machine is also a big requirement for real life system administrators. This kind of information includes, temperature of CPU, internal voltage of particular socket, wattage with workload, speed of cooling fan, et al.
|
||||
|
||||
In order to get such information, use ``rvitals`` command. This kind of information varies among different model types of the machine. Thus, check the actual output of the ``rvitals`` command against your machine, to verify which kinds of information can be extracted. The information may change after the firmware update of the machine. ::
|
||||
|
||||
rvitals cn1 all
|
||||
|
||||
As an example, get only the temperature information of a particular machine. ::
|
||||
|
||||
rvitals cn1 temp
|
||||
|
||||
Firmware Updating
|
||||
`````````````````
|
||||
|
||||
For OpenPOWER machines, use the ``rflash`` command to update firmware.
|
||||
|
||||
Check firmware version of the node and the HPM file: ::
|
||||
|
||||
rflash cn1 -c /firmware/8335_810.1543.20151021b_update.hpm
|
||||
|
||||
Update node firmware to the version of the HPM file
|
||||
|
||||
::
|
||||
|
||||
rflash cn1 /firmware/8335_810.1543.20151021b_update.hpm
|
||||
|
||||
Configures Nodes' Service Processors
|
||||
````````````````````````````````````
|
||||
|
||||
Here comes the command, ``rspconfig``. It is used to configure the service processor of a physical machine. On a OpenPower system, the service processor is the BMC, Baseboard Management Controller. Various variables can be set through the command. Also notice, the actual configuration may change among different machine-model types.
|
||||
|
||||
Examples
|
||||
|
||||
To turn on SNMP alerts for cn5: ::
|
||||
|
||||
rspconfig cn5 alert=on
|
||||
@ -0,0 +1,10 @@
|
||||
Advanced Operations
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
rinv.rst
|
||||
rvitals.rst
|
||||
rflash.rst
|
||||
rspconfig.rst
|
||||
@ -0,0 +1,15 @@
|
||||
``rflash`` - Remote Firmware Flashing
|
||||
=====================================
|
||||
|
||||
For OpenPOWER machines, use the ``rflash`` command to update firmware.
|
||||
|
||||
Check firmware version of the node and the HPM file: ::
|
||||
|
||||
rflash cn1 -c /firmware/8335_810.1543.20151021b_update.hpm
|
||||
|
||||
Update node firmware to the version of the HPM file
|
||||
|
||||
::
|
||||
|
||||
rflash cn1 /firmware/8335_810.1543.20151021b_update.hpm
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
``rinv`` - Remote Hardware Inventory
|
||||
====================================
|
||||
|
||||
When you have a lot of physical machines in one place, the most important thing is identify which is which. Mapping the model type and/or serial number of a machine with its host name. Command ``rinv`` is involved in such a situation. With this command, most of the important information to distinct one machine from all the others can be obtained remotely.
|
||||
|
||||
To get all the hardware information, which including the model type, serial number, firmware version, detail configuration, et al. ::
|
||||
|
||||
rinv cn1 all
|
||||
|
||||
As an example, in order to get only the information of firmware version, the following command can be used. ::
|
||||
|
||||
rinv cn1 firm
|
||||
|
||||
@ -0,0 +1,10 @@
|
||||
``rspconfig`` - Remote Configuration of Service Processors
|
||||
==========================================================
|
||||
|
||||
Here comes the command, ``rspconfig``. It is used to configure the service processor of a physical machine. On a OpenPower system, the service processor is the BMC, Baseboard Management Controller. Various variables can be set through the command. Also notice, the actual configuration may change among different machine-model types.
|
||||
|
||||
Examples
|
||||
|
||||
To turn on SNMP alerts for cn5: ::
|
||||
|
||||
rspconfig cn5 alert=on
|
||||
@ -0,0 +1,13 @@
|
||||
``rvitals`` - Remote Hardware Vitals
|
||||
====================================
|
||||
|
||||
Collect runtime information from running physical machine is also a big requirement for real life system administrators. This kind of information includes, temperature of CPU, internal voltage of particular socket, wattage with workload, speed of cooling fan, et al.
|
||||
|
||||
In order to get such information, use ``rvitals`` command. This kind of information varies among different model types of the machine. Thus, check the actual output of the ``rvitals`` command against your machine, to verify which kinds of information can be extracted. The information may change after the firmware update of the machine. ::
|
||||
|
||||
rvitals cn1 all
|
||||
|
||||
As an example, get only the temperature information of a particular machine. ::
|
||||
|
||||
rvitals cn1 temp
|
||||
|
||||
@ -0,0 +1,9 @@
|
||||
Basic Operations
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
rbeacon.rst
|
||||
rpower.rst
|
||||
rcons.rst
|
||||
@ -0,0 +1,14 @@
|
||||
``rbeacon`` - Beacon Light
|
||||
==========================
|
||||
|
||||
See :doc:`rbeacon manpage </guides/admin-guides/references/man1/rbeacon.1>` for more information.
|
||||
|
||||
|
||||
Most enterprise level servers have LEDs on their front and/or rear panels, one of which is a beacon light. If turned on, this light can help assist the system administrator locate one physical machine out of a large number of machines in a frame.
|
||||
|
||||
Using xCAT, administrators can turn on and off the beacon light using: ``rbeacon <node> on|off``
|
||||
|
||||
There's currently no way to query whether the beacon light is on or off. To work around, first turn off all the lights and then turn on the beacon for the machine you wish to identify: ::
|
||||
|
||||
rbeacon <noderange> off
|
||||
rbeacon <node> on
|
||||
@ -0,0 +1,53 @@
|
||||
``rcons`` - Remote Console
|
||||
==========================
|
||||
|
||||
See :doc:`rcons manpage </guides/admin-guides/references/man1/rcons.1>` for more information.
|
||||
|
||||
Most enterprise servers do not have video adapters installed with the machine and often do not provide a method for attaching a physical monitor/keyboard/mouse to get the display output. For this purpose xCAT can assist the system administrator to view the console over a "Serial-over-LAN" (SOL) connection through the BMC.
|
||||
|
||||
Configure the correct console management by modifying the node definition:
|
||||
|
||||
* For OpenPower, **IPMI** managed server: ::
|
||||
|
||||
chdef -t node -o <noderange> cons=ipmi
|
||||
|
||||
* For OpenPower, **OpenBMC** managed servers: ::
|
||||
|
||||
chdef -t node -o <noderange> cons=openbmc
|
||||
|
||||
Open a console to ``compute1``: ::
|
||||
|
||||
rcons compute1
|
||||
|
||||
**Note:** The keystroke ``ctrl+E C .`` will disconnect you from the console.
|
||||
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
General
|
||||
```````
|
||||
|
||||
The xCAT ``rcons`` command relies on conserver (http://www.conserver.com/). The ``conserver`` package should have been installed with xCAT as it's part of the xCAT dependency package. If you are having problems seeing the console, try the following.
|
||||
|
||||
#. Make sure ``conserver`` is configured by running ``makeconservercf``.
|
||||
|
||||
#. Check if ``conserver`` is up and running ::
|
||||
|
||||
[sysvinit] service conserver status
|
||||
[systemd] systemctl status conserver.service
|
||||
|
||||
#. If ``conserver`` is not running, start the service using: ::
|
||||
|
||||
[sysvinit] service conserver start
|
||||
[systemd] systemctl start conserver.service
|
||||
|
||||
#. After this, try invoking the console again: ``rcons <node>``
|
||||
|
||||
|
||||
OpenBMC Spcific
|
||||
```````````````
|
||||
|
||||
#. For OpenBMC managed servers, the root user must be able to ssh passwordless to the BMC for the ``rcons`` function to work.
|
||||
|
||||
Copy the ``/root/.ssh/id_rsa.pub`` public key to the BMC's ``~/.ssh/authorized_keys`` file.
|
||||
@ -0,0 +1,15 @@
|
||||
``rpower`` - Remote Power Control
|
||||
=================================
|
||||
|
||||
See :doc:`rpower manpage </guides/admin-guides/references/man1/rpower.1>` for more information.
|
||||
|
||||
Use the ``rpower`` command to remotely power on and off a single server or a range of server. ::
|
||||
|
||||
rpower <noderange> on
|
||||
rpower <noderange> off
|
||||
|
||||
Other actions include:
|
||||
|
||||
* To get the current power state of a server: ``rpower <noderange> state``
|
||||
* To boot/reboot a server: ``rpower <noderange> boot``
|
||||
* To hardware reset a server: ``rpower <noderange> reset``
|
||||
@ -0,0 +1,8 @@
|
||||
Hardware Management
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
basic/index.rst
|
||||
advanced/index.rst
|
||||
Reference in New Issue
Block a user