Module netapp_ontap.resources.shelf
Copyright © 2019 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:
# The API:
/api/storage/shelves
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/shelves" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"uid": "3109174803597886800",
"_links": {
"self": {
"href": "/api/storage/shelves/3109174803597886800"
}
}
},
{
"uid": "9237728366621690448",
"_links": {
"self": {
"href": "/api/storage/shelves/9237728366621690448"
}
}
},
{
"uid": "9946762738829886800",
"_links": {
"self": {
"href": "/api/storage/shelves/9946762738829886800"
}
}
},
{
"uid": "10318311901725526608",
"_links": {
"self": {
"href": "/api/storage/shelves/10318311901725526608"
}
}
},
{
"uid": "13477584846688355664",
"_links": {
"self": {
"href": "/api/storage/shelves/13477584846688355664"
}
}
}
],
"num_records": 5,
"_links": {
"self": {
"href": "/api/storage/shelves/"
}
}
}
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.
# The API:
/api/storage/shelves/{uid}
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/shelves/3109174803597886800" -H "accept: application/hal+json"
# The response:
{
"uid": "3109174803597886800",
"name": "6.10",
"id": "10",
"serial_number": "SHU0954292N0HAH",
"model": "DS4246",
"module_type": "iom6",
"internal": false,
"state": "ok",
"connection_type": "sas",
"disk_count": 24,
"paths": [
{
"name": "0e",
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0e"
}
}
},
{
"name": "0g",
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0g"
}
}
}
],
"bays": [
{
"id": 0,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 1,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 2,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 3,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 4,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 5,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 6,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 7,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 8,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 9,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 10,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 11,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 12,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 13,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 14,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 15,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 16,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 17,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 18,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 19,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 20,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 21,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 22,
"has_disk": true,
"type": "single_disk",
"state": "ok"
},
{
"id": 23,
"has_disk": true,
"type": "single_disk",
"state": "ok"
}
],
"frus": [
{
"type": "module",
"id": 0,
"state": "ok",
"part_number": "111-00690+B2",
"serial_number": "8001900099",
"firmware_version": "0191"
},
{
"type": "module",
"id": 1,
"state": "ok",
"part_number": "111-00190+B0",
"serial_number": "7903785183",
"firmware_version": "0191"
},
{
"type": "psu",
"id": 1,
"state": "ok",
"part_number": "0082562-12",
"serial_number": "PMW82562007513E",
"firmware_version": "0311"
},
{
"type": "psu",
"id": 2,
"state": "ok",
"part_number": "0082562-12",
"serial_number": "PMW825620075138",
"firmware_version": "0311"
},
{
"type": "psu",
"id": 3,
"state": "ok",
"part_number": "0082562-12",
"serial_number": "PMW8256200750BA",
"firmware_version": "0311"
},
{
"type": "psu",
"id": 4,
"state": "ok",
"part_number": "0082562-12",
"serial_number": "PMW8256200750A2",
"firmware_version": "0311"
}
],
"ports": [
{
"id": 0,
"module_id": "a",
"designator": "square",
"state": "connected",
"internal": false,
"wwn": "500A098000C9EDBF",
"cable": {
"identifier": "5001086000702488-500a098000c9edbf",
"part_number": "112-00430+A0",
"length": "2m",
"serial_number": "APF16510229807"
},
"remote": {
"wwn": "5001086000702488",
"phy": "08"
}
},
{
"id": 1,
"module_id": "a",
"designator": "circle",
"state": "connected",
"internal": false,
"wwn": "500A098000C9EDBF",
"cable": {
"identifier": "500a098000d5c4bf-500a098000c9edbf",
"part_number": "112-00176+A0",
"length": "0.5-1.0m",
"serial_number": "APF133917610YT"
},
"remote": {
"wwn": "500A098000D5C4BF",
"phy": "00"
}
},
{
"id": 2,
"module_id": "b",
"designator": "square",
"state": "connected",
"internal": false,
"wwn": "500A098004F208BF",
"cable": {
"identifier": "5001086000702648-500a098004f208bf",
"part_number": "112-00430+A0",
"length": "2m",
"serial_number": "APF16510229540"
},
"remote": {
"wwn": "5001086000702648",
"phy": "08"
}
},
{
"id": 3,
"module_id": "b",
"designator": "circle",
"state": "connected",
"internal": false,
"wwn": "500A098004F208BF",
"cable": {
"identifier": "500a0980062ba33f-500a098004f208bf",
"part_number": "112-00176+20",
"length": "0.5-1.0m",
"serial_number": "832210017"
},
"remote": {
"wwn": "500A0980062BA33F",
"phy": "00"
}
}
],
"_links": {
"self": {
"href": "/api/storage/shelves/3109174803597886800"
}
}
}
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 find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves a collection of shelves.
Related ONTAP commands
storage shelf show
storage shelf port show
storage shelf drawer 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 or 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.Raises
NetAppRestError
: If the API call did not return exactly 1 matching resource. def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable
-
Retrieves a collection of shelves.
Related ONTAP commands
storage shelf show
storage shelf port show
storage shelf drawer show
Learn more
Fetch a list of all objects of this type from the host.
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
objectsRaises
NetAppRestError
: If there is no connection available to use either passed in or on the library.
Methods
def get(self, **kwargs) -> NetAppResponse
-
Retrieves a specific shelf.
Related ONTAP commands
storage shelf show
storage shelf port show
storage shelf drawer 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
Inherited members
class ShelfSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the Shelf object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var bays
-
The bays field of the shelf.
var connection_type
-
The connection_type field of the shelf.
Valid choices:
- unknown
- fc
- sas
- nvme
var disk_count
-
The disk_count field of the shelf.
Example: 12
var drawers
-
The drawers field of the shelf.
var frus
-
The frus field of the shelf.
var id
-
The id field of the shelf.
Example: 1
var internal
-
The internal field of the shelf.
var model
-
The model field of the shelf.
Example: DS2246
var module_type
-
The module_type field of the shelf.
Valid choices:
- unknown
- iom6
- iom6e
- iom12
- iom12e
- iom12f
- nsm100
- psm3e
var name
-
The name field of the shelf.
Example: 1.1
var opts
var paths
-
The paths field of the shelf.
var ports
-
The ports field of the shelf.
var serial_number
-
The serial_number field of the shelf.
Example: SHFMS1514000895
var state
-
The state field of the shelf.
Valid choices:
- unknown
- ok
- error
var uid
-
The uid field of the shelf.
Example: 7777841915827391056