hpestorapi

Package description

hpestorapi is a python library that allows a simple way to use Rest API services for HPE storage and disk backup devices. Current version supports:

  • HPE 3PAR StoreServ disk arrays
  • HPE Primera disk arrays
  • HPE XP7 and P9500 (Command View AE Configuration manager is required)
  • HPE StoreOnce Gen 3 disk backup device
  • HPE StoreOnce Gen 4 disk backup device

Installation

Requirements

hpestorapi library requires:

  • CPython 3.6+ or PyPy3 interpreter
  • Python requests library version 2.19.1 or newer

Installation from PyPI

To download and install hpestorapi you can use pip:

# pip install hpestorapi

Installation from GitHub

Get a copy of source code

# git clone https://github.com/HewlettPackard/python-storage-clients.git
# cd python-storage-clients

Install package with dependencies:

# python setup.py install

Import hpestorapi library to your python script:

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import hpestorapi

HPE 3PAR StoreServ disk array

API reference

class hpestorapi.StoreServ(address, username, password, port=None, ssl=True, verify=True)[source]

HPE 3PAR array implementation class.

__init__(address, username, password, port=None, ssl=True, verify=True)[source]

HPE 3PAR object constructor.

Parameters:
  • address (str) – Hostname or IP address of HPE 3PAR array management interface. Web Services API should be enabled for this array (disabled by default). To enable Web Services API check 3PAR OS command: ‘showwsapi’.
  • username (str) – User name for 3PAR Web Services API. Creating a dedicated user with limited rights recommended. For example, if you do not need to create/modify/delete objects on a disk array, create a new user with a “browse” role. Running a script with a “3paradm” user is not recommended. To create a new user, check 3PAR OS command: ‘createuser’.
  • password (str) – Password for 3PAR Web Services API.
  • port (int) – (optional) Custom port number for 3PAR Web Services API.
  • ssl (bool) – (optional) Use secure https (True) or plain text http (False).
  • verify (bool|string) – (optional) Either a boolean, controlling the Rest server’s TLS certificate verification, or a string, where it is a path to a CA bundle. Default value: True.
Returns:

None
open() → None[source]

Open new Rest API session for HPE 3PAR array.

Call it prior any other requests. Call StoreServ.close() if you do not plan to use a session anymore, because 3PAR array has an active sessions limit.

Should any trouble occur, please manually check that:

  • 3PAR Web services API are enabled on the array (3PAR OS command: ‘showwsapi’)
  • Array credentials (username and password)
  • 3PAR array management address is correct and available
  • Debug logs generated by a python logging module
Returns:None
close() → None[source]

Close Rest API session.

No need to run it manually when context manager is used (block with .. as ..:).

Returns:None
get(url, query=None)[source]

Make a HTTP GET request to HPE 3PAR array. Method used to get information about objects.

Parameters:
  • url (str) – URL address. The static part of the URL address is generated automatically. Example of a valid URL: ‘system’ or ‘volumes’. All available URLs and requests results are described in “HPE 3PAR Web Services API Developer’s Guide”.
  • query (str) – (optional) Query filter specification (see “WSAPI query syntax” in “HPE 3PAR Web Services API Developer’s Guide”).
Return type:

tuple(int, dict)
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {‘key’:’value’}).
post(url, body)[source]

Make a HTTP POST request to HPE 3PAR array. Method used to create new objects.

Parameters:
  • url (str) – URL address. The static part of the URL address is generated automatically. Example of a valid URL: ‘system’ or ‘volumes’. All available URLs, request parameters and results are described in “HPE 3PAR Web Services API Developer’s Guide”.
  • body (dict) – Request parameter, used to create new array object.
Return type:

tuple (int, dict)
Returns:

Tuple with HTTP status code and dict with request result. For example: (201, {‘key’:’value’}). Second value may be None if 3PAR array returns no message body.
delete(url)[source]

Make a HTTP DELETE request to HPE 3PAR array.

Parameters:url (str) – URL address. The static part of the URL address is generated automatically. Example of a valid URL: ‘system’ or ‘volumes’. All available URLs, request parameters and results are described in “HPE 3PAR Web Services API Developer’s Guide”.
Returns:Tuple with HTTP status code and dict with request result. For example: (200, {‘key’:’value’}). Second value may be None if 3PAR array returns no message body.
put(url, body)[source]

