Merge pull request #9 from PureStorage-OpenConnect/fix-fb-examples

Add examples for FlashBlade Client

Author: asun-ps

docs/source/examples/flashblade/delete_active_directory.py

@@ -0,0 +1,8 @@
+# Delete active directory account
+client.delete_active_directory(names=["test-config"])
+
+# Do a local-only delete of an active directory account
+client.delete_active_directory(names=["test-config"], local_only=True)
+
+# Other valid fields: ids
+# See section "Common Fields" for examples

docs/source/examples/flashblade/delete_admins_api_tokens.py

@@ -0,0 +1,5 @@
+# Delete api token for admin1
+client.delete_admins_api_tokens(admin_names=["admin1"])
+
+# Other valid fields: admin_ids
+# See section "Common Fields" for examples

docs/source/examples/flashblade/delete_admins_cache.py

@@ -0,0 +1,8 @@
+# delete an admin cache entry
+client.delete_admins_cache(names=['adminuser'])
+
+# delete all admin cache entries
+client.delete_admins_cache()
+
+# Other valid fields: ids
+# See section "Common Fields" for examples

docs/source/examples/flashblade/delete_alert_watchers.py

@@ -0,0 +1,6 @@
+# delete an alert watcher with a given email address. this address will no longer receive
+# any emails about any alerts, new or updated, from the system
+client.delete_alert_watchers(names=['[email protected]'])
+
+# Other valid fields: ids
+# See section "Common Fields" for examples

docs/source/examples/flashblade/delete_api_clients.py

@@ -0,0 +1,2 @@
+# delete the API client with name 'my_api_client'
+client.delete_api_clients(names=['my_api_client'])

docs/source/examples/flashblade/delete_array_connections.py

@@ -0,0 +1,8 @@
+# delete the array connection with the name 'otherarray'
+client.delete_array_connections(remote_names=['otherarray'])
+
+# delete the array connection with id '10314f42-020d-7080-8013-000ddt400090'
+client.delete_array_connections(remote_ids=['10314f42-020d-7080-8013-000ddt400090'])
+
+# Other valid fields: ids
+# See section "Common Fields" for examples

docs/source/examples/flashblade/delete_bucket_replica_links.py

@@ -0,0 +1,12 @@
+# delete the replica link on the local bucket with the name 'my-connected-array'
+client.delete_bucket_replica_links(local_bucket_names=['localbucket'],
+                                   remote_bucket_names=['remotebucket'],
+                                   remote_names=['my-connected-array'])
+
+# delete the replica link on the local bucket with id '10314f42-020d-7080-8013-000ddt400090'
+client.delete_bucket_replica_links(local_bucket_ids=['10314f42-020d-7080-8013-000ddt400090'],
+                                   remote_bucket_names=['remotebucket'],
+                                   remote_ids=['10314f42-020d-7080-8013-000ddt400012'])
+
+# Other valid fields: ids
+# See section "Common Fields" for examples

docs/source/examples/flashblade/delete_buckets.py

@@ -0,0 +1,5 @@
+# delete the bucket object mybucket on the array
+client.delete_buckets(names=["mybucket"])
+
+# Other valid fields: ids
+# See section "Common Fields" for examples

docs/source/examples/flashblade/delete_certificate_groups.py

@@ -0,0 +1,6 @@
+# delete our group for active directory certificates
+group_for_active_directory_certs = 'all-ad-certs'
+client.delete_certificate_groups(names=[group_for_active_directory_certs])
+
+# Other valid fields: ids
+# See section "Common Fields" for examples

docs/source/examples/flashblade/delete_certificate_groups_certificates.py

@@ -0,0 +1,17 @@
+# remove 'posix-cert' from the 'all-trusted-certs' group
+all_trusted_group = 'all-trusted-certs'
+posix_cert = 'posix-cert'
+client.delete_certificate_groups_certificates(certificate_names=[posix_cert],
+                                              certificate_group_names=[all_trusted_group])
+
+
+# remove both 'ad-cert-2' and 'ad-cert-1' from both the 'all-trusted-certs' group and the
+# 'all-ad-certs' group
+ad_cert1 = 'ad-cert-1'
+ad_cert2 = 'ad-cert-2'
+all_ad_group = 'all-ad-certs'
+client.delete_certificate_groups_certificates(certificate_names=[ad_cert1, ad_cert2],
+                                              certificate_group_names=[all_trusted_group, all_ad_group])
+
+# Other valid fields: certificate_ids, certificate_group_ids
+# See section "Common Fields" for examples