isi_sdk_8_0.StatisticsApi

All URIs are relative to https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080

Method	HTTP request	Description
get_statistics_current	GET /platform/1/statistics/current
get_statistics_history	GET /platform/1/statistics/history
get_statistics_key	GET /platform/1/statistics/keys/{StatisticsKeyId}
get_statistics_keys	GET /platform/1/statistics/keys
get_statistics_operations	GET /platform/3/statistics/operations
get_statistics_protocols	GET /platform/1/statistics/protocols
get_summary_client	GET /platform/3/statistics/summary/client
get_summary_drive	GET /platform/3/statistics/summary/drive
get_summary_heat	GET /platform/3/statistics/summary/heat
get_summary_protocol	GET /platform/3/statistics/summary/protocol
get_summary_protocol_stats	GET /platform/3/statistics/summary/protocol-stats
get_summary_system	GET /platform/3/statistics/summary/system

get_statistics_current

StatisticsCurrent get_statistics_current(timeout=timeout, keys=keys, devid=devid, substr=substr, key=key, degraded=degraded, expand_clientid=expand_clientid)

Retrieve stats.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
timeout = 56 # int | Time in seconds to wait for results from remote nodes. (optional)
keys = ['keys_example'] # list[str] | Multiple key names. May request matching keys or request 'all' keys. Can be comma separated list or can be used more than one time to make queries for multiple keys. May be used in conjunction with 'substr'. Also works with 'key' arguments. (optional)
devid = ['devid_example'] # list[str] | Node devid to query. Either an <integer> or \"all\". Can be used more than one time to query multiple nodes. \"all\" queries all up nodes. 0 means query the local node. For \"cluster\" scoped keys, in any devid including 0 can be used. (optional)
substr = true # bool | Used in conjunction with the 'keys' argument, alters the behavior of keys. Makes the 'keys' arg perform a partial match. Defaults to false. (optional)
key = ['key_example'] # list[str] | One key name. Can be used more than one time to query multiple keys. Also works with 'keys' arguments. (optional)
degraded = true # bool | If true, try to continue even if some stats are unavailable. In this case, errors will be present in the per-key returned data. (optional)
expand_clientid = true # bool | If true, use name resolution to expand client addresses and other IDs. (optional)