Make a HTTP PUT request to HPE 3PAR array.

Parameters:
  • url (str) – URL address. The static part of the URL address is generated automatically. Example of a valid URL: ‘system’ or ‘volumes’. All available URLs, request parameters and results are described in “HPE 3PAR Web Services API Developer’s Guide”.
  • body (dict) – Request parameter, used to modify an array object.
Return type:

tuple(int, dict)
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {‘key’:’value’}). Second value may be None if 3PAR array returns no message body.
timeout

Rest API client timeout.

Number of seconds that Rest API client waits for a response from Rest API server before generating a timeout exception. Different timeouts for connection setup and for getting first piece of data can be used. In this case, use tuple(float, float) with the first value being a connection delay and with the second value being a read delay. Alternatively, you can use one float value for both types of timeouts. ‘None’ value can be used instead not to limit the device response time. Default value: (1, None).

Usage examples

Session management

A simple way to open a Rest API session for StoreServ 3PAR arrays (with exception handling and session auto-closing):

from hpestorapi import StoreServ

with StoreServ('10.0.0.1', '3paruser', '3parpass') as array:
    try:
        array.open()
        # Perform requests to array (get/post/put/delete)
        # ...
    except Exception as error:
        print(error)
    else:
        # Analyze array response
        # ...
GET request

Simple GET request usage. This following code prints storage system information (name, serial number and IP address):

from hpestorapi import StoreServ

with StoreServ('10.0.0.1', '3paruser', '3parpass') as array:
    try:
        array.open()
        status, data = array.get('system')
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 200:
            print('Name=%s; ' % data['name'],
                  'SerialNumber=%s; ' % data['serialNumber'],
                  'Address=%s' % data['IPv4Addr']
                  )

GET request can also contain filter parameter (query=’…’). Filter specifications are described in “HPE 3PAR Web Services API Developer’s Guide” (see section “WSAPI query syntax”). The following code prints Remote Copy Groups names beginning with “dfs”.

from hpestorapi import StoreServ

with StoreServ('10.0.0.1', '3paruser', '3parpass') as array:
    try:
        array.open()
        status, data = array.get('remotecopygroups', query='name LIKE dfs*')
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 200:
            for rc_group in data['members']:
                print('RC group name = ', rc_group['name'])
POST request

The following code creates a new host on the 3PAR array:

from hpestorapi import StoreServ

newhost = {
    'name': 'restapi-test',
    'persona': 2,
    'FCWWNs': ['50:01:55:55:55:55:55:55',
               '50:01:66:66:66:66:66:66']
}

with StoreServ('10.0.0.1', '3paruser', '3parpass') as array:
    try:
        array.open()
        status, data = array.post('hosts', newhost)
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 201:
            print('Success')
        else:
            print('Failed! Device response: ', data)
DELETE request

The following code deletes a host from the HP 3PAR array:

from hpestorapi import StoreServ

with StoreServ('10.0.0.1', '3paruser', '3parpass') as array:
    hostname = 'restapi-test'
    try:
        array.open()
        status, data = array.delete(f'hosts/{hostname}')
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 200:
            print('Success')
        else:
            print('Fail! StoreServ 3PAR response: ', data)
PUT request

The following code modifies a host on the HPE 3PAR array (change host persona and location description):

from hpestorapi import StoreServ

hostname = 'restapi-test'
modify = {
    'persona': 1,
    'descriptors': {'location': 'Rack 2/42, Unit 34'}
}

with StoreServ('10.0.0.1', '3paruser', '3parpass') as array:
    try:
        array.open()
        status, data = array.put(f'hosts/{hostname}', body=modify)
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 200:
            print('Success')
        else:
            print('Fail! Device response: ', data)
Exception handling

Almost all methods that perform interaction with the HPE StoreServ 3PAR array can generate exceptions. The best practice is to handle these exceptions.

List of method that can raise exceptions:

  • StoreServ.open()
  • StoreServ.get()
  • StoreServ.post()
  • StoreServ.delete()
  • StoreServ.put()

Note

StoreServ class object constructor does not make any requests to an array; therefore, StoreServ object initilization cannot raise exceptions.

Exception handling example:

import requests

from hpestorapi import StoreServ

