Welcome to PyU4V 10.2

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.

Full documentation and user guides can be found in PyU4V's ReadTheDocs.

Note

You can get the Unisphere for PowerMax REST documentation by navigating to a URL in your local instance of Unisphere for PowerMax. Navigate to https://{ip-address}:{port}/univmax/restapi/docs where {ip-address} is the IP address of your Unisphere server and {port} is the port it is listening on.

PyU4V Version 10.2

Author	Dell EMC
PyU4V Version	10.2.0.0
Minimum Unisphere Version	10.2.0.0
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
Requires	Requests, Six, urllib3

Note

If you want to continue to use Unisphere 8.4.x or 9.0.x with PyU4V you will need to remain on PyU4V 3.1.x. There is no support for PyU4V 9.x with any version of Unisphere older than 9.1.x

Note

PyU4V version 10.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.

Installation

Note

A full installation guide can be found in PyU4V's ReadTheDocs which includes additional configuration options around PyU4V logging.

PyU4V can be installed from source, via pip, or run directly from the source directory. To clone PyU4V from source use git:

$ git clone https://github.com/dell/PyU4V

To install from source navigate into the new PyU4V directory and use pip:

$ cd PyU4V/
$ pip install .

Installing via pip without cloning from source can be achieved by specifying PyU4V as the install package for pip:

$ pip install PyU4V
# Install a specific version
$ pip install PyU4V==10.2.0.0

Copy the sample PyU4V.conf provided with PyU4V to either your working directory or within a directory named .PyU4V in your current users home directory. The .sample suffix has to be removed for the configuration file to become valid for loading by PyU4V:

$ mkdir ~/.PyU4V
$ cp PyU4V/PyU4V.conf.sample ~/.PyU4V/PyU4V.conf

Note

If PyU4V.conf is present in both the current working directory and the current user's home directory, the version of PyU4V.conf in the current working directory will take precedence.

Edit PyU4V configuration settings in PyU4V.conf under the [setup] heading, these setting will need to reflect your environment configuration:

[setup]
username=pyu4v-user
password=secret-pass
server_ip=10.0.0.75
port=8443
array=00012345678
verify=/path-to-file/server_hostname.pem

Alternatively, you can pass some or all of these details on initialisation. Environment configuration values password, username, server_ip, port, and array must be set either in the config file or on initialisation. SSL verification as indicated by the verify key in PyU4V.conf is discussed in the next section.

SSL CONFIGURATION

In order to enable SSL enabled communication between your host and the Unisphere server there are some additional steps required. First you must extract the CA certificate from Unisphere then either add it to the system certificate bundle or specify the path to the cert in PyU4V.conf. We will demonstrate both approaches here.

Get the CA certificate of the Unisphere server:

$ openssl s_client -showcerts -connect {server_hostname}:8443 \
</dev/null 2>/dev/null|openssl x509 -outform PEM > {cert_name}.pem

# Example
$ openssl s_client -showcerts -connect 10.0.0.75:8443 \
</dev/null 2>/dev/null|openssl x509 -outform PEM > unisphere91.pem

Where {server_host_ip} is the hostname or IP address of your Unisphere server and {cert_name} is the name for your CA cert. This pulls the CA cert file from the instance of Unisphere at 10.0.0.75:8443 and saves it as a .pem file.

To add the cert to a CA certificate bundle, copy the .pem file to the system certificate directory and update the CA certificate database:

# cp {cert_name}.pem /usr/share/ca-certificates/{cert_name}.crt
# dpkg-reconfigure ca-certificates
# update-ca-certificates

Once the above steps are complete you will need to specify verify=True in PyU4V.conf for PyU4V to load the required Unisphere CA cert from the system certificate bundle:

[setup]
verify=True

Alternatively you can skip adding the certificate to a certificate bundle and pass it directly on PyU4V initialisation or specify the path to the certificate directly in PyU4V.conf:

[setup]
verify=/path/to/file/{cert_name}.pem

Initialise PyU4V Connection

Initialising PyU4V in your Python scripts is as simple as importing the library and initialising the connection (assuming you have PyU4V.conf configured as outlined in the previous section).

import PyU4V

conn = PyU4V.U4VConn()
conn.common.get_unisphere_version()
>> {'version': 'V10.2.0.0'}

If you wish to query another array without changing the configuration file, call the connection set_array_id() function:

conn.set_array_id('000197123456')

The various types of functionality provided by PyU4V is separated into logical sections such as replication, provisioning, and performance. For a full API breakdown by section and some usage example please refer to the PyU4V ReadTheDocs.

Support, Bugs, Issues

Please file support requests, bugs, and issues on the PyU4V GitHub-Issues page for this project. For further information on opening an issue and recommended issue templates please see the PyU4V ReadTheDocs.

For questions asked on StackOverFlow, please tag them with Dell, Dell EMC, PowerMax, and PyU4V to maximise the chances of the correct community members assisting.

Contributing

PyU4V is built to be used openly by everyone, and in doing so we encourage everyone to submit anything they may deem to be an improvement, addition, bug fix, or other change which may benefit other users of PyU4V.

There are some requirements when submitting for PyU4V, such as coding standards, building unit tests and continuous integration tests, and going through a formal code review process, however anyone familiar with open source development will be familiar with this process. There are a number of core PyU4V reviewers and once a submission has approvals from two or more core reviewers and all tests are running cleanly then the request will be merged with the upstream PyU4V repo.

For a full breakdown of contribution requirements, coding standards, submitting and everything else in between please refer to PyU4V ReadTheDocs.

Tools

Please refer to the Tools section of ReadTheDocs for OpenStack functionality to migrate volumes to the new REST masking view structure.

Disclaimer

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.