Skip to content

Commit 8d156fe

Browse files
bjw-sfabaff
authored andcommitted
Provide documentation for HP ILO (home-assistant#789)
* HP ILO component * Small textual fixes * Textual updates Also refer to Integrated Lights-Out instead of only using HP ILO * Changed ha_release and ha_category Processed feedback from @balloob: - changed ha_release to 0.27 - changed ha_category from Sensor to System Monitor
1 parent 01cda98 commit 8d156fe

File tree

3 files changed

+70
-0
lines changed

3 files changed

+70
-0
lines changed
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
layout: page
3+
title: "HP ILO"
4+
description: "How to integrate HP ILO (Integrated Lights-Out) sensors within Home Assistant."
5+
date: 2016-08-15 19:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: hewlett_packard_enterprise.png
11+
ha_category: System Monitor
12+
ha_release: 0.27
13+
---
14+
15+
The `hp_ilo` platform allows you to do an API call to the HP ILO (Integrated Lights-Out) sensor of your server, and use this data in (template) sensors.
16+
17+
The component will output the ILO information in the sensor attributes so they can be accessed like that.
18+
19+
If the ILO only returns a single value (e.g. a temperature or state), it will be put in the state field.
20+
21+
Some more details about what can be retrieved from these sensors is available in the [python-hpilo documentation](http://pythonhosted.org/python-hpilo/)
22+
23+
## Example
24+
<p class='img'>
25+
<img src='{{site_root}}/images/screenshots/hp_ilo.png' />
26+
</p>
27+
28+
## Usage
29+
To use this component in your installation, add the following to your `configuration.yaml` file:
30+
31+
```yaml
32+
# Example configuration.yaml entry
33+
sensor:
34+
platform: hp_ilo
35+
host: IP_ADDRESS or HOSTNAME
36+
port: PORT
37+
username: USERNAME
38+
password: PASSWORD
39+
monitored_variables:
40+
- server_name
41+
- server_fqdn
42+
- server_host_data
43+
- server_oa_info
44+
- server_power_status
45+
- server_power_readings
46+
- server_power_on_time
47+
- server_asset_tag
48+
- server_uid_status
49+
- server_health
50+
- network_settings
51+
```
52+
53+
Configuration variables:
54+
55+
- **host** (*Required*): The hostname or IP address on which the ILO can be reached
56+
- **port** (*Optional*): The port on which the ILO can be reached, defaults to port 443
57+
- **username** (*Required*): The username used to connect to the ILO
58+
- **password** (*Required*): The password used to connect to the ILO
59+
- **monitored_variables** array (*Optional*): Information to be collected from the ILO, defaults to `server_name`
60+
- **server_name**: Get the name of the server this iLO is managing
61+
- **server_fqdn**: Get the fqdn of the server this iLO is managing
62+
- **server_host_data**: Get SMBIOS records that describe the host
63+
- **server_oa_info**: Get information about the Onboard Administrator of the enclosing chassis
64+
- **server_power_status**: Whether the server is powered on or not
65+
- **server_power_readings**: Get current, min, max and average power readings
66+
- **server_power_on_time**: How many minutes ago has the server been powered on
67+
- **server_asset_tag**: Gets the server asset tag
68+
- **server_uid_status**: Get the status of the UID light
69+
- **server_health**: Get server health information
70+
- **network_settings**: Get the iLO network settings

source/images/screenshots/hp_ilo.png

16.1 KB
Loading

0 commit comments

Comments
 (0)