Module netapp_ontap.resources.shelf

Copyright © 2022 NetApp Inc. All rights reserved.

Retrieving storage shelf information

The storage shelf GET API retrieves all of the shelves in the cluster.


Examples

1) Retrieve a list of shelves from the cluster

The following example shows the response with a list of shelves in the cluster:


from netapp_ontap import HostConnection
from netapp_ontap.resources import Shelf

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

[
    Shelf({"uid": "3109174803597886800"}),
    Shelf({"uid": "9237728366621690448"}),
    Shelf({"uid": "9946762738829886800"}),
    Shelf({"uid": "10318311901725526608"}),
    Shelf({"uid": "13477584846688355664"}),
]


2) Retrieve a specific shelf from the cluster

The following example shows the response of the requested shelf. If there is no shelf with the requested uid, an error is returned.


from netapp_ontap import HostConnection
from netapp_ontap.resources import Shelf

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Shelf(uid=3109174803597886800)
    resource.get()
    print(resource)

Shelf(
    {
        "location_led": "off",
        "local": True,
        "manufacturer": {"name": "NETAPP"},
        "fans": [
            {
                "location": "rear of the shelf on the upper left power supply",
                "rpm": 3150,
                "state": "ok",
                "id": 1,
            },
            {
                "location": "rear of the shelf on the upper left power supply",
                "rpm": 3000,
                "state": "ok",
                "id": 2,
            },
            {
                "location": "rear of the shelf on the upper right power supply",
                "rpm": 3220,
                "state": "ok",
                "id": 3,
            },
            {
                "location": "rear of the shelf on the upper right power supply",
                "rpm": 3000,
                "state": "ok",
                "id": 4,
            },
            {
                "location": "rear of the shelf on the lower left power supply",
                "rpm": 3000,
                "state": "ok",
                "id": 5,
            },
            {
                "location": "rear of the shelf on the lower left power supply",
                "rpm": 3150,
                "state": "ok",
                "id": 6,
            },
            {
                "location": "rear of the shelf on the lower right power supply",
                "rpm": 3150,
                "state": "ok",
                "id": 7,
            },
            {
                "location": "rear of the shelf on the lower right power supply",
                "rpm": 3000,
                "state": "ok",
                "id": 8,
            },
        ],
        "serial_number": "SHU0954292N0HAH",
        "module_type": "iom6",
        "temperature_sensors": [
            {
                "temperature": 20,
                "id": 1,
                "ambient": True,
                "state": "ok",
                "location": "front of the shelf on the left, on the OPS panel",
                "threshold": {
                    "high": {"critical": 42, "warning": 40},
                    "low": {"critical": 0, "warning": 5},
                },
            },
            {
                "temperature": 29,
                "id": 2,
                "ambient": False,
                "state": "ok",
                "location": "inside of the shelf on the midplane",
                "threshold": {
                    "high": {"critical": 55, "warning": 50},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 33,
                "id": 3,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf on the upper left power supply",
                "threshold": {
                    "high": {"critical": 55, "warning": 50},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 41,
                "id": 4,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf on the upper left power supply",
                "threshold": {
                    "high": {"critical": 70, "warning": 65},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 32,
                "id": 5,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf on the upper right power supply",
                "threshold": {
                    "high": {"critical": 55, "warning": 50},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 41,
                "id": 6,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf on the upper right power supply",
                "threshold": {
                    "high": {"critical": 70, "warning": 65},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 34,
                "id": 7,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf on the lower left power supply",
                "threshold": {
                    "high": {"critical": 55, "warning": 50},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 45,
                "id": 8,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf on the lower left power supply",
                "threshold": {
                    "high": {"critical": 70, "warning": 65},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 30,
                "id": 9,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf on the lower right power supply",
                "threshold": {
                    "high": {"critical": 55, "warning": 50},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 40,
                "id": 10,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf on the lower right power supply",
                "threshold": {
                    "high": {"critical": 70, "warning": 65},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 30,
                "id": 11,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf at the top left, on shelf module A",
                "threshold": {
                    "high": {"critical": 60, "warning": 55},
                    "low": {"critical": 5, "warning": 10},
                },
            },
            {
                "temperature": 33,
                "id": 12,
                "ambient": False,
                "state": "ok",
                "location": "rear of the shelf at the top right, on shelf module B",
                "threshold": {
                    "high": {"critical": 60, "warning": 55},
                    "low": {"critical": 5, "warning": 10},
                },
            },
        ],
        "state": "ok",
        "voltage_sensors": [
            {
                "voltage": 5.11,
                "location": "rear of the shelf on the upper left power supply",
                "state": "ok",
                "id": 1,
            },
            {
                "voltage": 12.38,
                "location": "rear of the shelf on the upper left power supply",
                "state": "ok",
                "id": 2,
            },
            {
                "voltage": 5.11,
                "location": "rear of the shelf on the upper right power supply",
                "state": "ok",
                "id": 3,
            },
            {
                "voltage": 12.26,
                "location": "rear of the shelf on the upper right power supply",
                "state": "ok",
                "id": 4,
            },
            {
                "voltage": 5.7,
                "location": "rear of the shelf on the lower left power supply",
                "state": "ok",
                "id": 5,
            },
            {
                "voltage": 12.26,
                "location": "rear of the shelf on the lower left power supply",
                "state": "ok",
                "id": 6,
            },
            {
                "voltage": 5.15,
                "location": "rear of the shelf on the lower right power supply",
                "state": "ok",
                "id": 7,
            },
            {
                "voltage": 12.3,
                "location": "rear of the shelf on the lower right power supply",
                "state": "ok",
                "id": 8,
            },
        ],
        "acps": [
            {
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/cf62d23c-6100-11eb-9852-00a098fd725d"
                        }
                    },
                    "uuid": "cf62d23c-6100-11eb-9852-00a098fd725d",
                    "name": "cat33-01",
                },
                "enabled": True,
                "channel": "in_band",
                "connection_state": "active",
            },
            {
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/d0892dd7-6100-11eb-9cdb-d039ea010238"
                        }
                    },
                    "uuid": "d0892dd7-6100-11eb-9cdb-d039ea010238",
                    "name": "cat33-02",
                },
                "enabled": True,
                "channel": "in_band",
                "connection_state": "active",
            },
        ],
        "disk_count": 24,
        "model": "DS4246",
        "bays": [
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 0},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 1},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 2},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 3},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 4},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 5},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 6},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 7},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 8},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 9},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 10},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 11},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 12},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 13},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 14},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 15},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 16},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 17},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 18},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 19},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 20},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 21},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 22},
            {"type": "single_disk", "state": "ok", "has_disk": True, "id": 23},
        ],
        "current_sensors": [
            {
                "location": "rear of the shelf on the upper left power supply",
                "state": "ok",
                "current": 6990,
                "id": 1,
            },
            {
                "location": "rear of the shelf on the upper left power supply",
                "state": "ok",
                "current": 5150,
                "id": 2,
            },
            {
                "location": "rear of the shelf on the upper right power supply",
                "state": "ok",
                "current": 4600,
                "id": 3,
            },
            {
                "location": "rear of the shelf on the upper right power supply",
                "state": "ok",
                "current": 4800,
                "id": 4,
            },
            {
                "location": "rear of the shelf on the lower left power supply",
                "state": "ok",
                "current": 4140,
                "id": 5,
            },
            {
                "location": "rear of the shelf on the lower left power supply",
                "state": "ok",
                "current": 7770,
                "id": 6,
            },
            {
                "location": "rear of the shelf on the lower right power supply",
                "state": "ok",
                "current": 4140,
                "id": 7,
            },
            {
                "location": "rear of the shelf on the lower right power supply",
                "state": "ok",
                "current": 4720,
                "id": 8,
            },
        ],
        "ports": [
            {
                "cable": {
                    "identifier": "5001086000702488-500a098000c9edbf",
                    "serial_number": "APF16510229807",
                    "length": "2m",
                    "part_number": "112-00430+A0",
                },
                "internal": False,
                "id": 0,
                "wwn": "500A098000C9EDBF",
                "state": "connected",
                "designator": "square",
                "module_id": "a",
                "remote": {"wwn": "5001086000702488", "phy": "08"},
            },
            {
                "cable": {
                    "identifier": "500a098000d5c4bf-500a098000c9edbf",
                    "serial_number": "APF133917610YT",
                    "length": "0.5-1.0m",
                    "part_number": "112-00176+A0",
                },
                "internal": False,
                "id": 1,
                "wwn": "500A098000C9EDBF",
                "state": "connected",
                "designator": "circle",
                "module_id": "a",
                "remote": {"wwn": "500A098000D5C4BF", "phy": "00"},
            },
            {
                "cable": {
                    "identifier": "5001086000702648-500a098004f208bf",
                    "serial_number": "APF16510229540",
                    "length": "2m",
                    "part_number": "112-00430+A0",
                },
                "internal": False,
                "id": 2,
                "wwn": "500A098004F208BF",
                "state": "connected",
                "designator": "square",
                "module_id": "b",
                "remote": {"wwn": "5001086000702648", "phy": "08"},
            },
            {
                "cable": {
                    "identifier": "500a0980062ba33f-500a098004f208bf",
                    "serial_number": "832210017",
                    "length": "0.5-1.0m",
                    "part_number": "112-00176+20",
                },
                "internal": False,
                "id": 3,
                "wwn": "500A098004F208BF",
                "state": "connected",
                "designator": "circle",
                "module_id": "b",
                "remote": {"wwn": "500A0980062BA33F", "phy": "00"},
            },
        ],
        "internal": False,
        "id": "10",
        "paths": [
            {
                "name": "0e",
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
                        }
                    },
                    "uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
                    "name": "node-1",
                },
            },
            {
                "name": "0g",
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
                        }
                    },
                    "uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
                    "name": "node-1",
                },
            },
        ],
        "connection_type": "sas",
        "uid": "3109174803597886800",
        "name": "6.10",
        "frus": [
            {
                "type": "module",
                "part_number": "111-00690+B2",
                "firmware_version": "0191",
                "id": 0,
                "state": "ok",
                "installed": True,
                "serial_number": "8001900099",
            },
            {
                "type": "module",
                "part_number": "111-00190+B0",
                "firmware_version": "0191",
                "id": 1,
                "state": "ok",
                "installed": True,
                "serial_number": "7903785183",
            },
            {
                "type": "psu",
                "part_number": "0082562-12",
                "firmware_version": "0311",
                "id": 1,
                "state": "ok",
                "psu": {"model": "9C"},
                "installed": True,
                "serial_number": "PMW82562007513E",
            },
            {
                "type": "psu",
                "part_number": "0082562-12",
                "firmware_version": "0311",
                "id": 2,
                "state": "ok",
                "psu": {"model": "9C"},
                "installed": True,
                "serial_number": "PMW825620075138",
            },
            {
                "type": "psu",
                "part_number": "0082562-12",
                "firmware_version": "0311",
                "id": 3,
                "state": "ok",
                "psu": {"model": "9C"},
                "installed": True,
                "serial_number": "PMW8256200750BA",
            },
            {
                "type": "psu",
                "part_number": "0082562-12",
                "firmware_version": "0311",
                "id": 4,
                "state": "ok",
                "psu": {"model": "9C"},
                "installed": True,
                "serial_number": "PMW8256200750A2",
            },
        ],
    }
)


