Module `netapp_ontap.resources.dcn_node`

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

Overview

You can use these API endpoints to update node configuration, delete node configuration, and retrieve the node status.

Adding a node to a compute cluster

A node can be added to an existing compute cluster by issuing a POST request on /dcn/cluster/nodes. If a compute cluster does not already exist, the API returns a 400 Bad Request error.

Examples

Adding a single node to a cluster

from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnNode

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = DcnNode()
    resource.serial_number = "4048820-60-9"
    resource.post(hydrate=True)
    print(resource)

Try it out

DcnNode({"serial_number": "4048820-60-9"})

Adding multiple nodes to a cluster

Multiple nodes can be added by sending a "records" array containing each node to the API.

from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnNode

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = DcnNode()
    resource.records = [
        {"serial_number": "4048820-60-9", "name": "node1"},
        {"serial_number": "4048820-55-7", "name": "node2"},
    ]
    resource.post(hydrate=True)
    print(resource)

Try it out

DcnNode({})

Discover available compute nodes

Available nodes eligible to join or create a compute cluster can be discovered by issuing a GET request on /dcn/cluster/nodes. If a compute cluster already exists, the query parameter "membership=available" must be used to discover nodes not already in the cluster. If there is no compute cluster, the query parameter is optional. When a compute cluster already exists and the membership query parameter is not sent, the API only returns information about nodes already participating in the cluster.

Examples

Discover available nodes to join

from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnNode

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(DcnNode.get_collection(membership="available")))

Try it out

[
    DcnNode(
        {
            "serial_number": "4048820-32-5",
            "name": "node1",
            "membership": "available",
            "uuid": "f8b16514-cb03-44e0-8efd-9feec9c3fb3e",
        }
    ),
    DcnNode(
        {
            "serial_number": "4048820-47-2",
            "name": "node2",
            "membership": "available",
            "uuid": "f8b16514-cb03-44e0-8efd-9feec9c3fb3f",
        }
    ),
]

Retrieve membership for each node in the cluster

from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnNode

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(DcnNode.get_collection(fields="membership")))

Try it out

[
    DcnNode(
        {
            "name": "dcn-01",
            "membership": "member",
            "_links": {
                "self": {
                    "href": "/api/dcn/cluster/nodes/f8b16514-cb03-44e0-8efd-9feec9c3fb3e"
                }
            },
            "uuid": "f8b16514-cb03-44e0-8efd-9feec9c3fb3e",
        }
    ),
    DcnNode(
        {
            "name": "dcn-02",
            "membership": "member",
            "_links": {
                "self": {
                    "href": "/api/dcn/cluster/nodes/f8b16514-cb03-44e0-8efd-9feec9c3fb3f"
                }
            },
            "uuid": "f8b16514-cb03-44e0-8efd-9feec9c3fb3f",
        }
    ),
]

Delete a node from the cluster

from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnNode

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = DcnNode(uuid="1152414e-2eb2-48b7-a960-4aa2cba312b6")
    resource.delete()

Retrieving statistics and metrics for a node

In this example, the API returns the statistics and metric properties.

from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnNode

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(DcnNode.get_collection(fields="statistics,metric")))

Try it out

[
    DcnNode(
        {
            "name": "example_node_name",
            "metric": {
                "cpu": {"memory_used": 1024000000, "processor_utilization": 3},
                "timestamp": "2019-12-19T15:50:45+00:00",
                "gpu": {"memory_used": 1024000000, "processor_utilization": 3},
                "status": "ok",
                "duration": "PT15S",
            },
            "statistics": {
                "status": "ok",
                "gpu": {
                    "processor_utilization_base": 35042835393,
                    "memory_used": 1024000000,
                    "processor_utilization_raw": 2514992973,
                },
                "cpu": {
                    "processor_utilization_base": 35046206957,
                    "memory_used": 1024000000,
                    "processor_utilization_raw": 2569086312,
                },
                "timestamp": "2019-12-19T15:50:48+00:00",
            },
            "uuid": "6b29327b-21ca-11ea-99aa-005056bb420b",
        }
    )
]

Classes

class DcnNode (*args, **kwargs)

