Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alex3025/ilo-fans-controller

Easily manage your HP server's fans speeds, anywhere!
https://github.com/alex3025/ilo-fans-controller

alpinejs hpe ilo4 php8 tailwindcss

Last synced: about 17 hours ago
JSON representation

Easily manage your HP server's fans speeds, anywhere!

Host: GitHub
URL: https://github.com/alex3025/ilo-fans-controller
Owner: alex3025
License: mit
Created: 2021-12-09T11:35:07.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-06-24T14:01:56.000Z (3 months ago)
Last Synced: 2024-09-24T20:05:24.075Z (about 19 hours ago)
Topics: alpinejs, hpe, ilo4, php8, tailwindcss
Language: PHP
Homepage:
Size: 322 KB
Stars: 149
Watchers: 10
Forks: 10
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

iLO Fans Controller

Webpage Screenshot

Easily manage your HP's server fans speeds, anywhere!

---

> ℹ **NOTE:** The v1.0.0 is a **complete rewrite** of the tool, so any feedback is appreciated!

> If you find any bug or have any suggestion, please [open an issue](https://github.com/alex3025/ilo-fans-controller/issues). Thanks! 😄

## FAQ

### How does it work? 🛠

This tool is a **single PHP script** that uses the `php-curl` extension to **get the current server fan speeds from the iLO REST api** and the `php-ssh2` extension to **set the fan speeds using the [patched iLO SSH interface](#can-i-use-this-tool-with-my-hp-server-%EF%B8%8F).** You can also **create custom presets** to set a specific fan configuration with a single click, all with a **simple and clean web interface** made using [Alpine.js](https://alpinejs.dev/) and [TailwindCSS](https://tailwindcss.com/).

### Can I use this tool with my HP server? 🖥️

This tool requires a **patched iLO firmware** that expose to the iLO SSH interface some commands to manipulate the fans speeds. You can find more information about this patch on [this Reddit post](https://www.reddit.com/r/homelab/comments/sx3ldo/hp_ilo4_v277_unlocked_access_to_fan_controls/).

As of now, the patch (and so this tool) only works for **Gen8 & Gen9 servers with iLO 4.**

> Gen10 servers with iLO 5 are not supported at the moment.

### I prefer the _original version™_, can I still use it?

Sure, although I spent a lot of time rewriting the tool from scratch so I would recommend using this version instead.

Anyway, you can download the _original version™_ from the [GitHub releases](https://github.com/alex3025/ilo-fans-controller/releases/tag/0.0.1) page.

### Why PHP? And why a single file? 📄

**Answer #1:**
In my opinion, PHP is perfect for this type of tasks where you need to do some server-side things and something easy to deploy (you just need a web server with PHP installed).

**Answer #2:**
I wanted to make this tool as easy as possible to install and use, so I decided to put everything in a single file.

### Why did you make this? 🤔

See my [original comment on r/homelab](https://www.reddit.com/r/homelab/comments/rcel73/comment/hnu3iyp/?utm_source=share&utm_medium=web2x&context=3) to know the story behind this tool!

### How can I offer you a coffee? ☕

If you found this tool useful, consider offering me a coffee using [PayPal](https://paypal.me/alex3025) or via [GitHub Sponsors](hhttps://github.com/sponsors/alex3025) to support my work! Thank you so much! 🙏

---

## Use with Docker / Docker Compose

If you already have a Docker environment, you can be up and running in minutes using the following command (obviously you need to change the value):

```sh
docker run -d --name ilo-fans-controller --restart always \
-p 8000:80 \
-e ILO_HOST='your-ilo-address' \
-e ILO_USERNAME='your-ilo-username' \
-e ILO_PASSWORD='your-ilo-password' \
ghcr.io/alex3025/ilo-fans-controller:latest
```

Or if you prefer, you can use `docker compose`, as the [docker-compose.yaml](https://github.com/alex3025/ilo-fans-controller/blob/main/docker-compose.yaml) file is provided as well.

---

> ⚠ **IMPORTANT!** ⚠
>
> Again, this tool works thanks to a **[patched iLO firmware](#can-i-use-this-tool-with-my-hp-server-%EF%B8%8F)** that expose to the iLO SSH interface some commands to manipulate the fans speeds.
>
> **This patch is required to use this tool!**

## Manual installation

### The following guide was run on

* An **HP DL380e G8** server
* **Patched iLO 4** Advanced **v2.77** (07 December 2020)
* A Proxmox container (LXC) running **Ubuntu 22.04**
* **Apache 2** & **PHP 8.1**

### Preparing the environment

1. Update the system:

```sh
sudo apt-get update && sudo apt-get upgrade
```

2. Install the required packages (`apache2`, `php8.1`, `php8.1-curl` and `php8.1-ssh2`):

```sh
sudo apt-get install apache2 php8.1 php8.1-curl php8.1-ssh2
```

### Downloading the tool

1. Download and extract the latest source code using `wget` and `tar`:

```sh
wget -qL https://github.com/alex3025/ilo-fans-controller/archive/refs/tags/1.0.0.tar.gz -O - | tar -xz
```

2. Enter the directory:

```sh
cd ilo-fans-controller-1.0.0
```

### Configuring and installing the tool

1. Open the `config.inc.php` file you favourite text editor and change the variables according to your configuration.

> ℹ **NOTE:** Remember that `$ILO_HOST` is the IP address of your iLO interface, not of the server itself.

> ℹ **NOTE:** It's recommended to create a new iLO user with the minimum privileges required to access the SSH interface and the REST api (Remote Console Access).

Here is an example:

```php

```

2. When you're done, create a new subdirectory in your web server root directory (usually `/var/www/html/`) and copy the `config.inc.php`, `ilo-fans-controller.php` and `favicon.ico` to it:

```sh
sudo mkdir /var/www/html/ilo-fans-controller
sudo cp config.inc.php ilo-fans-controller.php favicon.ico /var/www/html/ilo-fans-controller/
```

Then rename `ilo-fans-controller.php` to `index.php` (to make it work without specifying the filename in the URL):

```sh
sudo mv /var/www/html/ilo-fans-controller/ilo-fans-controller.php /var/www/html/ilo-fans-controller/index.php
```

3. That's it! Now you can reach the tool at `http:///ilo-fans-controller/` (or `http:///ilo-fans-controller/index.php` for API requests).

> ℹ **NOTE:** If the web server where you installed this tool **will be reachable from outside your network**, remember to **setup some sort of authentication** (like Basic Auth) to prevent _unauthorized fan management at 2AM_.

---

## Troubleshooting

The first thing to do when you encounter a problem is to **check the logs**.

> If you are using Apache, PHP errors are logged in the `/var/log/apache2/error.log` file.

If you think you found a bug, please [open an issue](https://github.com/alex3025/ilo-fans-controller/issues) and I'll take a look.

Below you can find some common problems and their solutions.

### The presets are not saved

If you see the following error in the logs when you create a new preset:

```log
PHP Warning: file_put_contents(presets.json): Failed to open stream: Permission denied in .../index.php on line X
```

This is probably because the `presets.json` file is not writable by the web server user.

To fix this, run the following command to change the file owner to `www-data` (the default Apache user):

```sh
sudo chown www-data:www-data /var/www/html/ilo-fans-controller/presets.json
```

---

## API Documentation (WIP)

The tool exposes a simple API that can be used to:

* Get the current fan speeds from iLO
* Set the fan speeds

_There is also a way to manage the presets (get existing and add new ones) but it's not documented yet._

_If you wish to do that, you can check inside the source code how that works_

> The following examples use cURL to show how to use the API, but you can use any other tool you want.

### Get the fan speeds (GET)

To use this API you need to add `?api=fans` at the end of the URL.

**Example: `http:///ilo-fans-controller/index.php?api=fans`**

JSON structure (response)

```json
{
"Fan 1": 85,
"Fan 2": 48,
"Fan 3": 69,
"Fan 4": 18,
"Fan 5": 44,
"Fan 6": 96
}
```

cURL example:

```sh
curl http:///ilo-fans-controller/index.php?api=fans
```

### Set the fan speeds (POST)

JSON structure example

```json
{
"action": "fans",
// You can use either an object or a single number value (that will be applied to all fans):
// Example: `fans: { ... }` or `fans: 50`
"fans": {
"Fan 1": 40,
"Fan 2": 23,
"Fan 5": 70
// ...
}
}
```

cURL example

```sh
curl -X POST http:///ilo-fans-controller/index.php -H 'Content-Type: application/json' -d '{"action": "fans", "fans": 50}'
```

This command will set all fans to 50%.

_I personally use this command to slow down the fans automatically when my server boots._