Skip to content

Commit

Permalink
Version 1.14.0
Browse files Browse the repository at this point in the history
Adds support for Pure Storage FlashArray REST versions 1.12, 1.13, and 1.14

New Features:

- Added the ability to pass custom parameters into underlying HTTP request.
  Added the parameter request_kwargs which takes a dictionary that we will pass
  into each call to requests.request, allowing users to customize (e.g.) call
  timeouts. See the documentation of the requests library for more information
  about supported parameters.

New APIs:

- set_volume(self, volume, pgroup):
  Set an attribute of a volume.

- create_conglomerate_volume(self, volume):
  Create a conglomerate volume.
  Requires the use of REST API 1.13 or later.

- move_volume(self, volume, container):
  Move a volume to a new pod or vgroup.
  Requires the use of REST API 1.13 or later.

- list_admins(self, **kwargs):
  Return a list of dictionaries desribing local admins.
  Requires use of REST API 1.14 or later.

- create_admin(self, admin, **kwargs):
  Create an admin.
  Requires use of REST API 1.14 or later.

- delete_admin(self, admin, **kwargs):
  Delete an admin.
  Requires use of REST API 1.14 or later.

- set_admin(self, admin, **kwargs):
  Set an attribute of an admin.
  Requires use of REST API 1.14 or later.

- get_admin(self, admin):
  Return a dictionary describing an admin.

- create_vgroup(self, vgroup):
  Create a vgroup.
  Requires use of REST API 1.13 or later.

- destroy_vgroup(self, vgroup):
  Destroy a vgroup.
  Requires use of REST API 1.13 or later.

- eradicate_vgroup(self, vgroup):
  Eradicate a vgroup.
  Requires use of REST API 1.13 or later.

- get_vgroup(self, vgroup, **kwargs):
  Return a dictionary describing a vgroup.
  Requires use of REST API 1.13 or later.

- list_vgroups(self, vgroup, **kwargs):
  Return a list of dictionaries describing each vgroup.
  Requires use of REST API 1.13 or later.

- recover_vgroup(self, vgroup):
  Recover a destroyed vgroup.
  Requires use of REST API 1.13 or later.

- rename_vgroup(self, vgroup):
  Rename a vgroup.
  Requires use of REST API 1.13 or later.

- set_vgroup(self, vgroup, **kwargs):
  Set an attribute of a vgroup.
  Requires use of REST API 1.13 or later.

- create_pod(self, pod):
  Create a pod.
  Requires use of REST API 1.13 or later.

- clone_pod(self, source, dest, **kwargs):
  Clone an existing pod to a new one.
  Requires use of REST API 1.13 or later.

- destroy_pod(self, pod):
  Destroy a pod.
  Requires use of REST API 1.13 or later.

- eradicate_pod(self, pod):
  Eradicate a pod.
  Requires use of REST API 1.13 or later.

- get_pod(self, pod, **kwargs):
  Return a dictionary describing a pod.
  Requires use of REST API 1.13 or later.

- add_pod(self, pod, array):
  Add an array to a pod.
  Requires use of REST API 1.13 or later.

- remove_pod(self, pod, array):
  Remove an array from a pod.
  Requires use of REST API 1.13 or later.

- list_pods(self, **kwargs):
  Return a list of dictionaries describing each pod.
  Requires use of REST API 1.13 or later.

- rename_pod(self, pod, name):
  Rename a pod.
  Requires use of REST API 1.13 or later.

- recover_pod(self, pod):
  Recover a destroyed pod.
  Requires use of REST API 1.13 or later.

- list_certificates(self):
  Return a list of dictionaries describing each certificate.
  Requires use of REST API 1.12 or later.

- create_certificate(self, name, **kwargs):
  Create a new certificate.
  Requires use of REST API 1.12 or later.

- delete_certificate(self, name, **kwargs):
  Delete a certificate.
  Requires use of REST API 1.12 or later.

- create_kmip(self, name, **kwargs):
  Create a kmip configuration.
  Requires use of REST API 1.12 or later.

- delete_kmip(self, name, **kwargs):
  Delete a kmip configuration.
  Requires use of REST API 1.12 or later.

- list_kmip(self:
  Return a list of dictionaries describing each kmip configuration.
  Requires use of REST API 1.12 or later.

- get_kmip(self, name):
  Return a dictionary describing the kmip configuration.
  Requires use of REST API 1.12 or later.

- set_kmip(self, name, **kwargs):
  Set an attribute of a kmip configuration.
  Requires use of REST API 1.12 or later.

- test_kmip(self, name):
  Test a kmip configuration.
  Requires use of REST API 1.12 or later.

- get_smtp(self):
  Return a dictionary describing the smtp configuration.
  Requires use of REST API 1.14 or later.

- set_smtp(self):
  Set an attribute of the smtp configuration.
  Requires use of REST API 1.14 or later.
  • Loading branch information
Zach Olstein committed May 1, 2018
1 parent 43934a7 commit 0e6c703
Show file tree
Hide file tree
Showing 7 changed files with 895 additions and 134 deletions.
7 changes: 2 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ This library requires the use of python 2.6 or later and the third-party
library "requests".

Additionally, this library can only be used communicate with Flash Arrays that
support one or more REST API versions between 1.0 and 1.11; currently, this
support one or more REST API versions between 1.0 and 1.14; currently, this
includes any Flash Array running Purity 3.4.0 or later.


Capabilities
============
This library supports all functionality offered by REST API versions up to 1.11.
This library supports all functionality offered by REST API versions up to 1.14.

Note that different versions of the REST API offer different functionality, and
some operations may be unusable except on certain versions of the REST API. For
Expand Down Expand Up @@ -47,13 +47,10 @@ From the root directory of the rest-client
$ PYTHONPATH=$(pwd):$PYTHONPATH py.test test/*.py




Files
=====
* purestorage/ -- Contains library code.
* docs/ -- Contains API documentation, Makefile and conf.py.
* CHANGES.rst -- Library change log.
* LICENSE.txt -- Library BSD 2-Clause license.
* README.txt -- This document.

7 changes: 4 additions & 3 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Version Date Notes
1.6.1 05/30/2016 Minor bug fixes and sync code between GitHub and PyPI
1.8.0 11/02/2016 Add support for REST 1.7 and 1.8
1.11.0 09/05/2017 Add support for REST 1.9, 1.10, and 1.11
1.11.1 09/06/2017 Minor setup.py change for new PyPI interface
1.11.2 09/07/2017 Minor setup.py change for new PyPI interface
1.11.3 09/07/2017 Minor setup.py change for new PyPI interface
1.11.1 09/06/2017 Minor setup.py change for new PyPI interface
1.11.2 09/07/2017 Minor setup.py change for new PyPI interface
1.11.3 09/07/2017 Minor setup.py change for new PyPI interface
1.14.0 04/27/2017 Add support for REST 1.12, 1.13, and 1.14
======= ========== =====
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@
# built documents.
#
# The short X.Y version.
version = '1.11'
version = '1.14'
# The full version, including alpha/beta/rc tags.
release = '1.11.3'
release = '1.14.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Pure Storage FlashArray REST Client Documentation
================================================
=================================================

.. toctree::
:hidden:
Expand Down
Loading

0 comments on commit 0e6c703

Please sign in to comment.