Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.61 KB

BladeApi.md

File metadata and controls

68 lines (49 loc) · 2.61 KB
Raw

purity_fb_1dot12.BladeApi

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

Method HTTP request Description
list_blades GET /1.12/blades

list_blades

BladeResponse list_blades(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token)

List blades.

Example

from purity_fb import PurityFb, Blade, rest

fb = PurityFb('10.255.8.20') # assume the array IP is 10.255.8.20
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 blades
        res = fb.blade.list_blades()
        # list a subset of blades by name
        res = fb.blade.list_blades(names=['CH1.FB1', 'CH1.FB2'])
        # list a subset of blades by id
        res = fb.blade.list_blades(names=['100abf42-0000-4000-8023-000det400090',
                                          '10314f42-020d-7080-8013-000ddt400090'])
        # list all healthy blades
        res = fb.blade.list_blades(filter='status=\'healthy\'')
    except rest.ApiException as e:
        print("Exception when listing blades: %s\n" % e)

Parameters

Name Type Description Notes
filter str The filter to be used for query. [optional]
ids list[str] A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. [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

BladeResponse

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]