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

storage-shelf

Contributors
Suggest changes
PDFs

storage-shelf-acp-configure

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-firmware-update

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-firmware-update-info-get

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-firmware-update-info-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-get

GET /api/storage/shelves/{uid}?fields=acps,name

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

address

acps.address

channel

acps.channel

connection-status

acps.connection_state

corrective-action

No REST Equivalent

error-id

No REST Equivalent

error-severity

acps.error.severity

error-text

acps.error.reason.message

error-type

acps.error.type

is-enabled

acps.enabled

netmask

acps.netmask

node-name

acps.node.name

port

acps.port

subnet

acps.subnet

node-name

acps.node.name

storage-shelf-acp-module-get

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-module-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-drawer-get

GET /api/storage/shelves/{uid}?fields=drawers,name

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

disk-count

drawers.disk_count

drawer

drawers.id

error

drawers.error

firmware-a

No REST Equivalent

firmware-b

No REST Equivalent

fru-type

No REST Equivalent

is-closed

drawers.closed

is-supported

No REST Equivalent

mfg-date

No REST Equivalent

node

No REST Equivalent

part-number

drawers.part_number

path-a

No REST Equivalent

path-b

No REST Equivalent

serial-number

drawers.serial_number

shelf

name

status-a

drawers.state

ONTAPI Status → REST API State
unknown → error
normal → ok
warning → error
error → error
critical → error

status-b

drawers.state

ONTAPI Status → REST API State
unknown → error
normal → ok
warning → error
error → error
critical → error

vendor-name

No REST Equivalent

storage-shelf-drawer-get-iter

GET /api/storage/shelves?fields=drawers,name

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

disk-count

drawers.disk_count

drawer

drawers.id

error

drawers.error

firmware-a

No REST Equivalent

firmware-b

No REST Equivalent

fru-type

No REST Equivalent

is-closed

drawers.closed

is-supported

No REST Equivalent

mfg-date

No REST Equivalent

node

No REST Equivalent

part-number

drawers.part_number

path-a

No REST Equivalent

path-b

No REST Equivalent

serial-number

drawers.serial_number

shelf

name

status-a

drawers.state

ONTAPI Status → REST API State
unknown → error
normal → ok
warning → error
error → error
critical → error

status-b

drawers.state

ONTAPI Status → REST API State
unknown → error
normal → ok
warning → error
error → error
critical → error

vendor-name

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-drawer-phy-get

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-drawer-phy-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-drawer-slot-get

GET /api/storage/shelves?fields=bays,name

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

bay

bays.id

drawer

bays.drawer.id

is-installed

bays.has_disk

shelf

name

slot

bays.drawer.slot

storage-shelf-drawer-slot-get-iter

GET /api/storage/shelves?fields=bays,name

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

bay

bays.id

drawer

bays.drawer.id

is-installed

bays.has_disk

shelf

name

slot

bays.drawer.slot

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-error-list-info

GET /api/storage/shelves

Note: REST API only returns error-text field of ONTAPI

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

shelf-name

name

storage-shelf-firmware-update

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-firmware-update-info-get

GET /api/cluster/software

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

in-progress-count

nodes.firmware.shelf.in_progress_count

node

nodes.name

update-status

nodes.firmware.shelf.update_status

storage-shelf-firmware-update-info-get-iter

GET /api/cluster/software

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

in-progress-count

nodes.firmware.shelf.in_progress_count

node

nodes.name

update-status

nodes.firmware.shelf.update_status

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-identify

PATCH /api/storage/shelves/{uid}

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-turn-led-on

location_led

ONTAPI is-turn-led-on → REST API location_led
true → on
false → off +

shelf

name

Available for GET in the REST API endpoint. For PATCH, specify the shelf's UID.

storage-shelf-info-get

GET /api/storage/shelves/{uid}

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

boot-devices

No REST Equivalent

coin-battery

No REST Equivalent

connection-type

connection_type

cooling-fans

fans

fan-id → fans.id
fan-location → fans.location
fan-rpm → fans.rpm
fan-op-status → fans.state
comment: fan-op-status is simplified to "ok" and "error" in REST

current-sensors

current_sensors

current-sensor-id → current_sensors.id
current-sensor-location → curent_sensors.location
current-sensor-reading → current_sensors.current
current-op-status → current_sensors.state
comment: current-op-status "normal" is changed to "ok" in REST +

dimms

No REST Equivalent

disk-count

disk_count

fc-ports

No REST Equivalent

is-local-attach

local

module-type

module_type

nsm-ports

No REST Equivalent

op-status

state