with StoreServ('10.0.0.1', '3paruser', '3parpass') as array:
    try:
        array.open()
        status, data = array.get('system')
    except requests.exceptions.SSLError as error:
        print('SSL error occured. Please check SSL connection '
              'options.')
    except requests.exceptions.ReadTimeout:
        print('Read timeout occured. The StoreServ 3PAR array did '
              'not send any data in the alloted amount of time.')
    except requests.exceptions.ConnectTimeout as error:
        print('Connection timeout occured. The request timed out '
              'while trying to connect to the StoreServ 3PAR '
              'array.')
    except hpestorapi.storeserv.AuthError as error:
        print('Wrong user name or password for the StoreServ 3PAR '
              'array.')
    except Exception as error:
        print(error)
    else:
        # We are successfully received response from array. You can
        # safely analyze array response (status and data variables)
        # ...

HPE Primera disk array

HPE Primera has minimal WSAPI changes comparing to HPE 3PAR array. To use Primera WSAPI use class hpestorapi.Primera with an interface similar to hpestorapi.StoreServ.

HPE XP7 and P9500 disk array

API reference

class hpestorapi.Xp(cvae, svp, serialnum, username, password, gen='XP7', port=23451, ssl=True)[source]

XP7 / P9500 class implementation.

__init__(cvae, svp, serialnum, username, password, gen='XP7', port=23451, ssl=True)[source]

HPE XP constructor.

Parameters:
  • cvae (str) – Hostname or IP address of HPE Command View AE Configuration Manager.
  • svp (str) – Hostname or IP address of Service Processor (SVP).
  • serialnum (str) – Array serial number (5 or 6 digits)
  • username (str) – User name for HPE XP disk array. Creating a dedicated user with limited rights is recommended. Using “arrayadmin” account is a bad practice.
  • password (str) – Password for HPE XP disk array.
  • gen (str) – (optional) Disk array generation. Should be P9500 or XP7. Default value: XP7.
  • port (int) – (optional) Command View AE configuration manager port. Default value: 23451
  • ssl (bool) – (optional) Use secure https (True) or plain http ( False). Default value: True.
Returns:

None.
open()[source]

Open a new Rest API session for a HPE XP array.

Call it prior any other requests. Call Xp.close() if you do not plan to use session anymore.

Return type:bool
Returns:Return True, if disk array provides a valid session key.
close(passive=False)[source]

Close Rest API session.

Parameters:passive (bool) – (optional) Do not try to close session in the array. Revoke the client session key after session timed out. Use this parameter only for method overriding in subclasses. There is no need of using it, as class implementation manages the session life cycle. Default value: False.
Returns:None
get(url, **kwargs)[source]

Make a HTTP GET request to HPE XP array. Use this method to get information about array objects.

Parameters:
  • url (str) – URL address. Th static part of the URL address is generated automatically. Example ofvalid URL: ‘pools’, ‘parity-groups’, ‘ldevs’. All available URL’s and requests result are described in “HPE XP7 Command View Advanced Edition REST API Reference Guide”.
  • params (dict) – (optional) Dictionary with query filter parameters. Described in ‘Query parameters’ section of “HPE XP7 Command View Advanced Edition REST API Reference Guide”.
  • json (dict) – (optional) A JSON serializable object send in the request body.
  • timeout (float) – (optional) Number of seconds that Rest API client waits for a response from the Rest server before generating a timeout exception. Default value: Xp.timeout.
  • verify (bool) – (optional) Either a boolean, controlling the Rest server’s TLS certificate verification, or a string, where it is a path to a CA bundle. Default value: False (no certificate verification).
  • cert (str) – (optional) String with path to ssl client certificate file (.pem) or tuple pair (‘cert’, ‘key’).
Return type:

(int, {})
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {‘key’:’value’})
post(url, **kwargs)[source]

Make a HTTP POST request to HPE XP array. Use this method to create a new object.

Parameters:
  • json (dict) – (optional) A JSON serializable object to send in the body of request.
  • timeout (float) – (optional) Number of seconds that Rest API client waits for a response from the Rest server before generating a timeout exception. Default value: Xp.timeout.
  • verify (bool) – (optional) Either a boolean, controlling the Rest server’s TLS certificate verification, or a string, where it is a path to a CA bundle. Default value: False (no certificate verification).
  • cert (str) – (optional) String with path to ssl client certificate file (.pem) or tuple pair (‘cert’, ‘key’).
Return type:

