Merge pull request #51 from PureStorage-OpenConnect/add_fb2dot7_fb2dot8

Release 1.31.0: Added FlashBlade REST 2.7 and 2.8

Author: tlewis-ps

docs/changelog.rst

@@ -6,6 +6,7 @@ A log of changes by version and date.
 ======= ========== =====
 Version Date       Notes
 ======= ========== =====
+1.31.0  01/25/2023 Added FlashBlade 2.7 and 2.8 clients
 1.30.0  01/12/2023 Added FlashArray 2.20 client
 1.29.0  12/09/2022 Added FlashArray 2.17 and 2.19 clients
 1.28.0  10/07/2022 Added FlashBlade 2.5 and 2.6 clients

docs/conf.py

@@ -27,9 +27,9 @@
 author = u'Pure Storage, Inc.'
 
 # The short X.Y version
-version = u'1.30'
+version = u'1.31'
 # The full version, including alpha/beta/rc tags
-release = u'1.30.0'
+release = u'1.31.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/fb_reference.rst

@@ -52,6 +52,16 @@ FlashBlade REST 2.6 Client
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: pypureclient.flashblade.FB_2_6.client.Client
+
+FlashBlade REST 2.7 Client
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.FB_2_7.client.Client
+
+FlashBlade REST 2.8 Client
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.FB_2_8.client.Client
     :members:
 
 
@@ -305,6 +315,30 @@ Bucket
 .. autoclass:: pypureclient.flashblade.Bucket
    :members:
 
+BucketDefaults
+~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.BucketDefaults
+   :members:
+
+BucketDefaultsReadonly
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.BucketDefaultsReadonly
+   :members:
+
+BucketEradicationConfig
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.BucketEradicationConfig
+   :members:
+
+BucketPatch
+~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.BucketPatch
+   :members:
+
 BucketPerformance
 ~~~~~~~~~~~~~~~~~
 
@@ -485,18 +519,36 @@ FileInfo
 .. autoclass:: pypureclient.flashblade.FileInfo
    :members:
 
+FileLock
+~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.FileLock
+   :members:
+
 FileSystem
 ~~~~~~~~~~
 
 .. autoclass:: pypureclient.flashblade.FileSystem
    :members:
 
+FileSystemClient
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.FileSystemClient
+   :members:
+
 FileSystemGroupPerformance
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: pypureclient.flashblade.FileSystemGroupPerformance
    :members:
 
+FileSystemLockNlmReclamation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.FileSystemLockNlmReclamation
+   :members:
+
 FileSystemPatch
 ~~~~~~~~~~~~~~~
 
@@ -545,6 +597,12 @@ FileSystemUserPerformance
 .. autoclass:: pypureclient.flashblade.FileSystemUserPerformance
    :members:
 
+FilelockRange
+~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.FilelockRange
+   :members:
+
 FixedLocationReference
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -563,6 +621,12 @@ FixedReferenceNameOnly
 .. autoclass:: pypureclient.flashblade.FixedReferenceNameOnly
    :members:
 
+FixedReferenceNoId
+~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.FixedReferenceNoId
+   :members:
+
 FixedReferenceNoResourceType
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -803,6 +867,18 @@ ObjectBacklog
 .. autoclass:: pypureclient.flashblade.ObjectBacklog
    :members:
 
+ObjectLockConfigBase
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.ObjectLockConfigBase
+   :members:
+
+ObjectLockConfigRequestBody
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.ObjectLockConfigRequestBody
+   :members:
+
 ObjectStoreAccessKey
 ~~~~~~~~~~~~~~~~~~~~
 
@@ -851,6 +927,18 @@ ObjectStoreAccount
 .. autoclass:: pypureclient.flashblade.ObjectStoreAccount
    :members:
 
+ObjectStoreAccountPatch
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.ObjectStoreAccountPatch
+   :members:
+
+ObjectStoreAccountPost
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.ObjectStoreAccountPost
+   :members:
+
 ObjectStoreRemoteCredentialGetResp
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -1121,6 +1209,12 @@ Space
 .. autoclass:: pypureclient.flashblade.Space
    :members:
 
+SpaceExtended
+~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.SpaceExtended
+   :members:
+
 Subnet
 ~~~~~~
 
@@ -1217,6 +1311,18 @@ UserQuotaPost
 .. autoclass:: pypureclient.flashblade.UserQuotaPost
    :members:
 
+VerificationKey
+~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.VerificationKey
+   :members:
+
+VerificationKeyPatch
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.flashblade.VerificationKeyPatch
+   :members:
+
 model
 ~~~~~
 
@@ -1746,7 +1852,7 @@ get_buckets
 patch_buckets
 '''''''''''''
 
-.. literalinclude:: source/examples/FB2.0/patch_buckets.py
+.. literalinclude:: source/examples/FB2.8/patch_buckets.py
     :language: python
 
 get_buckets_performance
