Skip to content

Commit 13d6b78

Browse files
seveasseveas
committed
Rework documentation
Fill in all the new stubby documentation pages and add missing output.
1 parent f0a1590 commit 13d6b78

37 files changed

+546
-30
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ hp
77
firmware
88
*.bin
99
*.scexe
10+
.*.sw?

‎docs/ahs.rst‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,25 @@
1-
Active Health System
2-
====================
1+
Active Health System and Insight Remote Support
2+
===============================================
3+
The Active Health System and Insight Remote Support functions let you collect
4+
information about your server environment in a central place. These functions
5+
let you inspect and manipulate the AHS and ERS configuration and submit data.
6+
7+
.. py:currentmodule:: hpilo
8+
9+
.. class:: Ilo
10+
:noindex:
11+
12+
.. automethod:: get_ahs_status
13+
.. ilo_output:: get_ahs_status
14+
.. automethod:: set_ahs_status
15+
.. automethod:: ahs_clear_data
16+
.. automethod:: get_ers_settings
17+
.. ilo_output:: get_ers_settings
18+
.. automethod:: set_ers_irs_connect
19+
.. automethod:: set_ers_direct_connect
20+
.. automethod:: dc_registration_complete
21+
.. automethod:: set_ers_web_proxy
22+
.. automethod:: ers_ahs_submit
23+
.. automethod:: trigger_l2_collection
24+
.. automethod:: trigger_test_event
25+
.. automethod:: disable_ers

‎docs/authentication.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
Authentication settings
22
=======================
3+
4+
By default, an iLO has only one user account: Administrator. But via the API
5+
you can create more users and manipulate them. It's also possible to import SSH
6+
keys, configure kerberos settings and configure single-sign on. Some methods
7+
accept a lot of arguments, for details on what these arguments mean, I will
8+
refer to the `ilo scripting guide`_.
9+
10+
.. _`ilo scripting guide`: http://www.hp.com/support/ilo4_cli_gde_en
11+
12+
.. py:currentmodule:: hpilo
13+
14+
.. class:: Ilo
15+
:noindex:
16+
17+
.. automethod:: get_all_users
18+
.. ilo_output:: get_all_users
19+
.. automethod:: get_all_user_info
20+
.. ilo_output:: get_all_user_info
21+
.. automethod:: get_user
22+
.. ilo_output:: get_user
23+
.. automethod:: add_user
24+
.. automethod:: mod_user
25+
.. automethod:: delete_user
26+
.. automethod:: import_ssh_key
27+
.. automethod:: delete_ssh_key
28+
.. automethod:: get_dir_config
29+
.. ilo_output:: get_dir_config
30+
.. automethod:: mod_dir_config
31+
.. automethod:: get_sso_settings
32+
.. ilo_output:: get_sso_settings
33+
.. automethod:: mod_sso_settings
34+
.. automethod:: get_twofactor_settings
35+
.. ilo_output:: get_twofactor_settings

‎docs/boot.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
11
Boot settings and rebooting
22
===========================
3+
4+
HP servers can boot in various ways and from many devices. The functions in
5+
this section let you manipulate bootup settings and reboot the server and the
6+
iLO. If you need to power off the server hard, take a look at the
7+
:doc:`power documentation </power>`.
8+
9+
.. py:currentmodule:: hpilo
10+
11+
.. class:: Ilo
12+
:noindex:
13+
14+
.. automethod:: reset_rib
15+
.. automethod:: reset_server
16+
.. automethod:: cold_boot_server
17+
.. automethod:: warm_boot_server
18+
.. automethod:: get_one_time_boot
19+
.. ilo_output:: get_one_time_boot
20+
.. automethod:: set_one_time_boot
21+
.. automethod:: get_persistent_boot
22+
.. ilo_output:: get_persistent_boot
23+
.. automethod:: set_persistent_boot
24+
.. automethod:: get_supported_boot_mode
25+
.. ilo_output:: get_supported_boot_mode
26+
.. automethod:: get_current_boot_mode
27+
.. ilo_output:: get_current_boot_mode
28+
.. automethod:: get_pending_boot_mode
29+
.. ilo_output:: get_pending_boot_mode
30+
.. automethod:: set_pending_boot_mode

‎docs/ers.rst‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎docs/federation.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Federation groups
2+
=================
3+
iLO federation allows you to manage multiple iLOs and servers from a single iLO
4+
web interface, including firmware updates, license installs and querying health
5+
status.
6+
7+
.. py:currentmodule:: hpilo
8+
9+
.. class:: Ilo
10+
:noindex:
11+
12+
.. automethod:: add_federation_group
13+
.. automethod:: get_federation_all_groups
14+
.. ilo_output:: get_federation_all_groups
15+
.. automethod:: get_federation_all_groups_info
16+
.. ilo_output:: get_federation_all_groups_info
17+
.. automethod:: get_federation_group
18+
.. ilo_output:: get_federation_group
19+
.. automethod:: mod_federation_group
20+
.. automethod:: delete_federation_group
21+
.. automethod:: get_federation_multicast
22+
.. ilo_output:: get_federation_multicast
23+
.. automethod:: set_federation_multicast