(int, {})
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {‘key’:’value’})
delete(url, **kwargs)[source]

Make a HTTP DELETE request to HPE XP array. Use this method to remove objects.

Parameters:
  • json (dict) – (optional) A JSON serializable object send in the request body.
  • timeout (float) – (optional) Number of seconds that Rest API client waits for a response from the Rest server before generating a timeout exception. Default value: Xp.timeout.
  • verify (bool) – (optional) Either a boolean, controlling the Rest server’s TLS certificate verification, or a string, where it is a path to a CA bundle. Default value: False (no certificate verification).
  • cert (str) – (optional) String with path to ssl client certificate file (.pem) or tuple pair (‘cert’, ‘key’).
Return type:

(int, {})
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {‘key’:’value’})
put(url, **kwargs)[source]

Perform HTTP PUT request to HPE XP array.

Parameters:
  • json (dict) – (optional) A JSON serializable object to send in the body of request.
  • timeout (float) – (optional) Number of seconds that Rest API client waits for a response from the Rest server before generating a timeout exception. Default value: Xp.timeout.
  • verify (bool) – (optional) Either a boolean, controlling the Rest server’s TLS certificate verification, or a string, where it is a path to a CA bundle. Default value: False (no certificate verification).
  • cert (str) – (optional) String with path to ssl client certificate file (.pem) or tuple pair (‘cert’, ‘key’).
Return type:

(int, {})
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {‘key’:’value’})
timeout

Rest API client timeout.

Number of seconds that Rest API client waits for a response from Rest API server before generating a timeout exception. Different timeouts for connection setup and for getting first piece of data can be used. In this case, use tuple(float, float) with the first value being a connection delay and with the second value being a read delay. Alternatively, you can use one float value for both types of timeouts. ‘None’ value can be used instead not to limit the device response time. Default value: (1, None).

Usage examples

Session management

Open a Rest API session for an HPE XP array:

import hpestorapi

with hpestorapi.Xp('cvae.domain.com', 'svp.domain.com', '123456',
                   'arrayuser', 'arraypassword') as array:
    try:
        array.open()
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        # Perform requests to array (get/post/put/delete)
        # ...
GET request

A simple GET request use. The following code prints a pool list from HPE XP array:

import hpestorapi

with hpestorapi.Xp('cvae.domain.com', 'svp.domain.com', '123456',
                   'arrayuser', 'arraypassword') as array:
    try:
        array.open()
        status, body = array.get('pools')
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 200:
            for pool in body['data']:
                print('ID=%s ' % pool['poolId'],
                      'Name=%s ' % pool['poolName'],
                      'Type=%s' % pool['poolType']
                      )
POST request

The following code creates a new ldev on the XP array:

import hpestorapi

newvol = {'poolId': 1, 'byteFormatCapacity': '1G'}

with hpestorapi.Xp('cvae.domain.com', 'svp.domain.com', '123456',
                   'arrayuser', 'arraypassword') as array:
    try:
        array.open()
        status, body = array.post('ldevs', json=newvol)
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 200:
            print('Success')
        else:
            print('Cannot create ldev')
DELETE request

The following code deletes an ldev 62:

import hpestorapi

ldevid=62

array = hpestorapi.Xp('cvae.domain.com', 'svp.domain.com', '123456',
                      'arrayuser', 'arraypassword') as array:
    try:
        array.open()
        status, body = array.post(f'ldevs/62')
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 200:
            print('Success')
        else:
            print(f'Cannot delete ldev with id {ldevid}')
PUT request

The following code changes the label for an ldev 62:

import hpestorapi

ldevid = 62
settings = {'label': 'RestAPI_Test'}

with hpestorapi.Xp('cvae.domain.com', 'svp.domain.com', '123456',
                   'arrayuser', 'arraypassword') as array:
    try:
        array.open()
        status, body = array.put(f'ldevs/{ldevid}', json=settings)
    except Exception as error:
        print('Something went wrong:')
        raise error
    else:
        if status == 200:
            print('Success')
        else:
            print('Cannot create ldev')
Exception handling
import requests
import hpestorapi

