From 7c74e7870e73b2da8c901a68a3836e2c186e745b Mon Sep 17 00:00:00 2001
From: Tigerblue77 <37409593+tigerblue77@users.noreply.github.com>
Date: Sun, 1 Jan 2023 14:43:03 +0100
Subject: [PATCH] Adding the prerequisite to use IPMI over LAN to README file

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 38 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 25101b3..71e8085 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,34 @@ https://hub.docker.com/repository/docker/tigerblue77/dell_idrac_fan_controller
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
+<!-- PREREQUISITES -->
+## Prerequisites
+### To access iDRAC over LAN (not needed in "local" mode) :
+
+1. Log into your iDRAC web console
+
+![001](https://user-images.githubusercontent.com/37409593/210168273-7d760e47-143e-4a6e-aca7-45b483024139.png)
+
+2. In the left side menu, expand "iDRAC settings", click "Network" then click "IPMI Settings" link at the top of the web page.
+
+![002](https://user-images.githubusercontent.com/37409593/210168249-994f29cc-ac9e-4667-84f7-07f6d9a87522.png)
+
+3. Check the "Enable IPMI over LAN" checkbox then click "Apply" button.
+
+![003](https://user-images.githubusercontent.com/37409593/210168248-a68982c4-9fe7-40e7-8b2c-b3f06fbfee62.png)
+
+4. Test access to IPMI over LAN running the following commands :
+```bash
+apt -y install ipmitool
+ipmitool -I lanplus \
+  -H <iDRAC IP address> \
+  -U <iDRAC username> \
+  -P <iDRAC password> \
+  sdr elist all
+```
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
 <!-- USAGE -->
 ## Usage
 
@@ -30,8 +58,8 @@ docker run -d \
   --name Dell_iDRAC_fan_controller \
   --restart=unless-stopped \
   -e IDRAC_HOST=local \
-  -e FAN_SPEED=<dec or hex fan speed> \
-  -e CPU_TEMPERATURE_TRESHOLD=<dec temperature treshold> \
+  -e FAN_SPEED=<decimal or hexadecimal fan speed> \
+  -e CPU_TEMPERATURE_TRESHOLD=<decimal temperature treshold> \
   -e CHECK_INTERVAL=<seconds between each check> \
   --device=/dev/ipmi0:/dev/ipmi0:rw \
   tigerblue77/dell_idrac_fan_controller:latest
@@ -43,11 +71,11 @@ docker run -d \
 docker run -d \
   --name Dell_iDRAC_fan_controller \
   --restart=unless-stopped \
-  -e IDRAC_HOST=<iDRAC host IP> \
+  -e IDRAC_HOST=<iDRAC IP address> \
   -e IDRAC_USERNAME=<iDRAC username> \
   -e IDRAC_PASSWORD=<iDRAC password> \
-  -e FAN_SPEED=<dec or hex fan speed> \
-  -e CPU_TEMPERATURE_TRESHOLD=<dec temperature treshold> \
+  -e FAN_SPEED=<decimal or hexadecimal fan speed> \
+  -e CPU_TEMPERATURE_TRESHOLD=<decimal temperature treshold> \
   -e CHECK_INTERVAL=<seconds between each check> \
   tigerblue77/dell_idrac_fan_controller:latest
 ```
@@ -66,8 +94,8 @@ services:
     restart: unless-stopped
     environment:
       - IDRAC_HOST=local
-      - FAN_SPEED=<dec or hex fan speed>
-      - CPU_TEMPERATURE_TRESHOLD=<dec temperature treshold>
+      - FAN_SPEED=<decimal or hexadecimal fan speed>
+      - CPU_TEMPERATURE_TRESHOLD=<decimal temperature treshold>
       - CHECK_INTERVAL=<seconds between each check>
     devices:
       - /dev/ipmi0:/dev/ipmi0:rw
@@ -87,8 +115,8 @@ services:
       - IDRAC_HOST=<iDRAC IP address>
       - IDRAC_USERNAME=<iDRAC username>
       - IDRAC_PASSWORD=<iDRAC password>
-      - FAN_SPEED=<dec or hex fan speed>
-      - CPU_TEMPERATURE_TRESHOLD=<dec temperature treshold>
+      - FAN_SPEED=<decimal or hexadecimal fan speed>
+      - CPU_TEMPERATURE_TRESHOLD=<decimal temperature treshold>
       - CHECK_INTERVAL=<seconds between each check>
 ```
 
@@ -102,7 +130,7 @@ All parameters are optional as they have default values (including default iDRAC
 - `IDRAC_HOST` parameter can be set to "local" or to your distant iDRAC's IP address. **Default** value is "local".
 - `IDRAC_USERNAME` parameter is only necessary if you're adressing a distant iDRAC. **Default** value is "root".
 - `IDRAC_PASSWORD` parameter is only necessary if you're adressing a distant iDRAC. **Default** value is "calvin".
-- `FAN_SPEED` parameter can be set as a decimal (from 0 to 100%) or hexadecimal value (from 0x00 to 0x64) you want to set the fans to. **Default** value is 5(%).
+- `FAN_SPEED` parameter can be set as a decimal (from 0 to 100%) or hexadecimaladecimal value (from 0x00 to 0x64) you want to set the fans to. **Default** value is 5(%).
 - `CPU_TEMPERATURE_TRESHOLD` parameter is the T°junction (junction temperature) threshold beyond which the Dell fan mode defined in your BIOS will become active again (to protect the server hardware against overheat). **Default** value is 50(°C).
 - `CHECK_INTERVAL` parameter is the time (in seconds) between each temperature check and potential profile change. **Default** value is 60(s).