purity_fb_1dot9.ArraysApi
All URIs are relative to https://purity_fb_server/api
Method | HTTP request | Description |
---|---|---|
list_arrays | GET /1.9/arrays | |
list_arrays_http_specific_performance | GET /1.9/arrays/http-specific-performance | |
list_arrays_nfs_specific_performance | GET /1.9/arrays/nfs-specific-performance | |
list_arrays_performance | GET /1.9/arrays/performance | |
list_arrays_performance_replication | GET /1.9/arrays/performance/replication | |
list_arrays_s3_specific_performance | GET /1.9/arrays/s3-specific-performance | |
list_arrays_space | GET /1.9/arrays/space | |
list_clients_performance | GET /1.9/arrays/clients/performance | |
update_arrays | PATCH /1.9/arrays |
list_arrays
ArrayResponse list_arrays()
List arrays
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:
res = fb.arrays.list_arrays()
print(res)
except rest.ApiException as e:
print("Exception when listing arrays: %s\n" % e)
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to Overview]
list_arrays_http_specific_performance
ArrayHttpPerformanceResponse list_arrays_http_specific_performance(start_time=start_time, end_time=end_time, resolution=resolution)
List instant or historical http specific performance
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:
res = fb.arrays.list_arrays_http_specific_performance()
print(res)
# list http specific performance and sort by sample time (latest first)
res = fb.alerts.list_arrays_http_specific_performance(sort='time-')
# list historical http performance
res = fb.alerts.list_arrays_http_specific_performance(
start_time=START_TIME,
end_time=END_TIME,
resolution=30000)
except rest.ApiException as e:
print("Exception when listing http performance: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
start_time | int | Time to start sample in milliseconds since epoch. | [optional] |
end_time | int | Time to end sample in milliseconds since epoch. | [optional] |
resolution | int | sample frequency in milliseconds | [optional] [default to 30000] |
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]
list_arrays_nfs_specific_performance
ArrayNfsPerformanceResponse list_arrays_nfs_specific_performance(start_time=start_time, end_time=end_time, resolution=resolution)
List instant or historical nfs specific performance
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:
res = fb.arrays.list_arrays_nfs_specific_performance()
print(res)
# list nfs specific performance and sort by sample time (latest first)
res = fb.arrays.list_arrays_nfs_specific_performance(sort='time-')
# list historical nfs performance
res = fb.arrays.list_arrays_nfs_specific_performance(
start_time=START_TIME,
end_time=END_TIME,
resolution=30000)
except rest.ApiException as e:
print("Exception when listing nfs performance: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
start_time | int | Time to start sample in milliseconds since epoch. | [optional] |
end_time | int | Time to end sample in milliseconds since epoch. | [optional] |
resolution | int | sample frequency in milliseconds | [optional] [default to 30000] |
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]
list_arrays_performance
ArrayPerformanceResponse list_arrays_performance(start_time=start_time, end_time=end_time, resolution=resolution, protocol=protocol)
List instant or historical array performance
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:
res = fb.arrays.list_arrays_performance()
print(res)
# list array performance for http
res = fb.alerts.list_arrays_performance(protocol='http')
# list array performance for s3
res = fb.alerts.list_arrays_performance(protocol='s3')
# list array performance for nfs
res = fb.alerts.list_arrays_performance(protocol='nfs')
# list historical array performance
res = fb.alerts.list_arrays_performance(
start_time=START_TIME,
end_time=END_TIME,
resolution=30000)
except rest.ApiException as e:
print("Exception when listing array performance: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
start_time | int | Time to start sample in milliseconds since epoch. | [optional] |
end_time | int | Time to end sample in milliseconds since epoch. | [optional] |
resolution | int | sample frequency in milliseconds | [optional] [default to 30000] |
protocol | str | to sample performance of a certain protocol | [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]
list_arrays_performance_replication
ArrayPerformanceReplicationResponse list_arrays_performance_replication(end_time=end_time, resolution=resolution, start_time=start_time, type=type)
List instant or historical array replication performance.
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:
# list instantaneous replication performance for array
res = fb.arrays.list_arrays_performance_replication()
print(res)
# list instantaneous file-replication performance for array
res = fb.arrays.list_arrays_performance_replication(type='file-system')
print(res)
# list historical object-replication performance for array between some
# start time and end time
res = fb.arrays.list_arrays_performance_replication(
start_time=START_TIME,
end_time=END_TIME,
type='object-store',
resolution=30000)
print(res)
except rest.ApiException as e:
print("Exception when listing array replication performance: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
end_time | int | Time to end sample in milliseconds since epoch. | [optional] |
resolution | int | sample frequency in milliseconds | [optional] [default to 30000] |
start_time | int | Time to start sample in milliseconds since epoch. | [optional] |
type | str | to sample space of either file systems, object store, or all | [optional] |
Return type
ArrayPerformanceReplicationResponse
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]
list_arrays_s3_specific_performance
ArrayS3PerformanceResponse list_arrays_s3_specific_performance(start_time=start_time, end_time=end_time, resolution=resolution)
List instant or historical object store specific performance
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:
res = fb.arrays.list_arrays_s3_specific_performance()
print(res)
# list s3 specific performance and sort by sample time (latest first)
res = fb.arrays.list_arrays_s3_specific_performance(sort='time-')
# list historical s3 performance
res = fb.arrays.list_arrays_s3_specific_performance(
start_time=START_TIME,
end_time=END_TIME,
resolution=30000)
except rest.ApiException as e:
print("Exception when listing s3 performance: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
start_time | int | Time to start sample in milliseconds since epoch. | [optional] |
end_time | int | Time to end sample in milliseconds since epoch. | [optional] |
resolution | int | sample frequency in milliseconds | [optional] [default to 30000] |
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]
list_arrays_space
ArraySpaceResponse list_arrays_space(start_time=start_time, end_time=end_time, resolution=resolution, type=type)
List instant or historical array space
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:
res = fb.arrays.list_arrays_space()
print(res)
# list array space and sort by capacity
res = fb.arrays.list_arrays_space(sort='capacity')
print(res)
# list array space of file systems
res = fb.arrays.list_arrays_space(type='file-system')
print(res)
# list historical array space
res = fb.arrays.list_arrays_space(start_time=START_TIME,
end_time=END_TIME,
resolution=30000)
except rest.ApiException as e:
print("Exception when listing array space: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
start_time | int | Time to start sample in milliseconds since epoch. | [optional] |
end_time | int | Time to end sample in milliseconds since epoch. | [optional] |
resolution | int | sample frequency in milliseconds | [optional] [default to 30000] |
type | str | to sample space of either file systems, object store, or all | [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]
list_clients_performance
ClientPerformanceResponse list_clients_performance(names=names, filter=filter, sort=sort, limit=limit)
List client performance
Example
from purity_fb import PurityFb, 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 client performance for all clients
res = fb.arrays.list_clients_performance()
# list client performance for one specific array client
res = fb.arrays.list_clients_performance(names=['123.123.123.123:8080'])
except rest.ApiException as e:
print("Exception when listing client performance: %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] |
filter | str | The filter to be used for query. | [optional] |
sort | str | The way to order the results. | [optional] |
limit | int | limit, should be >= 0 | [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_arrays
ArrayResponse update_arrays(array_settings)
Update arrays
Example
from purity_fb import PurityFb, PureArray, 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:
array_settings = PureArray(name="example-name", ntp_servers=["0.example.ntp.server"],
time_zone="America/Los_Angeles")
res = fb.arrays.update_arrays(array_settings=array_settings)
print(res)
except rest.ApiException as e:
print("Exception when updating arrays: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
array_settings | PureArray |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to Overview]