Modifying storage shelf

The storage shelf PATCH API modifies the shelf location LED.

Example


from netapp_ontap import HostConnection
from netapp_ontap.resources import Shelf

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Shelf(uid=3109174803597886800)
    resource.location_led = "on"
    resource.patch()


Classes

class Shelf (*args, **kwargs)

Allows interaction with Shelf 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

Static methods

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

Fetch a count of all objects of this type from the host.

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 collection of shelves.

  • storage shelf show
  • storage shelf port show
  • storage shelf drawer show
  • storage shelf acp show

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 collection of shelves.

  • storage shelf show
  • storage shelf port show
  • storage shelf drawer show
  • storage shelf acp show

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

Updates a shelf location LED.

  • storage shelf location-led modify

Learn more


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 a specific shelf.

  • storage shelf show
  • storage shelf port show
  • storage shelf drawer show
  • storage shelf acp show

Learn more


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

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

Updates a shelf location LED.

  • storage shelf location-led modify

Learn more


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

class ShelfSchema (*, 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 Shelf object

Ancestors

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

Class variables

acps GET

Alternate Control Paths to ACP processors/functions in shelf modules and expanders

bays GET

The bays field of the shelf.

connection_type GET

The connection_type field of the shelf.

Valid choices:

  • unknown
  • fc
  • sas
  • nvme
current_sensors GET

The current_sensors field of the shelf.

disk_count GET

The disk_count field of the shelf.

Example: 12

drawers GET

The drawers field of the shelf.

errors GET

The errors field of the shelf.

fans GET

The fans field of the shelf.

frus GET

The frus field of the shelf.

id GET

The id field of the shelf.

Example: 1

internal GET

The internal field of the shelf.

local GET

The local field of the shelf.

location_led GET PATCH

The location_led field of the shelf.

Valid choices:

  • off
  • on
  • unsupported
manufacturer GET

The manufacturer field of the shelf.

model GET

The model field of the shelf.

Example: DS2246

module_type GET

The module_type field of the shelf.

Valid choices:

  • unknown
  • iom6
  • iom6e
  • iom12
  • iom12e
  • iom12f
  • nsm100
  • psm3e
name GET

The name field of the shelf.

Example: 1.1

paths GET

The paths field of the shelf.

ports GET

The ports field of the shelf.

serial_number GET

The serial_number field of the shelf.

Example: SHFMS1514000895

state GET

The state field of the shelf.

Valid choices:

  • unknown
  • ok
  • error
temperature_sensors GET

The temperature_sensors field of the shelf.

uid GET

The uid field of the shelf.

Example: 7777841915827391056

vendor GET

The vendor field of the shelf.

voltage_sensors GET

The voltage_sensors field of the shelf.