Cheatsheet: add a section on shutting down PiKVM

This commit is contained in:
Aleksandr Prokudin 2025-09-21 14:56:41 +02:00
parent b7470fca20
commit c80ad8116a
1 changed files with 27 additions and 8 deletions

View File

@ -29,7 +29,7 @@ Here are **first steps guides** for each PiKVM device:
2. Use `su -c` followed by the command wrapped in apostrophes. This will perform the command with root privileges a single time, you will not gain permanent root access. This will For example, to reboot PiKVM, do this: 2. Use `su -c` followed by the command wrapped in apostrophes. This will perform the command with root privileges a single time, you will not gain permanent root access. This will For example, to reboot PiKVM, do this:
`[kvmd-webterm@pikvm ~]$ su -c 'reboot' `[kvmd-webterm@pikvm ~]$ su -c 'reboot'`
The use of `su -c` applies to both SSH and web terminal sessions. The use of `su -c` applies to both SSH and web terminal sessions.
@ -39,7 +39,7 @@ Here are **first steps guides** for each PiKVM device:
{!_update_os.md!} {!_update_os.md!}
??? note "Connect to PiKVM via SSH" ??? note "Connecting to PiKVM via SSH"
SSH is the most common remote access method in the Linux world. Normally, it should be possible to simply run `ssh root@pikvm` in a terminal window to connect to your PiKVM. However, this can fail for various reasons. In that case, you will have to connect using PiKVM's IP address. SSH is the most common remote access method in the Linux world. Normally, it should be possible to simply run `ssh root@pikvm` in a terminal window to connect to your PiKVM. However, this can fail for various reasons. In that case, you will have to connect using PiKVM's IP address.
@ -64,7 +64,7 @@ Here are **first steps guides** for each PiKVM device:
4. You should now be able to see and interact with the serial port. All the system tools in PiKVM will be available in the terminal window. Once you are done, type `exit` and press **Enter**, or simply press **Ctrl+d** to terminate the session. 4. You should now be able to see and interact with the serial port. All the system tools in PiKVM will be available in the terminal window. Once you are done, type `exit` and press **Enter**, or simply press **Ctrl+d** to terminate the session.
??? note "Connect to PiKVM via serial console" ??? note "Connecting to PiKVM via serial console"
A serial console is a convenient and fast way to connect to PiKVM when there is no network, or get boot logs and a console if something goes wrong. A serial console is a convenient and fast way to connect to PiKVM when there is no network, or get boot logs and a console if something goes wrong.
@ -102,6 +102,25 @@ Here are **first steps guides** for each PiKVM device:
6. You should now be able to see and interact with the serial port. All the system tools in PiKVM will be available in the terminal window. Once you are done, press **Ctrl+a** and then immediately **Ctrl+x** to terminate the session. 6. You should now be able to see and interact with the serial port. All the system tools in PiKVM will be available in the terminal window. Once you are done, press **Ctrl+a** and then immediately **Ctrl+x** to terminate the session.
??? note "Shutting down PiKVM"
PiKVM defaults to using the system in read-only mode, so there is **no need to explicitly shut it down**. You can simply unplug the device from power.
If you absolutely need to use the shutdown command, **please ensure the following requirements are met**:
- **This is not one of the DIY (V1 or V2) devices**. If you shut down a DIY PiKVM, it will not power on until you physically reconnect the power cord.
- **You are not currently running a system update**. If you are, you will likely corrupt the system.
- **You are not currently uploading a mass storage drive image**. If you are, you will likely corrupt the system.
If all these requirements are met, do this:
```
[kvmd-webterm@pikvm ~]$ su -
[root@pikvm ~]# shutdown -h now
```
PiKVM V3 and V4 will automatically reboot after several minutes of being halted. DIY PiKVM will need a power cord reconnection to become available again.
----- -----
## Getting User Support ## Getting User Support