ONTAPI op-status → REST API state
unknown → unknown
normal → ok
warning → error
error → error
critical → error
standby-power → error

paths

paths

controller → paths.node.name
controller-uuid → paths.node.uuid
initiator → paths.name
initiator-side-switch-port → NA
initiator-wwpn → NA
iops → NA
io-kbps → NA
port-speed → NA
target-port → NA
target-side-switch-port → NA
tpgn → NA

power-supply-units

frus

power-supply-units have frus.type of "psu"
psu-crest-factor → frus.psu.crest_factor
psu-fw-version → frus.firmware_version
psu-id → frus.id
psu-is-enabled → frus.installed
psu-location → NA
psu-op-status → frus.state
comment: psu-op-status is simplified to "ok" and "error" in REST
psu-part-number → frus.part_number
psu-power-drawn → frus.psu.power_drawn
psu-power-rating → frus.psu.power_rating
psu-reset-capable → NA
psu-serial-number → frus.serial_number
psu-type → frus.psu.model

sas-ports

No REST Equivalent

serial-number

serial_number

shelf

name

shelf-bays

bays

bay-id → bays.id
bay-has-disk → bays.has_disk
bay-op-status → bays.state
comment: bay-op-status "normal" is changed to "ok" in REST
bay-type → bays.type

shelf-errors

errors

error-id → NA
error-type → NA
error-severity → NA
shelf-component → NA
component-location → NA
error-text → errors.reason
corrective-action → NA

shelf-id

id

shelf-model

model

shelf-modules

frus

shelf-modules have frus.type of "module"
es-serial-number → frus.serial_number
is-sas-master-module → NA
is-monitor-active → NA
module-fru-id → NA
module-fw-progress → NA
module-fw-revision → frus.firmware_version
module-id → frus.id
comment: module-id ("A" or "B") is converted to 0 or 1 in REST
module-is-reporting-element → NA
module-latest-fw-revision → NA
module-location → NA
module-op-status → frus.state
comment: module-op-status is simplified to "ok" and "error" in REST
module-part-number → frus.part_number
module-swap-count → NA
module-type → NA

shelf-uid

No REST Equivalent

stack-id

No REST Equivalent

state

No REST Equivalent

temperature-sensors

temperature_sensors

temp-sensor-id → temperature_sensors.id
temp-sensor-location → temperature_sensors.location
temp-sensor-reading → temperature_sensors.temperature
temp-is-ambient → temperature_sensors.ambient
temp-high-critical-threshold → temperature_sensors.threshold.high.critical
temp-high-warning-threshold → temperature_sensors.threshold.high.warning
temp-low-critical-threshold → temperature_sensors.threshold.low.critical
temp-low-warning-threshold → temperature_sensors.threshold.low.warning
temp-op-status → temperature_sensors.state
comment: temp-op-status "normal" is changed to "ok" in REST +

vendor-name

manufacturer.name

voltage-sensors

voltage_sensors

voltage-sensor-id → voltage_sensors.id
voltage-sensor-location → voltage_sensors.location
voltage-sensor-reading → voltage_sensors.voltage
voltage-op-status → voltage_sensors.state
comment: voltage-op-status "normal" is changed to "ok" in REST +

storage-shelf-info-get-iter

GET /api/storage/shelves

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

boot-devices

No REST Equivalent

coin-battery

No REST Equivalent

connection-type

connection_type

cooling-fans

fans

fan-id → fans.id
fan-location → fans.location
fan-rpm → fans.rpm
fan-op-status → fans.state
comment: fan-op-status is simplified to "ok" and "error" in REST

current-sensors

current_sensors

current-sensor-id → current_sensors.id
current-sensor-location → curent_sensors.location
current-sensor-reading → current_sensors.current
current-op-status → current_sensors.state
comment: current-op-status "normal" is changed to "ok" in REST +

dimms

No REST Equivalent

disk-count

disk_count

fc-ports

No REST Equivalent

is-local-attach

local

module-type

module_type

nsm-ports

No REST Equivalent

op-status

state

ONTAPI op-status → REST API state
unknown → unknown
normal → ok
warning → error
error → error
critical → error
standby-power → error

paths

paths

controller → paths.node.name
controller-uuid → paths.node.uuid
initiator → paths.name
initiator-side-switch-port → NA
initiator-wwpn → NA
iops → NA
io-kbps → NA
port-speed → NA
target-port → NA
target-side-switch-port → NA
tpgn → NA

power-supply-units

frus

