RETIRED, further work has moved to Debian project infrastructure
Go to file
Alex O'Rourke b7eb87a397 Changes exception's isinstance str to basestring
The error description was not being displayed when an exception
was being raised. This was due to the patch merged in from
issue #12 (reported in the 3PAR client), which changed the body
to type bytes instead of typestr.  The check in exceptions.py is
now updated to represent this change.

Change-Id: I471192a38b47f118114239fce63c52c9764b1ac9
2015-11-17 16:52:36 -08:00
docs Changes exception's isinstance str to basestring 2015-11-17 16:52:36 -08:00
hpelefthandclient Changes exception's isinstance str to basestring 2015-11-17 16:52:36 -08:00
samples Rebranding the hplefthandclient 2015-11-13 15:47:35 -08:00
test Rebranding the hplefthandclient 2015-11-13 15:47:35 -08:00
.gitignore Normalize unit tests 2015-02-24 11:42:38 -08:00
LICENSE.txt Initial commit of the hplefthand client 2013-12-12 16:25:45 -08:00
README.rst Rebranding the hplefthandclient 2015-11-13 15:47:35 -08:00
config.ini Normalize unit tests 2015-02-24 11:42:38 -08:00
requirements-py3.txt Replaces httplib2 with Python Requests support 2015-10-02 08:45:03 -07:00
requirements.txt Replaces httplib2 with Python Requests support 2015-10-02 08:45:03 -07:00
setup.py Rebranding the hplefthandclient 2015-11-13 15:47:35 -08:00
test-requirements-py3.txt Making the client Python3.4+ Compliant 2015-07-17 10:42:41 -07:00
test-requirements.txt Update tox to generate docs & code coverage output 2015-02-23 05:24:04 -08:00
tox.ini Rebranding the hplefthandclient 2015-11-13 15:47:35 -08:00

README.rst

HPE LeftHand/StoreVirtual REST Client =================== This is a Client library that can talk to the HPE LeftHand/StoreVirtual Storage array. The HPE LeftHand storage array has a REST web service interface. This client library implements a simple interface to talk with that REST interface using the python Requests http library.

This is the new location for the rebranded HP LeftHand/StoreVirtual REST Client and will be where all future releases are made. It was previously located on PyPi at: https://pypi.python.org/pypi/hplefthandclient

The GitHub repository for the old HP LeftHand/StoreVirtual REST Client is located at: https://github.com/hpe-storage/python-lefthandclient/tree/1.x

The HP LeftHand/StoreVirtual REST Client (hplefthandclient) is now considered deprecated.

Requirements

This branch requires 11.5 version or later of the LeftHand OS firmware.

Capabilities

  • Get Volume(s)
  • Get Volume by Name
  • Create Volume
  • Delete Volume
  • Modify Volume
  • Clone Volume
  • Get Snapshot(s)
  • Delete Shapshot
  • Get Shapshot by Name
  • Create Snapshot
  • Delete Snapshot
  • Clone Snapshot
  • Get Cluster(s)
  • Get Cluster by Name
  • Get Server(s)
  • Get Server by Name
  • Create Server
  • Delete Server
  • Add Server Access
  • Remove Server Access

Installation

To install:

$ sudo pip install .

Unit Tests

To run all unit tests:

$ tox -e py27

To run a specific test:

$ tox -e py27 -- test/file.py:class_name.test_method_name

To run all unit tests with code coverage:

$ tox -e cover

The output of the coverage tests will be placed into the coverage dir.

Folders

  • docs -- contains the documentation.
  • hpelefthandlient -- the actual client.py library
  • test -- unit tests
  • samples -- some sample uses

Documentation

To build the documentation:

$ tox -e docs

To view the built documentation point your browser to:

docs/html/index.html

Running Simulators

Manually run flask server (when config.ini unit=true):

$ python test/HPELeftHandMockServer_flask.py -port 5001 -user <USERNAME> -password <PASSWORD> -debug