purity_fb_1dot12.ObjectStoreAccessKeysApi

All URIs are relative to https://purity_fb_server/api

Method HTTP request Description
create_object_store_access_keys POST /1.12/object-store-access-keys
delete_object_store_access_keys DELETE /1.12/object-store-access-keys
list_object_store_access_keys GET /1.12/object-store-access-keys
update_object_store_access_keys PATCH /1.12/object-store-access-keys

create_object_store_access_keys

ObjectStoreAccessKeyResponse create_object_store_access_keys(names=names, object_store_access_key=object_store_access_key)

Create a new object store access key.

Example

from purity_fb import PurityFb, rest, ObjectStoreAccessKeyPost

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # generate access key and secret key for object store user
        # note: you need to handle the secret key since you can't retrieve it from the array after create
        res = fb.object_store_access_keys.create_object_store_access_keys(
            object_store_access_key=ObjectStoreAccessKeyPost(user={'name': 'acc1/myobjuser'}))
        print(res)
        # make another access key for the user with id '100abf42-0000-4000-8023-000det400090'
        res = fb.object_store_access_keys.create_object_store_access_keys(
            object_store_access_key=ObjectStoreAccessKeyPost(user={'id': '100abf42-0000-4000-8023-000det400090'}))
        print(res)
        # import credentials from another FlashBlade
        res = fb.object_store_access_keys.create_object_store_access_keys(
            names=['PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDGLBJLHO'],
            object_store_access_key=ObjectStoreAccessKeyPost(
                user={'name': 'acc1/myobjuser'}, secret_access_key='BAG61F63105e0d3669/e066+5C5DFBE2c127d395LBGG'
            )
        )
        print(res)
    except rest.ApiException as e:
        print("Exception when creating object store access key: %s\n" % e)

Parameters

Name Type Description Notes
names list[str] A comma-separated list of resource names to import. To import a set of credentials, this field must be specified with the `secret_access_key` body parameter. If both of these are not specified, the system will generate a new set of credentials. [optional]
object_store_access_key ObjectStoreAccessKeyPost The attribute map used to create the object store access key. [optional]

Return type

ObjectStoreAccessKeyResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

delete_object_store_access_keys

delete_object_store_access_keys(names=names)

Delete an object store access key.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # delete an access key with name 'PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDGLBJLHO'
        fb.object_store_access_keys.delete_object_store_access_keys(names=["PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDGLBJLHO"])
    except rest.ApiException as e:
        print("Exception when deleting object store access keys: %s\n" % e)

Parameters

Name Type Description Notes
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]

Return type

void (empty response body)

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

list_object_store_access_keys

ObjectStoreAccessKeyResponse list_object_store_access_keys(filter=filter, limit=limit, names=names, sort=sort, start=start, token=token)

List object store access keys.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # list all object store access keys
        res = fb.object_store_access_keys.list_object_store_access_keys()
        # list and sort by created in descendant order
        res = fb.object_store_access_keys.list_object_store_access_keys(limit=5, sort="created-")
        # list with page size 5
        res = fb.object_store_access_keys.list_object_store_access_keys(limit=5)
        # list all remaining object store access keys
        res = fb.object_store_access_keys.list_object_store_access_keys(token=res.pagination_info.continuation_token)
        # list with filter
        res = fb.object_store_access_keys.list_object_store_access_keys(filter='user.name=\'acc1/myobjuser\'')
    except rest.ApiException as e:
        print("Exception when listing object store access keys: %s\n" % e)

Parameters

Name Type Description Notes
filter str The filter to be used for query. [optional]
limit int limit, should be >= 0 [optional]
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]
sort str Sort the response by the specified fields (in descending order if '-' is appended to the field name). [optional]
start int The offset of the first resource to return from a collection. [optional]
token str An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. [optional]

Return type

ObjectStoreAccessKeyResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

update_object_store_access_keys

ObjectStoreAccessKeyResponse update_object_store_access_keys(names=names, object_store_access_key=object_store_access_key)

Update an existing object store access key.

Example

from purity_fb import PurityFb, rest, ObjectStoreAccessKey

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # Disable the object store access key named "PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDEXAMPLE"
        res = fb.object_store_access_keys.update_object_store_access_keys(
            names=['PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDEXAMPLE'], object_store_access_key=ObjectStoreAccessKey(enabled=False))
        print(res)
    except rest.ApiException as e:
        print("Exception when updating object store access key: %s\n" % e)

Parameters

Name Type Description Notes
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]
object_store_access_key ObjectStoreAccessKey The attribute map used to update the object store access key. [optional]

Return type

ObjectStoreAccessKeyResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]