# Module `netapp_ontap.resources.top_metrics_client`

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 clients with the most IO activity for a specified volume. Use the `top_metric` parameter to specify which type of IO activity to filter for. This API is used to provide insight into IO activity and supports ordering by IO activity types, namely `iops` and `throughput` metrics. This API supports only returning one IO activity type per request.

## Failure to return list of clients with most IO activity

The API can sometimes fail to return the list of clients with the most IO activity, due to the following reasons:

- The volume does not have the activity tracking feature enabled.
- The volume does 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 clients with the most IO activity.

## Retrieve a list of the clients with the most IO activity

For a report on the clients 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` IO activity type into the top_metric parameter. If the IO activity type is not specified, by default the API returns a list of clients with the greatest number of average read operations per second. The maximum number of clients returned by the API for an IO activity type is 25.

- GET /api/storage/volumes/{volume.uuid}/top-metrics/clients

## Examples

### Retrieving a list of the clients with the greatest average number of write operations per second:

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import TopMetricsClient

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        print(
            list(TopMetricsClient.get_collection("{volume.uuid}", top_metric="iops.write"))
        )

Try it out

    [
        TopMetricsClient(
            {
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                        }
                    },
                    "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
                    "name": "vs1",
                },
                "volume": {"name": "vol1"},
                "client_ip": "172.28.71.128",
                "iops": {
                    "write": 1495,
                    "error": {"upper_bound": 1505, "lower_bound": 1495},
                },
            }
        ),
        TopMetricsClient(
            {
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                        }
                    },
                    "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
                    "name": "vs1",
                },
                "volume": {"name": "vol1"},
                "client_ip": "172.28.71.179",
                "iops": {
                    "write": 1022,
                    "error": {"upper_bound": 1032, "lower_bound": 1022},
                },
            }
        ),
        TopMetricsClient(
            {
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                        }
                    },
                    "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
                    "name": "vs1",
                },
                "volume": {"name": "vol1"},
                "client_ip": "172.28.51.62",
                "iops": {"write": 345, "error": {"upper_bound": 355, "lower_bound": 345}},
            }
        ),
    ]

## Example showing the behavior of the API when there is no read/write traffic:

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import TopMetricsClient

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        print(
            list(
                TopMetricsClient.get_collection(
                    "{volume.uuid}", top_metric="throughput.write"
                )
            )
        )

Try it out

    []

## Classes

`class TopMetricsClient (*args, **kwargs)`

  Information about a client's IO activity.

  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

  - Resource

  ### Static methods

  `def count_collection (*args, connection: HostConnection = None, **kwargs) -> int`

    Returns a count of all TopMetricsClient 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 fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]`

    Returns a list of RawResources that represent TopMetricsClient resources that match the provided query

    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
    `raw`
      return a list of `netapp_ontap.resource.RawResource` objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `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.

  `def find (*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves a list of clients with the most IO activity.

    ### Learn more

    - `DOC /storage/volumes/{volume.uuid}/top-metrics/clients`

    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 clients with the most IO activity.

    ### Learn more

    - `DOC /storage/volumes/{volume.uuid}/top-metrics/clients`

    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
    `raw`
      return a list of `netapp_ontap.resource.RawResource` objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `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

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class TopMetricsClientSchema (*, 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 TopMetricsClient object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `client_ip: str GET`

    IP address of the client. Both IPv4 and IPv6 IP addresses are supported.

    Example: 192.168.185.170

  `iops: TopMetricsClientIops GET POST PATCH`

    The iops field of the top_metrics_client.

  `svm: Svm GET`

    The svm field of the top_metrics_client.

  `throughput: TopMetricsClientThroughput GET POST PATCH`

    The throughput field of the top_metrics_client.

  `volume: Volume GET`

    The volume field of the top_metrics_client.