with hpestorapi.Xp('cvae.domain.com', 'svp.domain.com', '123456',
                   'arrayuser', 'arraypassword') as array:
    try:
        array.open()
    except requests.exceptions.SSLError as error:
        print('Cannot connect to Configuration Manager. SSL cert '
              'cheking is enabled, but Rest API server has no '
              'valid SSL certificate.')
    except requests.exceptions.ReadTimeout:
        timeout = array.http_timeout
        print('Read timeout occured. The Rest server did not '
              'send any data in the allotted amount of time ',
              timeout)
    except requests.exceptions.ConnectTimeout as error:
        print('Connection timeout occured. The request timed out '
              'while trying to connect to the Rest server.')
    except hpestorapi.Xp.AuthError as error:
        print('Wrong username or password for the HPE XP array')
    except Exception as error:
        print(error)
    else:
        # Perform requests to array (get/post/put/delete)
        # ...

HPE StoreOnce Gen 3 disk backup

API references

class hpestorapi.StoreOnceG3(address, user, password, cookie_dir=None, port=443)[source]

HPE StoreOnce Gen 3 disk backup device implementation class.

__init__(address, user, password, cookie_dir=None, port=443)[source]

HPE StoreOnceG3 constructor.

Parameters:
  • address (str) – Hostname or IP address of HPE StoreOnce disk backup device.
  • user (str) – Username for HPE StoreOnce disk backup device.
  • password (str) – Password for HPE StoreOnce disk backup device.
  • cookie_dir (str) – (optional) Directory for authentication cookies.
  • port (int) – (optional) Custom port number for StoreOnce device.
Returns:

None.
cookie_path

Generate cookie file path.

Return type:str
Returns:Cookie file path
cookie_auth
query(url, method, **kwargs)[source]

Perform HTTP request to HPE 3PAR StoreOnce Gen3 device.

get(url, **kwargs)[source]

Make a HTTP GET request to HPE StoreOnce disk backup device.

Use this method to get information about objects.

Parameters:
  • url (str) – URL address. The static part of URL address is generated automatically. Example of valid URL: ‘cluster’ or ‘cluster/servicesets’. All available URLs and requests result are described in “HPE StoreOnce 3.18.2 REST API developer Guide”.
  • filter (RequestsCookieJar) – (optional) Filter cookies, that were generated by method StoreOnceG3.filter()
  • timeout (int) – (optional) Number of seconds that Rest API client waits for a response from the Rest server before generating a timeout exception. Default value: StoreOnceG3.timeout.
Return type:

(int, string)
Returns:

Tuple with HTTP status code and xml string with the request result. For example: (200, ‘<xml> … </xml>’).
post(url, **kwargs)[source]

Make a HTTP POST request to HPE StoreOnce disk backup device.

Use this method to create new objects.

Parameters:
  • url (str) – URL address. Base static part of URL address is generated automatically. Example of valid url: ‘cluster’ or ‘cluster/servicesets’. All available URLs and requests result are described in “HPE StoreOnce 3.18.2 REST API developer Guide”.
  • timeout (int) – (optional) Number of seconds that Rest API client waits for a response from the Rest server before generating a timeout exception. Default value: StoreOnceG3.timeout.
Return type:

(int, string)
Returns:

Tuple with HTTP status code and xml string with request result. For example: (200, ‘<xml> … </xml>’).
put(url, **kwargs)[source]

Make a HTTP PUT request to HPE Storeonce disk backup device.

Method used to update objects.

Parameters:
  • url (str) – URL address. The static part of URL address is generated automatically. Example of valid URL: ‘cluster’ or ‘cluster/servicesets’. All available url’s and requests result are described in “HPE StoreOnce 3.18.2 REST API developer Guide”
  • timeout (int) – (optional) Number of seconds that Rest API client waits for a response from the Rest server before generating a timeout exception. Default value: StoreOnceG3.timeout.
Return type:

(int, string)
Returns:

Tuple with HTTP status code and xml string with request result. For example: (200, ‘<xml> … </xml>’).
delete(url, **kwargs)[source]

Make a HTTP DELETE request to HPE Storeonce disk backup device.

Use this method to delete objects.

Parameters:
  • url (str) – URL address. Base part of url address is generated automatically and you should not care about it. Example of valid url: ‘cluster’ or ‘cluster/servicesets’. All available url’s and requests result are described in “HPE StoreOnce 3.18.2 REST API developer Guide”
  • timeout (int) – (optional) Number of seconds that Rest API client waits for a response from the Rest server before generating a timeout exception. Default value: StoreOnceG3.timeout.
Return type:

