purity_fb_1dot9.HardwareConnectorsApi
All URIs are relative to https://purity_fb_server/api
Method | HTTP request | Description |
---|---|---|
list_hardware_connectors | GET /1.9/hardware-connectors | |
update_hardware_connectors | PATCH /1.9/hardware-connectors |
list_hardware_connectors
HardwareConnectorResponse list_hardware_connectors(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token)
List hardware connectors.
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 hardware connectors
res = fb.hardware_connectors.list_hardware_connectors()
# list and sort by name in descendant order
res = fb.hardware_connectors.list_hardware_connectors(limit=5, sort="name-")
# list with page size 5
res = fb.hardware_connectors.list_hardware_connectors(limit=5)
# list all remaining hardware connectors
res = fb.hardware_connectors.list_hardware_connectors(token=res.pagination_info.continuation_token)
# list with filter
res = fb.hardware_connectors.list_hardware_connectors(filter='port_count=4')
except rest.ApiException as e:
print("Exception when listing hardware connectors: %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 | 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_connectors
HardwareConnectorResponse update_hardware_connectors(ids=ids, names=names, hardware_connector=hardware_connector)
Update an existing hardware connector.
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 |
---|---|---|---|
ids | list[str] | A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. | [optional] |
names | list[str] | A comma-separated list of resource names. This cannot be provided together with the ids query parameters. | [optional] |
hardware_connector | HardwareConnector | The attribute map used to update the hardware connector. | [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]