costajusto / PyU4V

A library showing some of the functionality possible using the ReST API of UniSphere for VMAX

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PyU4V

A library showing some of the functionality possible using the ReST API of Dell EMC's UniSphere for VMAX. This code has been adapted from https://github.com/scottbri/PyVMAX. Also see the Dell EMC Rest documentation by navigating to URL/univmax/restapi/docs eg: https://10.0.0.1:8443/univmax/restapi/docs.

WHAT'S SUPPORTED

This package supports Unisphere version 8.3 onwards, although the calls should work on 8.0, 8.1 and 8.2 also. We support VMAX3 and VMAX All-Flash (All Flash from 8.3 onwards).

INSTALLATION

To give it a try, download the files and add your server and array details to the top of the PyU4V.conf configuration file, under the [setup] heading. Alternatively, you can pass some or all of these details on initialisation. Requires the 'requests' library (can be installed using pip). Password, username, server_ip, port, and array MUST be set (either in the config file or on initialisation). Cert and verify can be left as is.

USAGE

PyU4V could also be used as the backend for a script, or a menu etc. Just move the PyU4V package into your working directory and import it into your script ('from PyU4V.rest_univmax import rest_functions'), create an instance of rest_functions, and you're good to go. Be sure to bring the configuration file with you.

If you wish to query another array without changing the configuration file, call the set_array() function.

FUTURE

This is still a work in progress, and it's far from polished. I'll be working on it (and corresponding documentation!) whenever I get the chance!

  • I will keep expanding the rest_functions library (including new Unisphere versions - see below)
  • I plan on making this a proper package, but that is still a work in progress.
  • Ideally, the password won't have to be stored in, or passed in in, plain text.
  • Exception handling and logging still leave a lot to be desired
  • I will create unit tests one of these fine days... So far I've more to do than has been done, but I'll get there!

VERSION FUTURE

The Rest API is undergoing substantial transformation for the 8.4 release. With that in mind, I will be creating a new 84 version when that is released.

CONTRIBUTION

Please do! Create a fork of the project into your own repository. Make all your necessary changes and create a pull request with a description on what was added or removed and details explaining the changes in lines of code. If it all looks good, I'll merge it.

SUPPORT

Please file bugs and issues on the Github issues page for this project. This is to help keep track and document everything related to this repo. For general discussions and further support you can join the {code} Community slack channel. Lastly, for questions asked on Stackoverflow.com please tag them with EMC. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process.

About

A library showing some of the functionality possible using the ReST API of UniSphere for VMAX

License:MIT License


Languages

Language:Python 100.0%