power-supply-units have frus.type of "psu"
psu-crest-factor → frus.psu.crest_factor
psu-fw-version → frus.firmware_version
psu-id → frus.id
psu-is-enabled → frus.installed
psu-location → NA
psu-op-status → frus.state
comment: psu-op-status is simplified to "ok" and "error" in REST
psu-part-number → frus.part_number
psu-power-drawn → frus.psu.power_drawn
psu-power-rating → frus.psu.power_rating
psu-reset-capable → NA
psu-serial-number → frus.serial_number
psu-type → frus.psu.model

sas-ports

No REST Equivalent

serial-number

serial_number

shelf

name

shelf-bays

bays

bay-id → bays.id
bay-has-disk → bays.has_disk
bay-op-status → bays.state
comment: bay-op-status "normal" is changed to "ok" in REST
bay-type → bays.type

shelf-errors

errors

error-id → NA
error-type → NA
error-severity → NA
shelf-component → NA
component-location → NA
error-text → errors.reason
corrective-action → NA

shelf-id

id

shelf-model

model

shelf-modules

frus

shelf-modules have frus.type of "module"
es-serial-number → frus.serial_number
is-sas-master-module → NA
is-monitor-active → NA
module-fru-id → NA
module-fw-progress → NA
module-fw-revision → frus.firmware_version
module-id → frus.id
comment: module-id ("A" or "B") is converted to 0 or 1 in REST
module-is-reporting-element → NA
module-latest-fw-revision → NA
module-location → NA
module-op-status → frus.state
comment: module-op-status is simplified to "ok" and "error" in REST
module-part-number → frus.part_number
module-swap-count → NA
module-type → NA

shelf-uid

No REST Equivalent

stack-id

No REST Equivalent

state

No REST Equivalent

temperature-sensors

temperature_sensors

temp-sensor-id → temperature_sensors.id
temp-sensor-location → temperature_sensors.location
temp-sensor-reading → temperature_sensors.temperature
temp-is-ambient → temperature_sensors.ambient
temp-high-critical-threshold → temperature_sensors.threshold.high.critical
temp-high-warning-threshold → temperature_sensors.threshold.high.warning
temp-low-critical-threshold → temperature_sensors.threshold.low.critical
temp-low-warning-threshold → temperature_sensors.threshold.low.warning
temp-op-status → temperature_sensors.state
comment: temp-op-status "normal" is changed to "ok" in REST +

vendor-name

manufacturer.name

voltage-sensors

voltage_sensors

voltage-sensor-id → voltage_sensors.id
voltage-sensor-location → voltage_sensors.location
voltage-sensor-reading → voltage_sensors.voltage
voltage-op-status → voltage_sensors.state
comment: voltage-op-status "normal" is changed to "ok" in REST +

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-location-led-get

GET /api/storage/shelves/{uid}?fields=location_led,name,id

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

led-status

location_led

shelf-id

id

shelf-name

name

stack-id

No REST Equivalent

storage-shelf-location-led-get-iter

GET /api/storage/shelves?fields=location_led,name,id

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

led-status

location_led

shelf-id

id

shelf-name

name

stack-id

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-location-led-modify

PATCH /api/storage/shelves/{uid}

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

led-status

location_led

shelf-name

name

Available for GET in the REST API endpoint. For PATCH, specify the shelf's UID.

storage-shelf-location-led-modify-iter

PATCH /api/storage/shelves/{uid}

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

led-status

location_led

shelf-id

id

Available for GET in the REST API endpoint. For PATCH, specify the shelf's UID.

shelf-name

name

Available for GET in the REST API endpoint. For PATCH, specify the shelf's UID.

stack-id

No REST Equivalent

continue-on-failure

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

storage-shelf-port-get-iter

GET /api/storage/shelves?fields=ports,name

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

cable-end

No REST Equivalent

cable-id

ports.cable.identifier

cable-length

ports.cable.length

cable-part-number

ports.cable.part_number

cable-technology

No REST Equivalent

cable-vendor

No REST Equivalent

connector-serial-number

ports.cable.serial_number

connector-state

ports.state

connector-type

No REST Equivalent

designator

ports.designator

ONTAPI designator → REST API designator
cir → circle
sqr → square
(other) → (no change)

id

ports.id

is-cable-connected

No REST Equivalent

is-error

No REST Equivalent

is-internal

ports.internal

location

No REST Equivalent

mac

ports.mac_address

module-id

ports.module_id

remote-chassis

ports.remote.chassis

remote-device

ports.remote.device

remote-mac

ports.remote.mac_address

remote-phy

ports.remote.phy

remote-port

ports.remote.port

remote-wwn

ports.remote.wwn

shelf

name

swap-count

No REST Equivalent

wwn

ports.wwn

max-records

max_records

Specifies the maximum number of records to return before paging.