try:
    api_response = api_instance.get_statistics_current(timeout=timeout, keys=keys, devid=devid, substr=substr, key=key, degraded=degraded, expand_clientid=expand_clientid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_statistics_current: %s\n" % e)

Parameters

Name	Type	Description	Notes
timeout	int	Time in seconds to wait for results from remote nodes.	[optional]
keys	list[str]	Multiple key names. May request matching keys or request 'all' keys. Can be comma separated list or can be used more than one time to make queries for multiple keys. May be used in conjunction with 'substr'. Also works with 'key' arguments.	[optional]
devid	list[str]	Node devid to query. Either an <integer> or "all". Can be used more than one time to query multiple nodes. "all" queries all up nodes. 0 means query the local node. For "cluster" scoped keys, in any devid including 0 can be used.	[optional]
substr	bool	Used in conjunction with the 'keys' argument, alters the behavior of keys. Makes the 'keys' arg perform a partial match. Defaults to false.	[optional]
key	list[str]	One key name. Can be used more than one time to query multiple keys. Also works with 'keys' arguments.	[optional]
degraded	bool	If true, try to continue even if some stats are unavailable. In this case, errors will be present in the per-key returned data.	[optional]
expand_clientid	bool	If true, use name resolution to expand client addresses and other IDs.	[optional]

Return type

StatisticsCurrent

Authorization

basicAuth

HTTP request headers

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

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

get_statistics_history

StatisticsHistory get_statistics_history(begin=begin, interval=interval, end=end, timeout=timeout, substr=substr, keys=keys, devid=devid, memory_only=memory_only, key=key, degraded=degraded, resolution=resolution, expand_clientid=expand_clientid)

Retrieve stats.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
begin = 56 # int | Earliest time (Unix epoch seconds) of interest. Negative times are interpreted as relative (before) now. (optional)
interval = 56 # int | Minimum sampling interval time in seconds. If native statistics are higher resolution, data will be down-sampled. (optional)
end = 56 # int | Latest time (Unix epoch seconds) of interest. Negative times are interpreted as relative (before) now. If not supplied, use now as the end time. (optional)
timeout = 56 # int | Time in seconds to wait for results from remote nodes. (optional)
substr = true # bool | Used in conjunction with the 'keys' argument, alters the behavior of keys. Makes the 'keys' arg perform a partial match. Defaults to false. (optional)
keys = ['keys_example'] # list[str] | Multiple key names. May request matching keys or request 'all' keys. Can be comma separated list or can be used more than one time to make queries for multiple keys. May be used in conjunction with 'substr'. Also works with 'key' arguments. (optional)
devid = ['devid_example'] # list[str] | Node devid to query. Either an <integer> or \"all\". Can be used more than one time to query multiple nodes. \"all\" queries all up nodes. 0 means query the local node. For \"cluster\" scoped keys, in any devid including 0 can be used. (optional)
memory_only = true # bool | Only use statistics sources that reside in memory (faster, but with less retention). (optional)
key = ['key_example'] # list[str] | One key name. Can be used more than one time to query multiple keys. Also works with 'keys' arguments. (optional)
degraded = true # bool | If true, try to continue even if some stats are unavailable. In this case, errors will be present in the per-key returned data. (optional)
resolution = 56 # int | Synonymous with 'interval', if supplied supersedes interval. (optional)
expand_clientid = true # bool | If true, use name resolution to expand client addresses and other IDs. (optional)

try:
    api_response = api_instance.get_statistics_history(begin=begin, interval=interval, end=end, timeout=timeout, substr=substr, keys=keys, devid=devid, memory_only=memory_only, key=key, degraded=degraded, resolution=resolution, expand_clientid=expand_clientid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_statistics_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
begin	int	Earliest time (Unix epoch seconds) of interest. Negative times are interpreted as relative (before) now.	[optional]
interval	int	Minimum sampling interval time in seconds. If native statistics are higher resolution, data will be down-sampled.	[optional]
end	int	Latest time (Unix epoch seconds) of interest. Negative times are interpreted as relative (before) now. If not supplied, use now as the end time.	[optional]
timeout	int	Time in seconds to wait for results from remote nodes.	[optional]
substr	bool	Used in conjunction with the 'keys' argument, alters the behavior of keys. Makes the 'keys' arg perform a partial match. Defaults to false.	[optional]
keys	list[str]	Multiple key names. May request matching keys or request 'all' keys. Can be comma separated list or can be used more than one time to make queries for multiple keys. May be used in conjunction with 'substr'. Also works with 'key' arguments.	[optional]
devid	list[str]	Node devid to query. Either an <integer> or "all". Can be used more than one time to query multiple nodes. "all" queries all up nodes. 0 means query the local node. For "cluster" scoped keys, in any devid including 0 can be used.	[optional]
memory_only	bool	Only use statistics sources that reside in memory (faster, but with less retention).	[optional]
key	list[str]	One key name. Can be used more than one time to query multiple keys. Also works with 'keys' arguments.	[optional]
degraded	bool	If true, try to continue even if some stats are unavailable. In this case, errors will be present in the per-key returned data.	[optional]
resolution	int	Synonymous with 'interval', if supplied supersedes interval.	[optional]
expand_clientid	bool	If true, use name resolution to expand client addresses and other IDs.	[optional]

Return type

StatisticsHistory

Authorization

basicAuth

HTTP request headers

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

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

get_statistics_key

StatisticsKeys get_statistics_key(statistics_key_id)

List key meta-data.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
statistics_key_id = 'statistics_key_id_example' # str | List key meta-data.

try:
    api_response = api_instance.get_statistics_key(statistics_key_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_statistics_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
statistics_key_id	str	List key meta-data.

Return type

StatisticsKeys

Authorization

basicAuth

HTTP request headers

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

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

get_statistics_keys

StatisticsKeysExtended get_statistics_keys(count=count, limit=limit, queryable=queryable, resume=resume)

List meta-data for matching keys.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
count = true # bool | Only count matching keys, do not return meta-data. (optional)
limit = 56 # int | Return no more than this many results at once (see resume). (optional)
queryable = true # bool | Only list keys that can/cannot be queries. Default is true. (optional)
resume = 'resume_example' # str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). (optional)

try:
    api_response = api_instance.get_statistics_keys(count=count, limit=limit, queryable=queryable, resume=resume)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_statistics_keys: %s\n" % e)

Parameters

Name	Type	Description	Notes
count	bool	Only count matching keys, do not return meta-data.	[optional]
limit	int	Return no more than this many results at once (see resume).	[optional]
queryable	bool	Only list keys that can/cannot be queries. Default is true.	[optional]
resume	str	Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).	[optional]

Return type

StatisticsKeysExtended

Authorization

basicAuth

HTTP request headers

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

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

get_statistics_operations

StatisticsOperations get_statistics_operations(protocols=protocols)

Retrieve operations list.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
protocols = ['protocols_example'] # list[str] | A comma separated list. Only report operations for specified protocol(s). Default is all. (optional)

try:
    api_response = api_instance.get_statistics_operations(protocols=protocols)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_statistics_operations: %s\n" % e)

Parameters

Name	Type	Description	Notes
protocols	list[str]	A comma separated list. Only report operations for specified protocol(s). Default is all.	[optional]

Return type

StatisticsOperations

Authorization

basicAuth

HTTP request headers

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

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

get_statistics_protocols

StatisticsProtocols get_statistics_protocols(type=type)

Retrieve protocol list.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
type = 'type_example' # str | Specifies whether internal, external, or all protocols should be returned. (optional)

try:
    api_response = api_instance.get_statistics_protocols(type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_statistics_protocols: %s\n" % e)

Parameters

Name	Type	Description	Notes
type	str	Specifies whether internal, external, or all protocols should be returned.	[optional]

Return type

StatisticsProtocols

Authorization

basicAuth

HTTP request headers

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

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

get_summary_client

SummaryClient get_summary_client(sort=sort, totalby=totalby, user_names=user_names, remote_addresses=remote_addresses, numeric=numeric, local_names=local_names, user_ids=user_ids, classes=classes, timeout=timeout, local_addresses=local_addresses, degraded=degraded, remote_names=remote_names, nodes=nodes, protocols=protocols)

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
sort = 'sort_example' # str | { drive_id | type | xfers_in | bytes_in | xfer_size_in | xfers_out | bytes_out | xfer_size_out | access_latency | access_slow | iosched_latency | iosched_queue | busy | used_bytes_percent | used_inodes } Sort data by the specified comma-separated field(s). Prepend 'asc:' or 'desc:' to a field to change the sort direction. (optional)
totalby = 'totalby_example' # str | A comma separated list specifying what should be unique. node|protocol|class|local_addr|local_name|remote_addr|remote_name|user_id|user_name|devid (optional)
user_names = 'user_names_example' # str | A comma seperated list. Only report statistics for operations requested by users with resolved names enumerated. (optional)
remote_addresses = 'remote_addresses_example' # str | A comma seperated list. Only report statistics for operations requested by the remote clients with dotted-quad IP addresses enumerated. (optional)
numeric = true # bool | Whether to convert hostnames or usernames to their human readable form. False by default. (optional)
local_names = 'local_names_example' # str | A comma seperated list. Only report statistics for operations handled by the local hosts with resolved names enumerated. (optional)
user_ids = 'user_ids_example' # str | A comma seperated list. Only report statistics for operations requested by users with numeric UIDs enumerated. (optional)
classes = 'classes_example' # str | Specify class(es) for which statistics should be reported. Default is all supported classes. (optional)
timeout = 56 # int | Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument. (optional)
local_addresses = 'local_addresses_example' # str | A comma seperated list. Only report statistics for operations handled by the local hosts with dotted-quad IP addresses enumerated. (optional)
degraded = true # bool | Continue to report if some nodes do not respond. (optional)
remote_names = 'remote_names_example' # str | A comma seperated list. Only report statistics for operations requested by the remote clients with resolved names enumerated. (optional)
nodes = 'nodes_example' # str | A comma seperated list. Specify node(s) for which statistics should be reported. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate local. (optional)
protocols = 'protocols_example' # str | A comma seperated list of the protocol(s) you wish to return. Default is 'all' of the folowing: nfs3|smb1|nlm|ftp|http|siq|iscsi|smb2|nfs4|papi|jobd|irp|lsass_in|lsass_out|hdfs|internal|external (optional)

try:
    api_response = api_instance.get_summary_client(sort=sort, totalby=totalby, user_names=user_names, remote_addresses=remote_addresses, numeric=numeric, local_names=local_names, user_ids=user_ids, classes=classes, timeout=timeout, local_addresses=local_addresses, degraded=degraded, remote_names=remote_names, nodes=nodes, protocols=protocols)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_summary_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
sort	str	{ drive_id	type
totalby	str	A comma separated list specifying what should be unique. node	protocol
user_names	str	A comma seperated list. Only report statistics for operations requested by users with resolved names enumerated.	[optional]
remote_addresses	str	A comma seperated list. Only report statistics for operations requested by the remote clients with dotted-quad IP addresses enumerated.	[optional]
numeric	bool	Whether to convert hostnames or usernames to their human readable form. False by default.	[optional]
local_names	str	A comma seperated list. Only report statistics for operations handled by the local hosts with resolved names enumerated.	[optional]
user_ids	str	A comma seperated list. Only report statistics for operations requested by users with numeric UIDs enumerated.	[optional]
classes	str	Specify class(es) for which statistics should be reported. Default is all supported classes.	[optional]
timeout	int	Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.	[optional]
local_addresses	str	A comma seperated list. Only report statistics for operations handled by the local hosts with dotted-quad IP addresses enumerated.	[optional]
degraded	bool	Continue to report if some nodes do not respond.	[optional]
remote_names	str	A comma seperated list. Only report statistics for operations requested by the remote clients with resolved names enumerated.	[optional]
nodes	str	A comma seperated list. Specify node(s) for which statistics should be reported. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate local.	[optional]
protocols	str	A comma seperated list of the protocol(s) you wish to return. Default is 'all' of the folowing: nfs3	smb1

Return type

SummaryClient

Authorization

basicAuth

HTTP request headers

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

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

get_summary_drive

SummaryDrive get_summary_drive(sort=sort, degraded=degraded, type=type, nodes=nodes, timeout=timeout)

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
sort = 'sort_example' # str | { drive_id | type | xfers_in | bytes_in | xfer_size_in | xfers_out | bytes_out | xfer_size_out | access_latency | access_slow | iosched_latency | iosched_queue | busy | used_bytes_percent | used_inodes } Sort data by the specified comma-separated field(s). Prepend 'asc:' or 'desc:' to a field to change the sort direction. (optional)
degraded = true # bool | Continue to report if some nodes do not respond. (optional)
type = 'type_example' # str | Specify drive type(s) for which statistics should be reported. (optional)
nodes = 'nodes_example' # str | Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node. (optional)
timeout = 56 # int | Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument. (optional)

try:
    api_response = api_instance.get_summary_drive(sort=sort, degraded=degraded, type=type, nodes=nodes, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_summary_drive: %s\n" % e)

Parameters

Name	Type	Description	Notes
sort	str	{ drive_id	type
degraded	bool	Continue to report if some nodes do not respond.	[optional]
type	str	Specify drive type(s) for which statistics should be reported.	[optional]
nodes	str	Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node.	[optional]
timeout	int	Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.	[optional]

Return type

SummaryDrive

Authorization

basicAuth

HTTP request headers

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

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

get_summary_heat

SummaryHeat get_summary_heat(sort=sort, convertlin=convertlin, totalby=totalby, pathdepth=pathdepth, numeric=numeric, events=events, maxpath=maxpath, classes=classes, timeout=timeout, nodes=nodes, degraded=degraded)

File heat map, i.e. rate of file operations, and the type of operation listed by path/lin(s).

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
sort = 'sort_example' # str | { drive_id | type | xfers_in | bytes_in | xfer_size_in | xfers_out | bytes_out | xfer_size_out | access_latency | access_slow | iosched_latency | iosched_queue | busy | used_bytes_percent | used_inodes } Sort data by the specified comma-separated field(s). Prepend 'asc:' or 'desc:' to a field to change the sort direction. (optional)
convertlin = true # bool | Convert lin to hex. Defaults to true. (optional)
totalby = 'totalby_example' # str | Aggregate per specified fields(s). Defaults to none. (optional)
pathdepth = 56 # int | Squash paths to this directory depth. Defaults to none, ie. the paths are not limited (Subject to the system limits.) (optional)
numeric = true # bool | Whether to convert hostnames or usernames to their human readable form. False by default. (optional)
events = 'events_example' # str | Only report specified event types(s). A comma separated list of events. Defaults to all supported events. See [...]/platform/3/statistics/summary/filters/events for a complete list. (optional)
maxpath = 56 # int | Maximum bytes allocated for looking up a path. An ASCII character is 1 byte (It may be more for other types of encoding). The default is 1024 bytes. Zero (0) means unlimited (Subject to the system limits.) (optional)
classes = 'classes_example' # str | Specify class(es) for which statistics should be reported. Default is all supported classes. See [...]/platform/3/statistics/summary/filters/classes for a complete list. (optional)
timeout = 56 # int | Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument. (optional)
nodes = 'nodes_example' # str | Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node. (optional)
degraded = true # bool | Continue to report if some nodes do not respond. (optional)

try:
    api_response = api_instance.get_summary_heat(sort=sort, convertlin=convertlin, totalby=totalby, pathdepth=pathdepth, numeric=numeric, events=events, maxpath=maxpath, classes=classes, timeout=timeout, nodes=nodes, degraded=degraded)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_summary_heat: %s\n" % e)

Parameters

Name	Type	Description	Notes
sort	str	{ drive_id	type
convertlin	bool	Convert lin to hex. Defaults to true.	[optional]
totalby	str	Aggregate per specified fields(s). Defaults to none.	[optional]
pathdepth	int	Squash paths to this directory depth. Defaults to none, ie. the paths are not limited (Subject to the system limits.)	[optional]
numeric	bool	Whether to convert hostnames or usernames to their human readable form. False by default.	[optional]
events	str	Only report specified event types(s). A comma separated list of events. Defaults to all supported events. See [...]/platform/3/statistics/summary/filters/events for a complete list.	[optional]
maxpath	int	Maximum bytes allocated for looking up a path. An ASCII character is 1 byte (It may be more for other types of encoding). The default is 1024 bytes. Zero (0) means unlimited (Subject to the system limits.)	[optional]
classes	str	Specify class(es) for which statistics should be reported. Default is all supported classes. See [...]/platform/3/statistics/summary/filters/classes for a complete list.	[optional]
timeout	int	Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.	[optional]
nodes	str	Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node.	[optional]
degraded	bool	Continue to report if some nodes do not respond.	[optional]

Return type

SummaryHeat

Authorization

basicAuth

HTTP request headers

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

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

get_summary_protocol

SummaryProtocol get_summary_protocol(operations=operations, sort=sort, totalby=totalby, zero=zero, classes=classes, timeout=timeout, degraded=degraded, nodes=nodes, protocols=protocols)

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
operations = 'operations_example' # str | Specify operation(s) for which statistics should be reported. Default is all operations. See isi-statistics man page for complete listing of operations. (optional)
sort = 'sort_example' # str | { drive_id | type | xfers_in | bytes_in | xfer_size_in | xfers_out | bytes_out | xfer_size_out | access_latency | access_slow | iosched_latency | iosched_queue | busy | used_bytes_percent | used_inodes } Sort data by the specified comma-separated field(s). Prepend 'asc:' or 'desc:' to a field to change the sort direction. (optional)
totalby = 'totalby_example' # str | Aggregate per specified fields(s). Defaults to none. (optional)
zero = true # bool | Show table entries with no values. (optional)
classes = 'classes_example' # str | Specify class(es) for which statistics should be reported. Default is all supported classes. See [...]/platform/3/statistics/summary/filters/classes for a complete list. (optional)
timeout = 56 # int | Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument. (optional)
degraded = true # bool | Continue to report if some nodes do not respond. (optional)
nodes = 'nodes_example' # str | Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node. (optional)
protocols = 'protocols_example' # str | Specify protocol(s) for which statistics should be reported. Default is all external protocols. (optional)

try:
    api_response = api_instance.get_summary_protocol(operations=operations, sort=sort, totalby=totalby, zero=zero, classes=classes, timeout=timeout, degraded=degraded, nodes=nodes, protocols=protocols)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_summary_protocol: %s\n" % e)

Parameters

Name	Type	Description	Notes
operations	str	Specify operation(s) for which statistics should be reported. Default is all operations. See isi-statistics man page for complete listing of operations.	[optional]
sort	str	{ drive_id	type
totalby	str	Aggregate per specified fields(s). Defaults to none.	[optional]
zero	bool	Show table entries with no values.	[optional]
classes	str	Specify class(es) for which statistics should be reported. Default is all supported classes. See [...]/platform/3/statistics/summary/filters/classes for a complete list.	[optional]
timeout	int	Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.	[optional]
degraded	bool	Continue to report if some nodes do not respond.	[optional]
nodes	str	Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node.	[optional]
protocols	str	Specify protocol(s) for which statistics should be reported. Default is all external protocols.	[optional]

Return type

SummaryProtocol

Authorization

basicAuth

HTTP request headers

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

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

get_summary_protocol_stats

SummaryProtocolStats get_summary_protocol_stats(degraded=degraded, protocol=protocol, nodes=nodes, timeout=timeout)

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
degraded = true # bool | Continue to report if some nodes do not respond. (optional)
protocol = 'protocol_example' # str | Specify protocol(s) for which statistics should be reported. Default is all external protocols. (optional)
nodes = 'nodes_example' # str | Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node. (optional)
timeout = 56 # int | Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument. (optional)

try:
    api_response = api_instance.get_summary_protocol_stats(degraded=degraded, protocol=protocol, nodes=nodes, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_summary_protocol_stats: %s\n" % e)

Parameters

Name	Type	Description	Notes
degraded	bool	Continue to report if some nodes do not respond.	[optional]
protocol	str	Specify protocol(s) for which statistics should be reported. Default is all external protocols.	[optional]
nodes	str	Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node.	[optional]
timeout	int	Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.	[optional]

Return type

SummaryProtocolStats

Authorization

basicAuth

HTTP request headers

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

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

get_summary_system

SummarySystem get_summary_system(sort=sort, oprates=oprates, degraded=degraded, nodes=nodes, timeout=timeout)

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.StatisticsApi(isi_sdk_8_0.ApiClient(configuration))
sort = 'sort_example' # str | { drive_id | type | xfers_in | bytes_in | xfer_size_in | xfers_out | bytes_out | xfer_size_out | access_latency | access_slow | iosched_latency | iosched_queue | busy | used_bytes_percent | used_inodes } Sort data by the specified comma-separated field(s). Prepend 'asc:' or 'desc:' to a field to change the sort direction. (optional)
oprates = true # bool | Display protocol operation rate statistics rather than the default throughput statistics. (optional)
degraded = true # bool | Continue to report if some nodes do not respond. (optional)
nodes = 'nodes_example' # str | Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node. (optional)
timeout = 56 # int | Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument. (optional)

try:
    api_response = api_instance.get_summary_system(sort=sort, oprates=oprates, degraded=degraded, nodes=nodes, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->get_summary_system: %s\n" % e)

Parameters

Name	Type	Description	Notes
sort	str	{ drive_id	type
oprates	bool	Display protocol operation rate statistics rather than the default throughput statistics.	[optional]
degraded	bool	Continue to report if some nodes do not respond.	[optional]
nodes	str	Specify node(s) for which statistics should be reported. A comma separated set of numbers. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate only the local node.	[optional]
timeout	int	Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.	[optional]

Return type

SummarySystem

Authorization

basicAuth

HTTP request headers

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

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

Files

StatisticsApi.md

Latest commit

History

StatisticsApi.md

File metadata and controls

isi_sdk_8_0.StatisticsApi

get_statistics_current

Example

Parameters

Return type

Authorization

HTTP request headers

get_statistics_history

Example

Parameters

Return type

Authorization

HTTP request headers

get_statistics_key

Example

Parameters

Return type

Authorization

HTTP request headers

get_statistics_keys

Example

Parameters

Return type

Authorization

HTTP request headers

get_statistics_operations

Example

Parameters

Return type

Authorization

HTTP request headers

get_statistics_protocols

Example

Parameters

Return type

Authorization

HTTP request headers

get_summary_client

Example

Parameters

Return type

Authorization

HTTP request headers

get_summary_drive

Example

Parameters

Return type

Authorization

HTTP request headers

get_summary_heat

Example

Parameters

Return type

Authorization

HTTP request headers

get_summary_protocol

Example

Parameters

Return type

Authorization

HTTP request headers

get_summary_protocol_stats

Example

Parameters

Return type

Authorization

HTTP request headers

get_summary_system

Example

Parameters

Return type

Authorization

HTTP request headers