Compute node information.

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 DcnNode 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 delete_collection (*args, records: Iterable[ForwardRef('DcnNode')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Deletes the node. This is effectively a factory reset.

Learn more

DOC /dcn/cluster/nodes

Delete all objects in a collection which match the given query.

All records on the host which match the query will be deleted.

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 delete the collection of bars for a particular foo, the foo.name value should be passed.
records: Can be provided in place of a query. If so, this list of objects will be deleted from the host.
body: The body of the delete request. This could be a Resource instance or a dictionary object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
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. Only resources matching this query will be deleted.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]

Returns a list of RawResources that represent DcnNode 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 data compute nodes.

Learn more

DOC /dcn/cluster/nodes

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 data compute nodes.

Learn more

DOC /dcn/cluster/nodes

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 patch_collection (body: dict, *args, records: Iterable[ForwardRef('DcnNode')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Modifies a compute node.

Required properties

uuid - UUID for the compute node instance

Learn more

DOC /dcn/cluster/nodes

Patch all objects in a collection which match the given query.

All records on the host which match the query will be patched with the provided body.

Args

body: A dictionary of name/value pairs to set on all matching members of the collection. The body argument will be ignored if records is provided.
*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 patch the collection of bars for a particular foo, the foo.name value should be passed.
records: Can be provided in place of a query. If so, this list of objects will be patched on the host.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
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. Only resources matching this query will be patched.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def post_collection (records: Iterable[ForwardRef('DcnNode')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> Union[List[DcnNode], NetAppResponse]

Adds one or more compute nodes to the compute cluster.

Required properties

serial_number

Optional properties

name If a name is not provided it is automatically generated.

Learn more

DOC /dcn/cluster/nodes

Send this collection of objects to the host as a creation request.

Args

records: A list of Resource objects to send to the server to be created.
*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 create a bar for a particular foo, the foo.name value should be passed.
hydrate: If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of each object. When hydrate is set to True, poll must also be set to True.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
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. Only resources matching this query will be patched.

Returns

A list of Resource objects matching the provided type which have been created by the host and returned. This is not the same list that was provided, so to continue using the object, you should save this list. If poll is set to False, then a NetAppResponse object is returned instead.

Raises

NetAppRestError: If the API call returned a status code >= 400

Methods

def delete (self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Deletes the node. This is effectively a factory reset.

Learn more

DOC /dcn/cluster/nodes

Send a deletion request to the host for this object.

Args

body: The body of the delete request. This could be a Resource instance or a dictionary object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
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 NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def get (self, **kwargs) -> NetAppResponse

Retrieves the node configuration and status.

Learn more

DOC /dcn/cluster/nodes

Fetch the details of the object from the host.

Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400 or if not all of the keys required are present and config.STRICT_GET has been set to True.

def patch (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Modifies a compute node.

Required properties

uuid - UUID for the compute node instance

Learn more

DOC /dcn/cluster/nodes

Send the difference in the object's state to the host as a modification request.

Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.

Args

hydrate: If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
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 normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def post (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Adds one or more compute nodes to the compute cluster.

Required properties

serial_number

Optional properties

name If a name is not provided it is automatically generated.

Learn more

DOC /dcn/cluster/nodes

Send this object to the host as a creation request.

Args

hydrate: If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
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 normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

Inherited members

Resource:
- from_dict
- get_collection_url
- get_connection
- instance_location
- path_keys
- poll
- set_connection
- to_dict
- validate_schema

class DcnNodeSchema (*, 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 DcnNode object

Ancestors

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

Class variables

date: ImpreciseDateTime GET

The current or "wall clock" time of the node in ISO-8601 date, time, and time zone format. The ISO-8601 date and time are localized based on the ONTAP cluster's timezone setting.

Example: 2019-04-17T15:49:26.000+0000

error: List[DcnNodeError] GET

DCN node error information.

hardware: DcnHardware GET

Hardware information.

links: SelfLink GET

The links field of the dcn_node.

location: str GET POST PATCH

The location field of the dcn_node.

Example: rack 2 row 5

membership: str GET

Possible values:

available - A node is detected on the network and can be added to the compute cluster. Nodes that have a membership of "available" are not returned when a GET request is called when the cluster exists. Provide a query on the "membership" property for available to scan for nodes on the network. Nodes that have a membership of "available" are returned automatically before a cluster is created.
joining - Joining nodes are in the process of being added to the cluster. The node might be progressing through the steps to become a member or might have failed. The job to add the node or create the cluster provides details on the current progress of the node.
member - Nodes that are members have successfully joined the cluster.

Valid choices:

available
joining
member

metric: DcnNodeMetrics GET

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.

model: str GET

The model field of the dcn_node.

Example: FAS3070

name: str GET POST PATCH

The node's hostname.

Example: node1

network: DcnNodeNetwork GET POST PATCH

The network field of the dcn_node.

owner: str GET POST PATCH

Owner of the node.

Example: Example Corp

serial_number: str GET POST

The serial_number field of the dcn_node.

Example: 4048820-60-9

software: DcnNodeSoftware GET

The software information of the node.

state: str GET

State of the node:

up - Node is up and operational.
down - Node has stopped or is dumping core.
degraded - Node has one or more critical services offline.

Valid choices:

up
down
degraded

statistics: DcnNodeStatistics GET

Detailed CPU and GPU performance metrics for the nodes. It provides raw utilization and memory usage data, enabling precise calculations of processor performance.

system_id: str GET

The system_id field of the dcn_node.

Example: 0537035403

uptime: Size GET

The total time that the node has been up, in seconds.

Example: 300536

uuid: str GET

The uuid field of the dcn_node.

Example: 4ea7a442-86d1-11e0-ae1c-123478563412

vendor_serial_number: str GET

OEM vendor serial number.

Example: 791603000068