(int, string)
Returns:

Tuple with HTTP status code and xml string with request result. For example: (200, ‘<xml> … </xml>’).
open(use_cookie_file=True)[source]

Open new Rest API session for HPE StoreOnce disk backup device.

Call it prior any other requests. Call StoreOnceG3.close() if
you do not plan to use a session anymore.
Parameters:use_cookie_file (bool) – (optional) Try to load authentication cookie from cookie file.
Returns:None
filter(url, parameters, **kwargs)[source]

Get cookies for query with filtering.

Parameters:url (str) – Filter URL address.
Return type:requests.cookies.RequestsCookieJar()
Returns:Filtering cookie
timeout

Rest API client timeout.

Number of seconds that Rest API client waits for a response from Rest API server before generating a timeout exception. Different timeouts for connection setup and for getting first piece of data can be used. In this case, use tuple(float, float) with the first value being a connection delay and with the second value being a read delay. Alternatively, you can use one float value for both types of timeouts. ‘None’ value can be used instead not to limit the device response time. Default value: (1, None).

Usage examples

Session management

Open Rest API session for StoreOnce G3 disk backup device:

import hpestorapi

with hpestorapi.StoreOnceG3('10.0.0.1', 'Admin', 'password') as so:
    try:
        so.open()
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        # Perform requests to StoreOnce (get/post/put/delete)
        # ...
GET request

Simple GET request usage. This code print StoreOnce G3 Catalyst Stores:

import xml.etree.ElementTree
import hpestorapi

with hpestorapi.StoreOnceG3('10.0.0.1', 'Admin', 'password') as so:
    try:
        so.open()
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        status, data = so.get('/cluster')
        if status == 200:
            tree = xml.etree.ElementTree.fromstring(data)
            name = tree.find('./cluster/properties/applianceName').text
            model = tree.find('./cluster/properties/productClass').text
            print(f'SO Name = "{name}"')
            print(f'SO Model = "{model}"')
POST request

POST request usage. This code activate license for StoreOnce G3:

import hpestorapi

body = {'key': 'demo', 'opcode': 'add'}

with hpestorapi.StoreOnceG3('10.0.0.1', 'Admin', 'password') as so:
    try:
        so.open()
        status, data = so.post('/d2dlicenses', params=body)
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        if status == 200:
            print('Demo license activation success.')
        else:
            print('License activation failed.'
                  'Http code: %s. Response body: %s',
                  status, data)
DELETE request

This code remove from Service Set 1 Catalyst Store 0:

import hpestorapi

with hpestorapi.StoreOnceG3('10.0.0.1', 'Admin', 'password') as so:
    try:
        so.open()
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        sset = 1
        store = 0
        status, data = so.delete(f'/cluster/servicesets/{sset}'
                                 f'/services/cat/stores/{store}')
        if status == 204:
            print('Catalyst store deleted')
        else:
            print('Can not delete catalyst store.'
                  'Http code: %s. Response: %s',
                  status, data)
PUT request

This code add NTP server to StoreOnce G3 configuration:

import hpestorapi

with hpestorapi.StoreOnceG3('10.0.0.1', 'Admin', 'password') as so:
    try:
        print('Something went wrong:')
        so.open()
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        body = {'add': 'true', 'servers': '10.0.0.2'}
        status, data = so.put('/d2dservices/clusterconf/ntp',
                              params=body)
        if status == 200:
            print('Catalyst store deleted')
        else:
            print('Can not delete catalyst store.'
                  'Http code: %s. Response body: %s',
                  status, data)
Iterate multipage objects

This code print all Catalyst items from all Catalyst stores:

from hpestorapi import StoreOnceG3
from hpestorapi.storeonce3 import Iterator
import xml.etree.ElementTree