‎docs/health.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,15 @@
11
Server health
22
=============
3+
The iLO knows a lot about your server's physical health. The
4+
:meth:`get_embedded_health` method lets you retrieve all the health
5+
information, so you can act upon it, for example in monitoring checks and
6+
management scripts. Note that the returned data can differ significantly
7+
between iLO versions.
8+
9+
.. py:currentmodule:: hpilo
10+
11+
.. class:: Ilo
12+
:noindex:
13+
14+
.. automethod:: get_embedded_health
15+
.. ilo_output:: get_embedded_health

‎docs/ilodoc.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def run(self):
2525
content = fd.read()
2626
if '\n\n' in content:
2727
params, result = content.split('\n\n')
28-
params = ', '.join(params)
28+
params = ', '.join(params.split('\n'))
2929
else:
3030
params, result = '', content
3131

‎docs/index.rst‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ Entering a license key and creating a user, from the shell:
3838
$ hpilo_cli example-server.int.kaarsemaker.net add_user user_login=dennis \
3939
password=hunter2 admin_priv=true
4040
41+
The available dunctions you can call are all documented in the pages linked
42+
below, but for detailed descriptions of all functions and especially their
43+
arguments, please refer to the `ilo scripting guide`_ as well.
44+
4145
This package also ships examples of more complete applications in the examples
4246
directory. This include an automated CA for managing SSL certificates, tooling
4347
to centralize iLO informatin in elastic search and an automated firmware
@@ -57,30 +61,36 @@ iLOs can be managed both locally using `hponcfg` or remotely using the iLO's
5761
built-in webserver. In the latter case, the requirements above concern the
5862
machine you run this code on, not the managed server.
5963

60-
Available functionality
61-
=======================
62-
64+
Getting started
65+
===============
6366
.. toctree::
6467
:maxdepth: 1
6568

6669
install
6770
python
6871
shell
72+
73+
Available functionality
74+
=======================
75+
.. toctree::
76+
:maxdepth: 1
77+
6978
info
70-
network
79+
networksettings
80+
license
7181
authentication
7282
security
73-
license
7483
health
7584
power
7685
boot
7786
media
87+
input
7888
snmp
7989
firmware
8090
xmldata
8191
log
92+
federation
8293
ahs
83-
ers
8494
profile
8595

8696
Example applications
@@ -102,7 +112,7 @@ Development information
102112

103113
Author and license
104114
==================
105-
This software is (c) 2011-2014 Dennis Kaarsemaker <[email protected]>
115+
This software is (c) 2011-2015 Dennis Kaarsemaker <[email protected]>
106116

107117
This program is free software: you can redistribute it and/or modify it under
108118
the terms of the GNU General Public License as published by the Free Software
@@ -111,3 +121,5 @@ version.
111121

112122
HP, Integrated Lights out and iLO are trademarks of HP, with whom the author of
113123
this software is not affiliated in any way.
124+
125+
.. _`ilo scripting guide`: http://www.hp.com/support/ilo4_cli_gde_en

‎docs/info.rst‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,49 @@
11
General server and iLO information
22
==================================
3+
4+
Many iLO methods allow you to retrieve information about the iLO and the server
5+
it is built into and to manipulate basic configuration settings. This document
6+
describes all the ones that do not fit under a more specific subject, such as
7+
authentication or power.
8+
9+
.. py:currentmodule:: hpilo
10+
11+
.. class:: Ilo
12+
:noindex:
13+
14+
.. automethod:: factory_defaults
15+
.. automethod:: get_product_name
16+
.. ilo_output:: get_product_name
17+
.. automethod:: get_fw_version
18+
.. ilo_output:: get_fw_version
19+
.. automethod:: get_host_data
20+
.. ilo_output:: get_host_data
21+
.. automethod:: get_global_settings
22+
.. ilo_output:: get_global_settings
23+
.. automethod:: mod_global_settings
24+
.. automethod:: get_server_name
25+
.. ilo_output:: get_server_name
26+
.. automethod:: set_server_name
27+
.. automethod:: get_server_fqdn
28+
.. ilo_output:: get_server_fqdn
29+
.. automethod:: set_server_fqdn
30+
.. automethod:: get_smh_fqdn
31+
.. ilo_output:: get_smh_fqdn
32+
.. automethod:: get_oa_info
33+
.. ilo_output:: get_oa_info
34+
.. automethod:: get_asset_tag
35+
.. ilo_output:: get_asset_tag
36+
.. ilo_output:: get_asset_tag#1
37+
.. automethod:: set_asset_tag
38+
.. automethod:: get_uid_status
39+
.. ilo_output:: get_uid_status
40+
.. automethod:: uid_control
41+
.. automethod:: get_all_languages
42+
.. ilo_output:: get_all_languages
43+
.. automethod:: get_language
44+
.. ilo_output:: get_language
45+
.. automethod:: set_language
46+
.. automethod:: get_rack_settings
47+
.. ilo_output:: get_rack_settings
48+
.. automethod:: get_spatial
49+
.. ilo_output:: get_spatial

0 commit comments

Comments
 (0)