@@ -1758,7 +1864,7 @@ get_buckets_performance
 post_buckets
 ''''''''''''
 
-.. literalinclude:: source/examples/FB2.0/post_buckets.py
+.. literalinclude:: source/examples/FB2.8/post_buckets.py
     :language: python
 
 get_buckets_s3_specific_performance
@@ -2064,6 +2170,30 @@ get_file_systems_groups_performance
 .. literalinclude:: source/examples/FB2.0/get_file_systems_groups_performance.py
     :language: python
 
+get_file_systems_locks_clients
+''''''''''''''''''''''''''''''
+
+.. literalinclude:: source/examples/FB2.8/get_file_systems_locks_clients.py
+    :language: python
+
+delete_file_systems_locks
+'''''''''''''''''''''''''
+
+.. literalinclude:: source/examples/FB2.8/delete_file_systems_locks.py
+    :language: python
+
+get_file_systems_locks
+''''''''''''''''''''''
+
+.. literalinclude:: source/examples/FB2.8/get_file_systems_locks.py
+    :language: python
+
+post_file_systems_locks_nlm_reclamations
+''''''''''''''''''''''''''''''''''''''''
+
+.. literalinclude:: source/examples/FB2.8/post_file_systems_locks_nlm_reclamations.py
+    :language: python
+
 patch_file_systems
 ''''''''''''''''''
 
@@ -2396,10 +2526,16 @@ get_object_store_accounts
 .. literalinclude:: source/examples/FB2.0/get_object_store_accounts.py
     :language: python
 
+patch_object_store_accounts
+'''''''''''''''''''''''''''
+
+.. literalinclude:: source/examples/FB2.8/patch_object_store_accounts.py
+    :language: python
+
 post_object_store_accounts
 ''''''''''''''''''''''''''
 
-.. literalinclude:: source/examples/FB2.0/post_object_store_accounts.py
+.. literalinclude:: source/examples/FB2.8/post_object_store_accounts.py
     :language: python
 
 Object Store Remote Credentials
@@ -3067,3 +3203,20 @@ get_usage_users
 .. literalinclude:: source/examples/FB2.0/get_usage_users.py
     :language: python
 
+Verification Keys
+~~~~~~~~~~~~~~~~~~
+
+The following examples assume that ``client`` is an instantiated ``flashblade.Client`` object as shown in :ref:`Instantiating a Client`.
+
+get_support_verification_keys
+'''''''''''''''''''''''''''''
+
+.. literalinclude:: source/examples/FB2.7/get_support_verification_keys.py
+    :language: python
+
+patch_support_verification_keys
+'''''''''''''''''''''''''''''''
+
+.. literalinclude:: source/examples/FB2.7/patch_support_verification_keys.py
+    :language: python
+

docs/source/examples/FB2.7/get_support_verification_keys.py

@@ -0,0 +1,8 @@
+# List the Challenge Response Verification Key for the array
+res = client.get_support_verification_keys()
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Other valid fields: continuation_token, limit, offset, sort, filter
+# See section "Common Fields" for examples

docs/source/examples/FB2.7/patch_support_verification_keys.py

@@ -0,0 +1,22 @@
+from pypureclient.flashblade import VerificationKeyPatch
+
+# Update the signed Verification Key for the array
+signed_public_key_text = """-----BEGIN PUBLIC KEY-----
+MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0
+eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR
+gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O
+nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum
+2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q
+sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr
+1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1
+64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R
+1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6
+SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+
+D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd
+FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==
+-----END PUBLIC KEY-----"""
+res = client.patch_support_verification_keys(key=VerificationKeyPatch(signed_verification_key=signed_public_key_text))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+

docs/source/examples/FB2.8/delete_file_systems_locks.py

@@ -0,0 +1,11 @@
+# Delete all locks created by a specified client IP
+res = client.delete_file_systems_locks(client_names='1.1.1.1')
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Delete a single lock by name
+res = client.delete_file_systems_locks(names='3-NFSv3-0-1024')
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))

docs/source/examples/FB2.8/get_file_systems_locks.py

@@ -0,0 +1,27 @@
+# Get all file locks and limit the number of returned entries to 1000
+res = client.get_file_systems_locks(limit=1000)
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Get a single lock information by lock name
+res = client.get_file_systems_locks(names="3-NFSv3-0-1024")
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Get all locks created by a client with specified client IP
+res = client.get_file_systems_locks(client_names='1.1.1.1')
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Get locks for a specific file
+res = client.get_file_systems_locks(file_system_names='root', paths='/dir/file')
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+
+# Other valid fields: file_system_ids, filter, inodes, continuation_token
+# See section "Common Fields" for examples

docs/source/examples/FB2.8/get_file_systems_locks_clients.py

@@ -0,0 +1,8 @@
+# Get all the clients (limit the result to 1000) who have acquired file locks
+res = client.get_file_systems_locks_clients(limit=1000)
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Other valid fields: filter, continuation_token
+# See section "Common Fields" for examples