Skip to main content
A newer release of this product is available.

Retrieve a shelf

Contributors
PDFs

GET /storage/shelves/{uid}

Introduced In: 9.6

Retrieves a specific shelf.

  • storage shelf show

  • storage shelf port show

  • storage shelf drawer show

Learn more

Parameters

Name Type In Required Description

uid

string

path

True

Shelf UID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

bays

array[bays]

connection_type

string

disk_count

integer

drawers

array[drawers]

errors

array[errors]

fans

array[fans]

frus

array[frus]

id

string

internal

boolean

local

boolean

model

string

module_type

string

name

string

paths

array[paths]

ports

array[ports]

serial_number

string

state

string

uid

string

vendor

vendor
Example response 
{
  "bays": {
    "id": "0",
    "state": "ok",
    "type": "single_disk"
  },
  "connection_type": "sas",
  "disk_count": "12",
  "drawers": {
    "disk_count": "12",
    "part_number": "111-03071",
    "serial_number": "021604008263",
    "state": "ok"
  },
  "errors": {
  },
  "fans": {
    "id": "1",
    "location": "rear of the shelf on the lower left power supply",
    "rpm": "3020",
    "state": "ok"
  },
  "frus": {
    "firmware_version": "0191",
    "part_number": "111-00690+A2",
    "serial_number": "8000166294",
    "state": "error",
    "type": "module"
  },
  "id": "1",
  "model": "DS2246",
  "module_type": "iom6",
  "name": "1.1",
  "paths": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "2a",
    "node": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  },
  "ports": {
    "cable": {
      "identifier": "500a0980000b6c3f-50000d1703544b80",
      "length": "2m",
      "part_number": "112-00431+A0",
      "serial_number": "616930439"
    },
    "designator": "square",
    "id": "0",
    "module_id": "a",
    "remote": {
      "phy": "12",
      "wwn": "50000D1703544B80"
    },
    "state": "connected",
    "wwn": "500A0980000B6C3F"
  },
  "serial_number": "SHFMS1514000895",
  "state": "ok",
  "uid": "7777841915827391056",
  "vendor": {
    "manufacturer": "XYZ",
    "part_number": "A92831142733",
    "product": "LS2246",
    "serial_number": "891234572210221"
  }
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

bays

Name Type Description

has_disk

boolean

id

integer

state

string

type

string

drawers

Name Type Description

closed

boolean

disk_count

integer

error

string

id

integer

part_number

string

serial_number

string

state

string

reason

Name Type Description

code

string

Error code

message

string

Error message

errors

Name Type Description

reason

reason

fans

Name Type Description

id

integer

location

string

rpm

integer

state

string

frus

Name Type Description

firmware_version

string

id

integer

part_number

string

serial_number

string

state

string

type

string

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

paths

Storage port

Name Type Description

_links

_links

name

string

node

node

cable

Name Type Description

identifier

string

length

string

part_number

string

serial_number

string

remote

Name Type Description

chassis

string

device

string

mac_address

string

phy

string

port

string

wwn

string

ports

Name Type Description

cable

cable

designator

string

id

integer

internal

boolean

mac_address

string

module_id

string

remote

remote

state

string

wwn

string

vendor

Name Type Description

manufacturer

string

Manufacturer name

part_number

string

Part number

product

string

Product name

serial_number

string

Serial number

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.