Module netapp_ontap.resources.dcn_node_metrics

Copyright © 2026 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

Overview

This API retrieves historical performance metrics for a node.

## Get historical performance metrics for a node
To retrieve historical performance metrics, issue a GET request to /dcn/cluster/nodes/{node.uuid}/metrics. The API will return the metric properties.
```python
from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnNodeMetrics

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(DcnNodeMetrics.get_collection("{node.uuid}")))


[
    DcnNodeMetrics(
        {
            "cpu": {"memory_used": 1024000000, "processor_utilization": 13},
            "timestamp": "2017-01-25T11:20:13+00:00",
            "gpu": {"memory_used": 1024000000, "processor_utilization": 13},
            "status": "ok",
            "duration": "PT15S",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
        }
    )
]

Classes

class DcnNodeMetrics (*args, **kwargs)

CPU and GPU performance metrics for the nodes. It provides detailed insights into the utilization and memory usage of the processors over specified time durations.

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 DcnNodeMetrics 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 DcnNodeMetrics 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 historical performance metrics for a node.

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 historical performance metrics for a node.

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

class DcnNodeMetricsSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

The fields of the DcnNodeMetrics object

Ancestors

  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC
  • abc.ABC

Class variables

cpu: DcnNodeMetricsCpu GET

The cpu field of the dcn_node_metrics.

duration: str GET

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

Valid choices:

  • PT15S
  • PT5M
  • PT30M
  • PT2H
  • P1D
gpu: DcnNodeMetricsGpu GET

The gpu field of the dcn_node_metrics.

status: str GET
  • ok: The sample was collected successfully without any errors.
  • error: An internal uncategorized failure occurred during the sample collection.
  • partial_no_data: The sample collection was incomplete due to missing data.
  • partial_no_uuid: The sample collection was incomplete due to a missing UUID.
  • partial_no_response: The sample collection was incomplete due to no response from one or more nodes.
  • partial_other_error: The sample collection was incomplete due to other unspecified errors.
  • negative_delta: An expected monotonically increasing value has decreased in value.
  • backfilled_data: The sample collection was completed at a later time and backfilled to the previous 15-second timestamp.
  • inconsistent_delta_time: The time between two collections is not the same for all nodes, causing the aggregated value to be over or under-inflated.
  • inconsistent_old_data: One or more nodes do not have the latest data.

Valid choices:

  • ok
  • error
  • partial_no_data
  • partial_no_uuid
  • partial_no_response
  • partial_other_error
  • negative_delta
  • backfilled_data
  • inconsistent_delta_time
  • inconsistent_old_data
timestamp: ImpreciseDateTime GET

The timestamp of the performance data.

Example: 2017-01-25T11:20:13.000+0000

uuid: str GET

Unique identifier for the node.

Example: 1cd8a442-86d1-11e0-ae1c-123478563412