purity_fb_1dot6.HardwareApi
All URIs are relative to https://purity_fb_server/api
Method | HTTP request | Description |
---|---|---|
list_hardware | GET /1.6/hardware | |
update_hardware | PATCH /1.6/hardware |
list_hardware
HardwareResponse list_hardware(names=names, filter=filter, limit=limit, sort=sort, start=start, token=token)
List hardware components
Example
from purity_fb import PurityFb, Hardware, 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 fans
res = fb.hardware.list_hardware(filter='type=\'fan\'')
# list all XFMs
res = fb.hardware.list_hardware(filter='type=\'xfm\'')
except rest.ApiException as e:
print("Exception when listing hardware: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
names | list[str] | A list of names. | [optional] |
filter | str | The filter to be used for query. | [optional] |
limit | int | limit, should be >= 0 | [optional] |
sort | str | The way to order the results. | [optional] |
start | int | start | [optional] |
token | str | token | [optional] |
Return type
Authorization
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_hardware
HardwareResponse update_hardware(names, hardware)
Update an existing hardware component
Example
from purity_fb import PurityFb, Hardware, 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:
# turn visual identifier on
res = fb.hardware.update_hardware(names=['CH1.FB1'], hardware=Hardware(identify_enabled=True))
# turn visual identifier off
res = fb.hardware.update_hardware(names=['CH1.FB1'], hardware=Hardware(identify_enabled=False))
except rest.ApiException as e:
print("Exception when updating hardware: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
names | list[str] | ||
hardware | Hardware |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to Overview]