Missing examples added (#96)

Author: Gregory-Bessonov

docs/source/examples/FB2.12/delete_buckets_bucket_access_policies.py

@@ -0,0 +1,6 @@
+# delete a bucket access policy by bucket name
+client.delete_buckets_bucket_access_policies(bucket_names=["bkt1"])
+# delete a bucket access policy by bucket id
+client.delete_buckets_bucket_access_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
+# delete a bucket access policy by name
+client.delete_buckets_bucket_access_policies(names=["bkt1/access-policy"])

docs/source/examples/FB2.12/delete_buckets_bucket_access_policies_rules.py

@@ -0,0 +1,6 @@
+# delete a bucket access policy rule by bucket name
+client.delete_buckets_bucket_access_policies_rules(bucket_names=["bkt1"], names=["myrule"])
+# delete a bucket access policy rule by bucket id
+client.delete_buckets_bucket_access_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"], names=["myrule"])
+# delete a bucket access policy rule by policy name
+client.delete_buckets_bucket_access_policies_rules(policy_names=["bkt1/access-policy"], names=["myrule"])

docs/source/examples/FB2.12/delete_buckets_cross_origin_resource_sharing_policies.py

@@ -0,0 +1,6 @@
+# delete a bucket cross-origin resource sharing policy by bucket name
+client.delete_buckets_cross_origin_resource_sharing_policies(bucket_names=["bkt1"])
+# delete a bucket cross-origin resource sharing policy by bucket id
+client.delete_buckets_cross_origin_resource_sharing_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
+# delete a bucket cross-origin resource sharing policy by name
+client.delete_buckets_cross_origin_resource_sharing_policies(names=["bkt1/cors-policy"])

docs/source/examples/FB2.12/delete_buckets_cross_origin_resource_sharing_policies_rules.py

@@ -0,0 +1,6 @@
+# delete a bucket cross-origin resource sharing policy rule by bucket name
+client.delete_buckets_cross_origin_resource_sharing_policies_rules(bucket_names=["bkt1"], names=["myrule"])
+# delete a bucket cross-origin resource sharing policy rule by bucket id
+client.delete_buckets_cross_origin_resource_sharing_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"], names=["myrule"])
+# delete a bucket cross-origin resource sharing policy rule by policy name
+client.delete_buckets_cross_origin_resource_sharing_policies_rules(policy_names=["bkt1/cors-policy"], names=["myrule"])

docs/source/examples/FB2.12/get_buckets_bucket_access_policies.py

@@ -0,0 +1,17 @@
+# list bucket access policy by bucket id
+res = client.get_buckets_bucket_access_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list bucket access policy by bucket name
+res = client.get_buckets_bucket_access_policies(bucket_names=["bkt1"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list bucket access policy by policy name
+res = client.get_buckets_bucket_access_policies(names=["bkt1/access-policy"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# Other valid fields: continuation_token, filter, limit, offset, sort
+# See section "Common Fields" for examples

docs/source/examples/FB2.12/get_buckets_bucket_access_policies_rules.py

@@ -0,0 +1,22 @@
+# list all bucket access policy rules by bucket id
+res = client.get_buckets_bucket_access_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list all bucket access policy rules by bucket name
+res = client.get_buckets_bucket_access_policies_rules(bucket_names=["bkt1"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list all bucket access policy rules by policy name
+res = client.get_buckets_bucket_access_policies_rules(policy_names=["bkt1/access-policy"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list specific bucket access policy rule
+res = client.get_buckets_bucket_access_policies_rules(policy_names=["bkt1/access-policy"], names=["myrule"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# Other valid fields: continuation_token, filter, limit, offset, sort
+# See section "Common Fields" for examples

docs/source/examples/FB2.12/get_buckets_cross_origin_resource_sharing_policies.py

@@ -0,0 +1,17 @@
+# list bucket cross-origin resource sharing policy by bucket id
+res = client.get_buckets_cross_origin_resource_sharing_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list bucket cross-origin resource sharing policy by bucket name
+res = client.get_buckets_cross_origin_resource_sharing_policies(bucket_names=["bkt1"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list bucket cross-origin resource sharing policy by policy name
+res = client.get_buckets_cross_origin_resource_sharing_policies(names=["bkt1/cors-policy"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# Other valid fields: continuation_token, filter, limit, offset, sort
+# See section "Common Fields" for examples

docs/source/examples/FB2.12/get_buckets_cross_origin_resource_sharing_policies_rules.py

@@ -0,0 +1,22 @@
+# list all bucket cross-origin resource sharing policy rules by bucket id
+res = client.get_buckets_cross_origin_resource_sharing_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list all bucket cross-origin resource sharing policy rules by bucket name
+res = client.get_buckets_cross_origin_resource_sharing_policies_rules(bucket_names=["bkt1"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list all bucket cross-origin resource sharing policy rules by policy name
+res = client.get_buckets_cross_origin_resource_sharing_policies_rules(policy_names=["bkt1/cors-policy"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# list specific bucket cross-origin resource sharing policy rule
+res = client.get_buckets_cross_origin_resource_sharing_policies_rules(policy_names=["bkt1/cors-policy"], names=["myrule"])
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+# Other valid fields: continuation_token, filter, limit, offset, sort
+# See section "Common Fields" for examples

docs/source/examples/FB2.12/patch_active_directory.py

@@ -0,0 +1,26 @@
+from pypureclient.flashblade import ActiveDirectoryPatch
+
+# Change existing Active Directory account LDAP, global catalog and kerberos servers, encryption types, and
+# service principal names.
+# Can alternatively supply fqdns instead of service_principal_names
+ad_config = ActiveDirectoryPatch(
+    directory_servers=["ldap.my-corporation.com", "[email protected]"],
+    kerberos_servers=["kdc.my-corporation.com"],
+    global_catalog_servers=["gc.my-corporation.com", "[email protected]"],
+    encryption_types=["aes256-cts-hmac-sha1-96"],
+    service_principal_names=["nfs/vip2.my-array.my-corporation.com"],
+)
+res = client.patch_active_directory(names=["test-config"], active_directory=ad_config)
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Move existing Active Directory account to a different Join OU
+ad_config = ActiveDirectoryPatch(join_ou="OU=FakeOU")
+res = client.patch_active_directory(names=["test-config"], active_directory=ad_config)
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Other valid fields: ids
+# See section "Common Fields" for examples

docs/source/examples/FB2.12/patch_buckets.py

@@ -0,0 +1,97 @@
+from pypureclient.flashblade import Bucket, ObjectLockConfigRequestBody, PublicAccessConfig
+
+# Destroy the bucket named "mybucket", and also suspend versioning
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(destroyed=True, versioning="suspended"))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Recover the bucket "mybucket", and also enable versioning
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(destroyed=False, versioning="enabled"))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Update the quota settings for "mybucket". Enable a hard limit (i.e. enforced)
+# quota of 10G for this bucket.
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(quota_limit=str(10*1024*1024*1024),
+                                         hard_limit_enabled=True))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Reduce the hard limit quota for "mybucket" to 1G while ignoring its current usage (i.e.
+# the operation should not fail due to the bucket's size currently being greater than 1G)
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(quota_limit=str(1*1024*1024*1024)),
+                           ignore_usage=True)
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Clear the quota limit for "mybucket"
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(quota_limit='',))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Enable object lock for "mybucket"
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(object_lock_config=ObjectLockConfigRequestBody(enabled=True)))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Change default retention to 1 day and default retention mode to "compliance" for "mybucket".
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(object_lock_config=ObjectLockConfigRequestBody(
+                               default_retention=86400000,  # 1 day in ms
+                               default_retention_mode="compliance")))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Change retention lock to "ratcheted" to prevent the level of locked objects protection
+# from being decreased and to disable manual eradication of the bucket for "mybucket".
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(retention_lock="ratcheted"))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Freeze locked objects to prevent object overwrite after object lock is enabled for "mybucket".
+res = client.patch_buckets(names=["mybucket2"],
+                           bucket=Bucket(object_lock_config=ObjectLockConfigRequestBody(freeze_locked_objects=True)))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Disable block new public policies for "mybucket".
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(public_access_config=PublicAccessConfig(block_new_public_policies=False)))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Disable block public access for "mybucket".
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(public_access_config=PublicAccessConfig(block_public_access=False)))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Block new public policies and public access for "mybucket".
+res = client.patch_buckets(names=["mybucket"],
+                           bucket=Bucket(public_access_config=PublicAccessConfig(
+                               block_new_public_policies=True,
+                               block_public_access=True)))
+print(res)
+if type(res) == pypureclient.responses.ValidResponse:
+    print(list(res.items))
+
+# Other valid fields: ids
+# See section "Common Fields" for examples