with StoreOnceG3('10.0.0.1', 'Admin', 'password') as so:
    try:
        so.open()
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        # Print table header row
        print('%15s %8s %30s %15s' % ('Store', 'ID', 'Name', 'Status'))

        # Iterate all ServiceSets
        for sset_xml in Iterator(so, '/cluster/servicesets',
                                 './servicesets/serviceset'):
            sset = xml.etree.ElementTree.fromstring(sset_xml)
            ssid = sset.find('./properties/ssid').text

            # Iterate all catalyst Stores
            store_url = (f'/cluster/servicesets'
                         f'/{ssid}/services/cat/stores/')
            for store_xml in Iterator(so, store_url, './stores/store'):
                store = xml.etree.ElementTree.fromstring(store_xml)
                store_id = store.find('./properties/id').text
                store_name = store.find('./properties/name').text

                # Iterate all Catalyst Items
                item_url = (f'/cluster/servicesets/{ssid}'
                            f'/services/cat/stores/{store_id}/items/')
                for item_xml in Iterator(so, item_url, './items/item'):
                    item = xml.etree.ElementTree.fromstring(item_xml)
                    item_id = item.find('./properties/id').text
                    item_name = item.find('./properties/name').text
                    item_status = item.find('./properties/status').text

                    print('%15s %8s %30s %15s' % (store_name, item_id,
                                                  item_name, item_status))

HPE StoreOnce Gen 4 disk backup

API references

class hpestorapi.StoreOnceG4(address, username, password)[source]

HPE StoreOnce Gen 4 backup device implementation class.

__init__(address, username, password)[source]

HPE StoreOnce Gen 4 disk backup constructor.

Parameters:
  • address (str) – Hostname or IP address of HPE StoreOnce device.
  • username (str) – Username for HPE StoreOnce device.
  • password (str) – Password for HPE StoreOnce device.
Returns:

None.
open(verify=False)[source]

Open new Rest API session for HPE StoreOnce Gen 4 disk backup.

You should call it prior any other requests. Do not forget to call
StoreOnceG4.close() if you don’t plan to use current session anymore.
Parameters:verify (bool|str) – (optional) Either a boolean, in which case it controls whether we verify the Rest server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. By default: False (do not check certificate).
Returns:None
close()[source]

Close Rest API session.

You don’t need to run it manually if you use context manager.

Returns:None
get(url, **kwargs)[source]

Perform HTTP GET request to HPE Storeonce G4 disk backup device.

This method used to get information about objects.

Parameters:
  • url (str) – URL address. Base part of url address is generated automatically and you should not care about it. Example of valid url: ‘/rest/alerts’ or ‘/api/v1/management-services/licensing’. All available url’s and requests result are described in HPE StoreOnce REST API
  • json (dict) – (optional) A JSON serializable object to send in the body of request.
  • params (dict) – (optional) Dictionary with url encoded parameters.
  • timeout (float|tuple) – (optional) How many second to wait for the Rest server response before giving up. By default use same value as StoreOnceG4.timeout.
Return type:

tuple(int, dict())
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {…}) or (204, None).
post(url, **kwargs)[source]

Perform HTTP POST request to HPE StoreOnce G4 disk backup device.

This method used to create new object.

Parameters:
  • url (str) –

    URL address. Base part of url address is generated automatically and you should not care about it. Example of valid url: ‘/rest/alerts’ or ‘/api/v1/management-services/licensing’. All available url’s and requests result are described in HPE StoreOnce REST API

  • json (dict) – (optional) A JSON serializable object to send in the body of request.
  • params (dict) – (optional) Dictionary with url encoded parameters.
  • timeout (float|tuple) – (optional) How many second to wait for the Rest server response before giving up. By default use same value as StoreOnceG4.timeout.
Return type:

tuple(int, dict())
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {…}) or (204, None).
delete(url, **kwargs)[source]

Perform HTTP DELETE request to HPE StoreOnce G4 disk backup device array.

This method used to remove objects.

Parameters:
  • url (str) –

    URL address. Base part of url address is generated automatically and you should not care about it. Example of valid url: ‘/rest/alerts’ or ‘/api/v1/management-services/licensing’. All available url’s and requests result are described in HPE StoreOnce REST API

  • json (dict) – (optional) A JSON serializable object to send in the body of request.
  • params (dict) – (optional) Dictionary with url encoded parameters.
  • timeout (float|tuple) – (optional) How many second to wait for the Rest server response before giving up. By default use same value as StoreOnceG4.timeout.
Return type:

tuple(int, dict())
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {…}) or (204, None).
put(url, **kwargs)[source]

Perform HTTP PUT request to HPE StoreOnce G4 disk backup device array.

This method used to modify objects.

