The Storage Project Documentation

Storage project provides an easy to use storage python package to retrieve information from Enterprise Storage Arrays, Switches and Servers.

Note

storage python package is currently going through active development where we aim to add more functionality and improve code stability. If you find any bugs/have other use cases, kindly let us know.

Warning

The Storage Project is no way linked to any of the storage vendors and comes with no guarantees either from developers or storage vendors, so test thoroughly in your environment before you use in production.

Why storage package

SMI-S which many Enterprise Storage vendors support today requires lot of resources (hardware/human) to get simple things done and we believe storage engineers need an easy way to deal with common tasks like retrieving information and reporting.

storage python package is a collection of python modules we have written to deal with common tasks that we end up doing frequently and hopefully help other engineers as well. With little customisation you should be automate your provisioning/decommissioning as well.

Ideally we would prefer Enterprise Storage vendors to adopt REST API as standard instead of/along with SMI-S which will allow storage engineers to hack and automate most of their work in programming language they are most comfortable with.

Installation

We strongly recommend you use python virtual environments for all your python projects. If you are not familiar with python virtual environments, kindly read Virtual Environments - The Hitchhiker’s Guide to Python to understand how to create and use python virtual environments.

Once in virtual environment, you can install storage via pip using:

$ pip install virtualenv

Alternatively if you want to install storage python package in to your standard python environment, you can either install using pip or easy_install or downloading the code and running “python setup.py install”

$ python setup.py install

If you are manually downloading the code and running “python setup.py install”, make sure you install dependencies (paramiko >= 1.8.0 and lxml >= 3.2.1) prior to installing storage python package.

Currently Supported Devices/Platforms

You can click on below links to read documentation for respective device/platform.

Changes

From version 0.6, we aim to track all changes to code.

Roadmap

  • Extend current functionality and add more methods to currently supported devices. (Ongoing effort)
  • NetApp - 2013, probably Q2

Indices and tables