public_git/pikvm
1
0
Fork 0
mirror of https://github.com/pikvm/pikvm.git synced 2026-10-21 11:35:03 +02:00
Code Issues Projects Releases Wiki Activity

update

Browse Source
This commit is contained in:
Maxim Devaev
2025-02-11 02:36:39 +02:00
parent 8c962a33eb
commit dceeebc2f9
3 changed files with 184 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ipmi.md
+60 -66
View File
@@ -1,103 +1,97 @@
# IPMI & Redfish
!!! info
This page is about the server-side emulation (if you want to manage PiKVM using ipmitool or so). If you want to use the PiKVM Web UI to manage the server using IPMI (that is, as an IPMI client), see [GPIO functions with IPMI plugin](gpio.md).
This page is about the server-side IPMI emulation if you want to manage PiKVM using `ipmitool` or something similar.
If you want to use the PiKVM Web UI to manage the server using IPMI (that is, as an IPMI client),
see [GPIO functions with IPMI plugin](gpio.md).
!!! warning
Although PiKVM supports the IPMI protocol, we strongly recommend that you **DO NOT USE IT** outside of trusted networks
due to the protocol's [insecurity](https://github.com/NitescuLucian/nliplace.com.blog.drafts).
Please consider to using the Redfish or [KVMD API](api.md) instead of it.
Also, IPMI can not work with [2FA](auth.md#two-factor-authentication).
----
## IPMI BMC
IPMI is an [old protocol](https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface) for remote server management.
IPMI is a [legacy protocol](https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface) for remote server management.
It can be useful for managing a large number of machines with PiKVM. Its advantage is that it is supported by many enterprise systems.
!!! warning
Although PiKVM supports the IPMI protocol, we strongly recommend that you **DO NOT USE IT** outside of trusted networks due to the protocol's [insecurity](https://github.com/NitescuLucian/nliplace.com.blog.drafts). Use Redfish or [KVMD API](api.md) instead of it. Also IPMI can not work with [2FA](auth.md#two-factor-authentication).
??? example "Step by step: Enabling IPMI server on PiKVM"
To enable IPMI BMC follow these steps:
1. Switch the filesystem to the RW-mode:
1. Switch the filesystem to the RW-mode:
```console
[root@pikvm ~]# rw
```
```
# rw
```
2. Set up IPMI account in file `/etc/kvmd/ipmipasswd` (see the comment inside it).
2. Setup IPMI account in file `/etc/kvmd/ipmipasswd`.
3. Enable the `kvmd-ipmi` daemon:
3. Enable `kvmd-ipmi` daemon:
```console
[root@pikvm ~]# systemctl enable --now kvmd-ipmi
```
```
# systemctl enable --now kvmd-ipmi
```
4. Switch the filesystem back to the RO:
4. Switch the filesystem back to the RO:
```console
[root@pikvm ~]# ro
```
```
# ro
```
5. Try some commands on the client PC:
5. Here some examples (on the remote PC):
```
$ ipmitool -I lanplus -U admin -P admin -H pikvm power status
$ ipmitool -I lanplus -U admin -P admin -H pikvm power on
```
```console
$ ipmitool -I lanplus -U admin -P admin -H pikvm power status
$ ipmitool -I lanplus -U admin -P admin -H pikvm power on
```
----
## IPMI SoL
IPMI supports the ability to get console access to the server using Serial-over-LAN. PiKVM can act as a proxy for your server's COM port.
IPMI supports the ability to get console access to the server using Serial-over-LAN.
With this feature PiKVM will act as a proxy for your server's COM port.
!!! warning
Although PiKVM supports the IPMI protocol, we strongly recommend that you **DO NOT USE IT** outside of trusted networks due to the protocol's [insecurity](https://github.com/NitescuLucian/nliplace.com.blog.drafts). Use Redfish or [KVMD API](api.md) instead of it.
To use this feature, you will need a USB-COM adapter that you need to connect to the PiKVM.
The COM port of the adapter need to be connected to the server.
To use this feature, you will need a USB-COM adapter that you need to connect to the PiKVM. The COM port of the adapter need to be connected to the server. As with IPMI BMC, you need to configure `kvmd-vnc` and add the following configuration to `/etc/kvmd/override.yaml`:
??? example "Step by step: Enabling IPMI SoL for USB-COM adapter"
```yaml
ipmi:
sol:
device: /dev/ttyUSB0 # Path of your USB-COM adapter
speed: 115200
```
As with IPMI BMC, you need to configure `kvmd-ipmi` server (see the previous chapter about IPMI BMC)
and add the following configuration to `/etc/kvmd/override.yaml`:
After enabling `kvmd-ipmi`, all requests that it receives over the network regarding the COM port will be forwarded to your server. For example:
```yaml
ipmi:
sol:
device: /dev/ttyUSB0 # Path of your USB-COM adapter
speed: 115200
```
```
$ ipmitool -I lanplus -U admin -P admin -H pikvm sol activate
```
Then restart the `kvmd-ipmi` server: `systemctl restart kvmd-ipmi`.
All requests that it receives over the network regarding the COM port will be forwarded to your server. For example:
```console
[root@pikvm ~]$ ipmitool -I lanplus -U admin -P admin -H pikvm sol activate
```
----
## Redfish
[Redfish](https://www.dmtf.org/standards/redfish) is a more modern server management protocol designed to replace IPMI.
It is based on HTTP and fixes many security issues. If possible, we recommend using it instead of IPMI, or using the [KVMD API](api.md).
There're not special actions required to use Redfish. In addition, Redfish will use regular PiKVM credentials.
But for systems that have been upgraded to KVMD 2.0 (not a clean image installation), you will probably need to edit
the `/etc/kvmd/nginx/kvmd.ctx-server.conf` file to add these lines at the end:
PiKVM supports the Redfish natively and provides a power management handles with it.
```nginx
location /redfish {
proxy_pass http://kvmd;
include /etc/kvmd/nginx/loc-proxy.conf;
auth_request off;
}
```
To access the Redfish API, use HTTP Basic Auth methods. Also you can use the [redfishtool](https://github.com/DMTF/Redfishtool):
!!! info
Don't be confused by the parameter `auth_request off`. KVMD performs authorization on its own. The only open HTTP entrypoint is `/redfish/v1`, which returns a static document and does not change the state of the PiKVM. It's safe.
If there is a file in your system after the update `/etc/kvmd/nginx/kvmd.ctx-server.conf.pacnew` you can just move it:
```
# mv /etc/kvmd/nginx/kvmd.ctx-server.conf.pacnew /etc/kvmd/nginx/kvmd.ctx-server.conf
```
!!! warning
Be careful not to lose your local changes if you have done anything with this file before.
To access the Redfish API, use HTTP Basic Auth. Also you can use the [redfishtool](https://github.com/DMTF/Redfishtool):
```
$ redfishtool -S Never -r pikvm root
$ redfishtool -S Never -u admin -p admin -r pikvm Systems
$ redfishtool -S Never -u admin -p admin -r pikvm Systems reset ForceOff
```console
[root@pikvm ~]$ redfishtool -S Never -r pikvm root
[root@pikvm ~]$ redfishtool -S Never -u admin -p admin -r pikvm Systems
[root@pikvm ~]$ redfishtool -S Never -u admin -p admin -r pikvm Systems reset ForceOff
```