x/proliantutils
Code Issues Proposed changes

Update documentation

Browse Source 
Update the documentation README.rst file with proper
formatting and more links.

Change-Id: Ic106b588a0edf75c9a8a1f8473c29a6ebd945a92
This commit is contained in:
Ramakrishnan G 2015-07-27 01:57:21 -07:00
parent 6290ce9938
commit 1794c29ebc
1 changed files with 33 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.rst
View File

@ -1,17 +1,40 @@
proliantutils
=============
==============
Proliant Utils
==============
**proliantutils** is a set of utility libraries for interfacing and managing
various components (like iLO, HPSSA) for HP Proliant Servers. This library
is used by iLO drivers in Ironic for managing Proliant Servers (though the
library can be used by anyone who wants to manage HP Proliant servers).
Proliant Management Tools provides python libraries for interfacing and
managing various devices(like iLO) present in HP Proliant Servers.
Please use launchpad_ to report bugs and ask questions.
Currently, this module offers a library to interface to iLO4 using RIBCL.
.. _launchpad: https://bugs.launchpad.net/proliantutils
#!/usr/bin/python
Installation
------------
from proliantutils.ilo import ribcl
Install the module from PyPI_. If you are using Ironic, install the module
on Ironic conductor node::
ilo_client = ribcl.IloClient('1.2.3.4', 'Administrator', 'password')
print ilo_client.get_host_power_status()
pip install proliantutils
.. _PyPI: https://pypi.python.org/pypi/proliantutils
Some GNU/Linux distributions provide *python-proliantutils* package.
Usage
-----
iLO
~~~
For interfacing with the iLO, use *IloClient* object::
>>> from proliantutils.ilo import client
>>> ilo_client = client.IloClient('10.10.1.57', 'Administrator', 'password')
>>> ilo_client.get_host_power_status()
'OFF'
>>>
For operations supported on the client object, please refer
*proliantutils.ilo.operations*.