Releases: PureStorage-OpenConnect/rest-client
1.19.0
Adds support for Pure Storage FlashArray REST versions 1.19
New APIs:
-
add_tag_to_volume(self, volume, key, value, **kwargs):
Add tag to volume and return a dictionary describing it.
Requires use of REST API 1.19 or later. -
remove_tag_from_volume(self, volume, key, **kwargs):
Remove a tag from a volume and return a dictionary describing it.
Requires use of REST API 1.19 or later. -
create_pod_replica_link(self, local_pod_name, remote_pod_name, **kwargs):
Create replica-link.
Requires use of REST API 1.19 or later. -
delete_pod_replica_link(self, local_pod_name, remote_pod_name):
Delete replica-link.
Requires use of REST API 1.19 or later. -
list_pod_replica_links(self, **kwargs):
List replica-link.
Requires use of REST API 1.19 or later. -
pause_pod_replica_link(self, local_pod_name, remote_pod_name, **kwargs):
Create replica-link.
Requires use of REST API 1.19 or later. -
resume_pod_replica_link(self, local_pod_name, remote_pod_name, **kwargs):
Resume replica-link.
Requires use of REST API 1.19 or later. -
promote_pod(self, pod, **kwargs):
Promote pod.
Requires use of REST API 1.19 or later. -
demote_pod(self, pod, **kwargs):
Demote pod
Requires use of REST API 1.19 or later.
Other:
- Fixes a bug where an exception raised by requests. It should not
assume that the error object will always be of PureErr type.
1.18.1
1.18.0
1.17.0
Adds support for Pure Storage FlashArray REST versions 1.17
New APIs in 1.17:
- get_eula(self)
Get EULA status of the array.
Requires use of REST API 1.17 or later.
- set_eula(self, **kwargs)
Accept EULA.
Requires use of REST API 1.17 or later.
- connect_azure_offload(self, name, **kwargs)
Connect an offload Azure Blob target.
Requires use of REST API 1.17 or later.
- disconnect_azure_offload(self, name)
Disconnect an Azure Blob offload target.
Requires use of REST API 1.17 or later.
- list_azure_offload(self, **kwargs)
Return a list of dictionaries describing connected Azure Blob offload targets.
Requires use of REST API 1.17 or later.
- get_azure_offload(self, name, **kwargs)
Return a dictionary describing the connected Azure Blob offload target.
Requires use of REST API 1.17 or later.
- enable_app_vnc(self, name)
Enable vnc access for the specified app.
Requires use of REST API 1.17 or later.
- disable_app_vnc(self, name)
Disable vnc access for the specified app.
Requires use of REST API 1.17 or later.
- list_app_nodes(self, **kwargs)
Returns a list of dictionaries describing app nodes.
Requires use of REST API 1.17 or later.
- get_app_node(self, app_name, **kwargs)
Returns a list of dictionaries describing the nodes of an app.
Requires use of REST API 1.17 or later.
- schedule_maintenance_window(self, **kwargs)
Schedule a maintenance window and return a dictionary describing it.
Requires use of REST API 1.17 or later.
- unschedule_maintenance_window(self, **kwargs)
Unschedule a maintenance window and return a dictionary describing it.
Requires use of REST API 1.17 or later.
- list_maintenance_windows(self, **kwargs)
Return a list of dictionaries describing each maintenance window.
Requires use of REST API 1.17 or later.
1.16.0
Adds support for Pure Storage FlashArray REST versions 1.15 and 1.16
New APIs in 1.16:
- connect_s3_offload(self, name, **kwargs)
Connect an offload S3 target. - disconnect_s3_offload(self, name)
Disconnect an S3 offload target. - list_s3_offload(self, **kwargs)
Return a list of dictionaries describing connected S3 offload targets. - get_s3_offload(self, name, **kwargs)
Return a dictionary describing the connected S3 offload target. - list_directory_service_roles(self, **kwargs)
Get directory service groups for roles. - set_directory_service_roles(self, **kwargs)
Set directory service groups for roles. - get_global_admin_attributes(self)
Return a dictionary describing the existing global admin attributes. - set_global_admin_attributes(self, **kwargs)
Set the global admin attributes. - list_locked_admins_lockout_info(self)
Return a list of dictionaries describing lockout information for locked admins. - get_admin_lockout_info(self, admin)
Return a dictionary describing lockout information for a specific admin. - unlock_admin(self, admin)
Unlocks an admin - send_pgroup_snapshot(self, source, **kwargs)
Send an existing pgroup snapshot to target(s) - list_app_software(self, **kwargs)
List app software. - get_app_software(self, name, **kwargs)
List the specified app software. - install_app(self, name, **kwargs)
Install the specified app. - uninstall_app(self, name, **kwargs)
Uninstall the specified app. - enable_app(self, name)
Enable the specified app. - disable_app(self, name)
Disable the specified app.
Changed APIs:
1.15 changes:
- adding support for failover preference:
- get_pod() and list_pods() add field “failover_preference” to output
- set_pod() and create_pod() accept parameter “failover_preference”
- adding support for preferred array:
- get_host() and list_hosts() add field “preferred_array” to output
- set_host() and create_host() accept parameter “preferred_array”
1.16 changes:
- Array Connection:
- list_array_connections() the field "type" is now a string, instead of a list of one string.
- list_array_connections() the field "window" is now a dictionary instead of a list of dictionaries.
- Volume groups:
- get_vgroup() now allows parameter “total” with “space”
- create_vgroup() now accepts kwargs
- adding Qos parameters
- NVMe-oF:
- get_host() adds field “nqn” to output, a list of nqn addresses
- create_hosts() accepts parameter “nqnlist”
- set_host accepts parameters “addnqnlist”, “remnqnlist” and “nqnlist”
- get_port() adds fields “nqn” and “target_nqn” to output
- Pods:
- get_pod() and list_pods() accept field “on”, to list pods on remote arrays
- get_pod() and list_pods() add field “progress” to output
- create_pod() now accepts kwargs
- _set_pod() renamed to set_pod()
- Directory Service:
- Groups are now handled in the new list_directory_service_roles() and set_directory_service_roles()
- get_directory_service() no longer accepts parameter “groups”
- set_directory_service() no longer accepts parameters "array_admin_group", "readonly_group", "storage_admin_group" and "group_base"
- Certificates:
- get_kmip() and list_kmip() rename field “URI” to “uri” in output
- get_certificate() and list_certificates() add field “common_name” to output
1.14.1
Adds support for managing offload targets.
New APIs:
-
connect_nfs_offload(self, name, **kwargs):
Connect an nfs offload target.
Requires the use of REST API 1.14 or later. -
disconnect_nfs_offload(self, name):
Disconnect an offload target.
Requires the use of REST API 1.14 or later. -
list_offload(self, **kwargs):
Return a list of dictionaries describing connected offload targets.
Requires the use of REST API 1.14 or later. -
list_nfs_offload(self, **kwargs):
Return a list of dictionaries describing connected nfs offload targets.
Requires the use of REST API 1.14 or later. -
get_offload(self, name, **kwargs):
Return a dictionary desribing connected offload targets.
Requires the use of REST API 1.14 or later. -
get_nfs_offload(self, name, **kwargs):
Return a dictionary describing connected nfs offload targets.
Requires the use of REST API 1.14 or later.
1.14.0
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.
Version 1.6.1
Minor update for 1.6 release.