Module `netapp_ontap.resources.dcn_cluster_software_package`

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

Overview

You can use this endpoint to retrieve the DCN software package information for a specific UUID from the ONTAP cluster, initiate DCN cluster software upgrade with a previously uploaded package and retrieve the DCN cluster software upgrade status.

Examples

Retrieving cluster software package information

The following example shows how to retrieve information of a specific DCN software package and to monitor the status of DCN cluster software upgrade, using UUID of the package.

from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnClusterSoftwarePackage

with HostConnection(
    "<mgmt-ip>", username="username", password="password", verify=False
):
    resource = DcnClusterSoftwarePackage(uuid="f0ce5ac2-3347-4fa9-9335-ff8f2212bdad")
    resource.get()
    print(resource)

Try it out

DcnClusterSoftwarePackage(
    {
        "version": {
            "minor": 1,
            "major": 18,
            "generation": 9,
            "full": "9.18.1U0 Wed Jan 15 18:20:57 UTC 2026",
            "patch": "U0",
        },
        "staged": False,
        "state": "available",
        "size": 38777467320,
        "compatible": True,
        "create_time": "2025-10-14T16:50:21-04:00",
        "uuid": "f0ce5ac2-3347-4fa9-9335-ff8f2212bdad",
    }
)

The following example shows how to initiate an upgrade of the DCN cluster.

from netapp_ontap import HostConnection
from netapp_ontap.resources import DcnClusterSoftwarePackage

with HostConnection(
    "<mgmt-ip>", username="username", password="password", verify=False
):
    resource = DcnClusterSoftwarePackage(uuid="f0ce5ac2-3347-4fa9-9335-ff8f2212bdad")
    resource.staged = True
    resource.patch()

The API:

/api/dcn/cluster/software/packages/{uuid}

The request

curl -ku username:password -X GET "https:///api/dcn/cluster/software/packages/f0ce5ac2-3347-4fa9-9335-ff8f2212bdad"

The response:

200 - OK { "_links": { "self": { "href": "/api/dcn/cluster/software/packages/f0ce5ac2-3347-4fa9-9335-ff8f2212bdad" } }, "compatible": true, "create_time": "2025-10-14T16:50:21-04:00", "install_status": { "active": true, "duration": "PT90M1S", "message": "Node: sti-s44nl-058 (ec0d65ea-318d-11f0-bd9a-9082c3027ea1), State: running | Node: sti-s44nl-059 (960d6c6c-3183-11f0-815c-9082c3027e8d), State: success | Node: sti-s44nl-060 (35956352-318e-11f0-9084-9082c3027eae), State: success", "start_time": "2025-10-14T17:50:23-04:00" }, "size": 38777467320, "staged": true, "state": "installing", "uuid": "f0ce5ac2-3347-4fa9-9335-ff8f2212bdad", "version": { "full": "9.18.1U0 Wed Jan 15 18:20:57 UTC 2026", "generation": 9, "major": 18, "minor": 1, "patch": "U0" } }

Classes

class DcnClusterSoftwarePackage (*args, **kwargs)

Allows interaction with DcnClusterSoftwarePackage objects on the host

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 DcnClusterSoftwarePackage 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 DcnClusterSoftwarePackage 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 the DCN software packages on the ONTAP cluster.

Learn more

DOC /dcn/cluster/software/packages

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 the DCN software packages on the ONTAP cluster.

Learn more

DOC /dcn/cluster/software/packages

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('DcnClusterSoftwarePackage')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Triggers an update of the DCN cluster with the previously uploaded DCN software. Important note: * Setting 'staged' to true triggers the DCN cluster upgrade.

Learn more

DOC /dcn/cluster/software/packages/{uuid}

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

Methods

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

Retrieves the DCN software package information for a specified package UUID.

Learn more

DOC /dcn/cluster/software/packages/{uuid}

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

Triggers an update of the DCN cluster with the previously uploaded DCN software. Important note: * Setting 'staged' to true triggers the DCN cluster upgrade.

Learn more

DOC /dcn/cluster/software/packages/{uuid}

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

Inherited members

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

class DcnClusterSoftwarePackageSchema (*, 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 DcnClusterSoftwarePackage object

Ancestors

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

Class variables

compatible: bool GET

DCN software compatibility with ONTAP.

Example: true

create_time: ImpreciseDateTime GET

Indicates when this package was placed on the system.

Example: 2025-05-20T19:00:00.000+0000

install_status: DcnClusterSoftwareInstallStatus GET

The install_status field of the dcn_cluster_software_package.

links: ApplicationNvmeAccessSubsystemMapSubsystemHostsLinks GET

The links field of the dcn_cluster_software_package.

size: Size GET

Size of the package in bytes.

Example: 5368709120

staged: bool GET PATCH

True if this software package is currently pending for upgrade. Set to true to start the upgrade.

Example: true

state: str GET

Current status of the package.

Valid choices:

available
validating
valid
invalid
unavailable
installing
installed
install_failed
processing
downloading

uuid: str GET

UUID of this entry.

Example: f0ce5ac2-3347-4fa9-9335-ff8f2212bdad

version: DcnVersion GET

This contains DCN version information.