Welcome to PyU4V’s documentation!

Overview

PyU4V is a Python module that simplifies interaction with the Unisphere for PowerMax REST API. It wraps REST calls with simple APIs that abstract the HTTP request and response handling.

Note

You can get the Unisphere for PowerMax REST documentation by navigating to https://developer.dell.com/apis/4458/ An OpenApi.json file can be download from this site for use with tools like PostMan or for interfacing with PyU4V custom API call mechanism. Please refer to this documentation when looking for information about query path parameters for functions that accept them.

Supported PyU4V Versions

PyU4V Version

10.1.0.1

Minimum Unisphere Version

10.1

Array Model

VMAX-3, VMAX AFA, PowerMax

Array uCode

HyperMax OS, PowerMax OS

Platforms

Linux, Windows

Python

3.6, 3.7, 3.8, 3.9, 3.10

Requirements

Requests, Six, urllib3, prettytable

Test Requirements

TestTools, Tox

Note

PyU4V officially supports Python 3.6, 3.7, 3.8, 3.9 & 3.10 Python 2.x support has been dropped since January 1st 2020.

Note

PyU4V version 10.1.x is compatible with scripts written for PyU4V versions >= 9.2. Please ensure to check change log to ensure that you are not using functions that have been marked as depreciated.

Getting Started

Installation Guide

How to get the source code, and how to build or install the python package.

Configuration

Configuring PyU4V for your environment.

Quick Start Guide

Making your first calls with PyU4V.

Contribute to PyU4V

Contribute to the PyU4V project.

Issues & Support

How to get support with or open issues for PyU4V.

Programmers Guide

A range of examples demonstrating various PyU4V module usage.

Tools Guide

The tools guide for PyU4V

API Glossary

A glossary of all available functions.

Build your own PyU4V Docs

PyU4V docs have been built using Sphinx and included with the source PyU4V package, however if you would like to build the docs from scratch use the following commands:

$ pip install sphinx
$ pip install sphinx-rtd-theme
$ cd PyU4V/docs
$ make clean && make html

All of the necessary make files and sphinx configuration files are included with PyU4V so you can build the docs after the required dependencies have been installed.

Once the above commands have been run you will find newly generated html files within the /PyU4V/docs/build folder. Open index.html within a browser of your choosing to view the docs offline. Generating the docs is not required, we have bundled the most up-to-date docs with PyU4V so you can still navigate to /PyU4V/docs/build/index.html within your browser to view PyU4V docs offline.

Disclaimer

PyU4V 10 is distributed under the Apache 2.0 License. Unless required by applicable law or agreed to in writing, software distributed under the Apache 2.0 License is distributed on an “as is” basis, without warranties or conditions of any kind, either express or implied. See the License for the specific language governing permissions and limitations under the License.