Parameters:
  • url (str) –

    URL address. Base part of url address is generated automatically and you should not care about it. Example of valid url: ‘/rest/alerts’ or ‘/api/v1/management-services/licensing’. All available url’s and requests result are described in HPE StoreOnce REST API

  • json (dict) – (optional) A JSON serializable object to send in the body of request.
  • params (dict) – (optional) Dictionary with url encoded parameters.
  • timeout (float|tuple) – (optional) How many second to wait for the Rest server response before giving up. By default use same value as StoreOnceG4.timeout.
Return type:

tuple(int, dict())
Returns:

Tuple with HTTP status code and dict with request result. For example: (200, {…}) or (204, None).
timeout

Rest API client timeout.

Number of seconds that Rest API client waits for a response from Rest API server before generating a timeout exception. Different timeouts for connection setup and for getting first piece of data can be used. In this case, use tuple(float, float) with the first value being a connection delay and with the second value being a read delay. Alternatively, you can use one float value for both types of timeouts. ‘None’ value can be used instead not to limit the device response time. Default value: (1, None).

Usage examples

Session management

Open Rest API session for StoreOnce Gen 4 disk backup device:

import hpestorapi

with hpestorapi.StoreOnceG4('10.0.0.1', 'Admin', 'password') as so:
    try:
        print('Something went wrong:')
        so.open()
    except Exception as error:
        print(error)
    else:
        # Perform requests to StoreOnce (get/post/put/delete)
        # ...
GET request

Simple GET request usage. This code print StoreOnce G4 groups:

import hpestorapi

with hpestorapi.StoreOnceG4('10.0.0.1', 'Admin', 'password') as so:
    try:
        so.open()
        status, data = so.get('/rest/groups')
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        if status == 200:
            for group in data['members']:
                print(group['groupName'])
POST request

This code will create new Catalyst client:

import hpestorapi

with hpestorapi.StoreOnceG4('10.0.0.1', 'Admin', 'password') as so:
    new_client = {'name': 'sqlserver', 'description': 'New host',
                  'password': 'secretpass'
    }
    try:
        so.open()
        status, data = so.post('/api/v1/data-services/cat/clients',
                               json=new_client)
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        if status == 201:
            print('Host succefully added.')
        else:
            print('Fail! Cannot add new catalyst client. Details:', data)
DELETE request

This code remove CIFS share:

import hpestorapi

with hpestorapi.StoreOnceG4('10.0.0.1', 'Admin', 'password') as so:
    share = 'CifsShare01'
    try:
        so.open()
        status, _ = so.delete('/api/v1/data-services/nas/shares'
                              '/share/{id}'.format(id=share))
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        if status == 204:
            print('Share succefully removed.')
        elif status == 404:
            print('Fail! Share does not exist.')
        else:
            print('Fail! Cannot remove share.')
PUT request

This code will update current SMTP configuration:

import hpestorapi

with hpestorapi.StoreOnceG4('10.0.0.1', 'Admin', 'password') as so:
    body = {'emailConfigurations': {
        'smtpPort': 25,
        'enabled': 'true',
        'senderEmailAddress': 'sender@company.com',
        'password': 'secretpassword',
        'smtpServer': 'email.company.com'
    }
    }
    try:
        so.open()
        status, data = so.put('/rest/email', json=body)
    except Exception as error:
        print('Something went wrong:')
        print(error)
    else:
        print('SMTP configuration succefully updated.')

Debug

Enable logging

hpestorapi uses Python’s Standard Library logging module. Simple python script with enabled debug logging:

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import logging
import hpestorapi

if __name__ == '__main__':
    # Setup logging format, level, logfile
    logfmt = ('[%(asctime)s] '
              '%(levelname)-8s '
              '%(filename)-12s:%(lineno)-3d '
              '%(message)s')

    logging.basicConfig(format=logfmt,
                        level=logging.WARNING,
                        filename='messages.log')

    # Set XP, 3PAR, StoreOnce loglevel
    logging.getLogger("hpestorapi.xp").setLevel(logging.DEBUG)
    logging.getLogger("hpestorapi.storeserv").setLevel(logging.DEBUG)
    logging.getLogger("hpestorapi.storeonce").setLevel(logging.DEBUG)

    """
    Your code starts here
    """

Five logging levels are used:

  • DEBUG
  • INFO
  • WARNING
  • ERROR
  • FATAL

Bug reports

If you have found a bug, please create an GitHub issue. Your questions are welcomed in gitter chat. And do not hesitate to contact me: Ivan Smirnov <ivan.smirnov@hpe.com>