Module netapp_ontap.resources.top_metrics_svm_user
Copyright © 2023 NetApp Inc. All rights reserved.
This file has been automatically generated based on the ONTAP REST API documentation.
Overview
You can use this API to retrieve a list of users with the most IO activity for FlexVol and FlexGroup volumes belonging to a specified SVM. To obtain this list, only the volumes which have the activity tracking feature enabled are considered.
This API is used to provide insight into IO activity and supports ordering by IO activity types, namely iops
and throughput
metrics. Use the top_metric
parameter to specify which type of IO activity to filter for. This API supports returning only one IO activity type per request.
Enabling and disabling activity tracking feature
The following APIs can be used to enable, disable, and retrieve the activity tracking state for a FlexVol or a FlexGroup volume.
- PATCH /api/storage/volumes/{uuid} -d '{"activity_tracking.state":"on"}'
- PATCH /api/storage/volumes/{uuid} -d '{"activity_tracking.state":"off"}'
- GET /api/storage/volumes/{uuid}/?fields=activity_tracking
Excluded volumes list
Optionally, the API returns an excluded list of activity tracking-enabled volumes, which were not accounted for when obtaining the list of clients with the most IO activity for the SVM. This excluded list contains both the volume information and the reason for exclusion.
Failure to return list of users with most IO activity
The API can sometimes fail to return the list of users with the most IO activity, due to the following reasons.
- The volumes belonging to the SVM do not have the activity tracking feature enabled.
- The volumes belonging to the SVM do not have read/write traffic.
- The read traffic is served by the NFS/CIFS client filesystem cache.
- On rare occasions, the incoming traffic pattern is not suitable to obtain the list of users with the most IO activity.
Failure to return the usernames
The API can sometimes fail to obtain the usernames for the list of userid entries, due to internal transient errors.
In such cases, instead of the username, the API will return "{
Retrieve a list of the users with the most IO activity
For a report on the users with the most IO activity returned in descending order, specify the IO activity type you want to filter for by passing the iops
or throughput
property into the top_metric parameter. If the IO activity type is not specified, by default the API returns a list of the users with the greatest number of the average read operations per second. The maximum number of users returned by the API for an IO activity type is 25.
- GET /api/svm/svms/{svm.uuid}/top-metrics/users
Examples
Retrieving a list of the users with the greatest average number of read bytes received per second:
from netapp_ontap import HostConnection
from netapp_ontap.resources import TopMetricsSvmUser
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
print(
list(
TopMetricsSvmUser.get_collection("{svm.uuid}", top_metric="throughput.read")
)
)
[
TopMetricsSvmUser(
{
"user_name": "user1",
"user_id": "S-1-5-21-256008430-3394229847-3930036330-1001",
"svm": {"name": "vs1"},
"iops": {
"write": 1495,
"error": {"upper_bound": 1505, "lower_bound": 1495},
},
"volumes": [
{
"name": "fv1",
"_links": {
"self": {
"href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864"
}
},
"uuid": "73b293df-e9d7-46cc-a9ce-2df8e52ef864",
},
{
"name": "fv2",
"_links": {
"self": {
"href": "/api/storage/volumes/2ea74c3e-d5ca-11eb-8fbb-005056ac0f33"
}
},
"uuid": "2ea74c3e-d5ca-11eb-8fbb-005056ac0f33",
},
{
"name": "fv4",
"_links": {
"self": {
"href": "/api/storage/volumes/5bbfc226-3fd8-42c9-a651-fa6167c2cf84"
}
},
"uuid": "5bbfc226-3fd8-42c9-a651-fa6167c2cf84",
},
],
}
),
TopMetricsSvmUser(
{
"user_name": "user2",
"user_id": "S-1-5-21-256008430-3394229847-3930036330-1002",
"svm": {"name": "vs1"},
"iops": {
"write": 1022,
"error": {"upper_bound": 1032, "lower_bound": 1022},
},
"volumes": [
{
"name": "fv2",
"_links": {
"self": {
"href": "/api/storage/volumes/2ea74c3e-d5ca-11eb-8fbb-005056ac0f33"
}
},
"uuid": "2ea74c3e-d5ca-11eb-8fbb-005056ac0f33",
},
{
"name": "fv3",
"_links": {
"self": {
"href": "/api/storage/volumes/1ca74c3e-d5ca-11eb-8fbb-005056ac0f88"
}
},
"uuid": "1ca74c3e-d5ca-11eb-8fbb-005056ac0f88",
},
],
}
),
TopMetricsSvmUser(
{
"user_name": "user3",
"user_id": "S-1-5-21-256008430-3394229847-3930036330-1003",
"svm": {"name": "vs1"},
"iops": {"write": 345, "error": {"upper_bound": 355, "lower_bound": 345}},
"volumes": [
{
"name": "fv3",
"_links": {
"self": {
"href": "/api/storage/volumes/1ca74c3e-d5ca-11eb-8fbb-005056ac0f88"
}
},
"uuid": "1ca74c3e-d5ca-11eb-8fbb-005056ac0f88",
}
],
}
),
TopMetricsSvmUser(
{
"user_name": "user4",
"user_id": "1988",
"svm": {"name": "vs1"},
"iops": {"write": 235, "error": {"upper_bound": 245, "lower_bound": 235}},
"volumes": [
{
"name": "fv4",
"_links": {
"self": {
"href": "/api/storage/volumes/5bbfc226-3fd8-42c9-a651-fa6167c2cf84"
}
},
"uuid": "5bbfc226-3fd8-42c9-a651-fa6167c2cf84",
}
],
}
),
TopMetricsSvmUser(
{
"user_name": "user5",
"user_id": "S-1-5-21-256008430-3394229847-3930036330-1005",
"svm": {"name": "vs1"},
"iops": {"write": 235, "error": {"upper_bound": 245, "lower_bound": 235}},
"volumes": [
{
"name": "fv5",
"_links": {
"self": {
"href": "/api/storage/volumes/5bbfc227-3fd8-42c9-a651-fa6167c2cf85"
}
},
"uuid": "5bbfc227-3fd8-42c9-a651-fa6167c2cf85",
}
],
}
),
]
Example showing the behavior of the API where there is no read/write traffic:
from netapp_ontap import HostConnection
from netapp_ontap.resources import TopMetricsSvmUser
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
print(
list(
TopMetricsSvmUser.get_collection(
"{svm.uuid}", top_metric="throughput.write"
)
)
)
[]
Classes
class TopMetricsSvmUser (*args, **kwargs)
-
Aggregated information about a user's IO activity at a SVM scope.
Initialize the instance of the resource.
Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:
MyResource(name='foo').name == 'foo'
Args
*args
- Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
- each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.
Ancestors
Static methods
def count_collection (*args, connection: HostConnection = None, **kwargs) -> int
-
Returns a count of all TopMetricsSvmUser resources that match the provided query
This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.
Returns
On success, returns an integer count of the objects of this type. On failure, returns -1.
Raises
NetAppRestError
: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library. def find (*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves a list of users with the most IO activity.
Learn more
Find an instance of an object on the host given a query.
The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
Resource
object containing the details of the object or None if no matches were found.Raises
NetAppRestError
: If the API call returned more than 1 matching resource. def get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]
-
Retrieves a list of users with the most IO activity.
Learn more
Fetch a list of all objects of this type from the host.
This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. max_records
- The maximum number of records to return per call
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A list of
Resource
objectsRaises
NetAppRestError
: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.
Inherited members
class TopMetricsSvmUserSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)
-
The fields of the TopMetricsSvmUser object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
-
iops: TopMetricsSvmUserIops GET POST PATCH
-
The iops field of the top_metrics_svm_user.
-
svm: Svm GET POST PATCH
-
The svm field of the top_metrics_svm_user.
-
throughput: TopMetricsSvmUserThroughput GET POST PATCH
-
The throughput field of the top_metrics_svm_user.
-
user_id: str GET
-
User ID of the user.
Example: S-1-5-21-256008430-3394229847-3930036330-1001
-
user_name: str GET
-
Name of the user.
Example: James
-
volumes: List[Volume] GET POST PATCH
-
List of volumes where the user is generating traffic.