Skip to main content
ONTAP 9.12.1 ONTAPI-to-REST mapping
A newer release of this product is available.

ses

Contributors
Suggest changes
PDFs

storage-shelf-bay-list-info

GET /api/storage/shelves

Note: The REST API GET method contains some of this information, but not all, and not in the desired format.

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

ONTAPI attribute REST attribute Comment

channel-name

paths.name

node-name

paths.node.name

shelf-id

id

storage-shelf-environment-list-info

GET /api/storage/shelves

Note: The REST API GET method contains some of this information, but not all, and not in the desired format.

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

ONTAPI attribute REST attribute Comment

channel-name

paths.name

node-name

paths.node.name

shelf-id

id

shelves-present

No REST Equivalent

is-channel-monitor-enabled

No REST Equivalent

is-shelf-channel-failure

No REST Equivalent

controller-device-path

No REST Equivalent

controller-device-path-port

No REST Equivalent

shelf-type

module_type

is-shelf-monitor-enabled

No REST Equivalent

shelf-status

state

shelf-status is simplified to "ok" and "error" in REST.

status-reads-attempted

No REST Equivalent

status-reads-failed

No REST Equivalent

control-writes-attempted

No REST Equivalent

control-writes-failed

No REST Equivalent

ses-generic-info

See comment column for details

ses-logical-id → NA
ses-vendor-id → manufacturer.name
ses-contact-state → NA
ses-product-id → model
ses-product-revision → NA
ses-chassis-part-number → NA
ses-midplane-serial-number → NA
ses-midplane-part-number → NA +

attached-shelf-bay-list

bays.id

select bays with bays.has_disk set to true.

attached-shelf-bay-error-list

bays.id

select bays with bays.has_disk set to true and bays.state set to "error".

serial-no

serial_number

power-supply-list

See comment column for details

power-supply-element-no → frus.id
power-supply-is-not-installed → frus.installed
power-supply-is-error → frus.state
comment: power-supply-is-error is simplified to "ok" and "error" in REST
power-supply-serial-no → frus.serial_number
power-supply-part-no → frus.part_number
is-auto-power-reset-enabled → NA
power-supply-type → frus.psu.model
power-supply-firmware-revision → frus.firmware_version
power-supply-swap-count → NA +

voltage-sensor-list

See comment column for details

voltage-sensor-no → voltage_sensors.id
is-sensor-not-installed → NA
is-sensor-error → voltage_sensors.state
comment: is-sensor-error is simplified to "ok" and "error" in REST
sensor-reading → voltage_sensors.voltage
sensor-condition → NA +

current-sensor-list

See comment column for details

current-sensor-no → current_sensors.id
is-sensor-not-installed → NA
is-sensor-error → current_sensors.state
comment: is-sensor-error is simplified to "ok" and "error" in REST
sensor-condition → NA
sensor-reading → current_sensors.current +

cooling-element-list

See comment column for details

cooling-element-number → fans.id
cooling-element-is-not-installed → NA
cooling-element-is-error → fans.state
comment: cooling-element-is-error is simplified to "ok" and "error" in REST
rpm → fans.rpm +

temp-sensor-list

See comment column for details

temp-sensor-element-no → temperature_sensors.id
temp-sensor-is-not-installed → NA
temp-sensor-is-error → temperature_sensors.state
comment: temp-sensor-is-error is simplified to "ok" and "error" in REST
temp-sensor-current-temperature → temperature_sensors.temperature
temp-sensor-is-ambient → temperature_sensors.ambient
temp-sensor-current-condition → NA
temp-sensor-low-warning → temperature_sensors.threshold.low.warning
temp-sensor-low-critical → temperature_sensors.threshold.low.critical
temp-sensor-hi-warning → temperature_sensors.threshold.high.warning
temp-sensor-hi-critical → temperature_sensors.threshold.high.critical +

es-electronics-list

See comment column for details

es-electronics-element-no → frus.id
comment: frus.id is zero-based for modules
es-electronics-is-not-installed → frus.installed
es-electronics-is-error → frus.state
comment: es-electronics-is-error is simplified to "ok" and "error" in REST
es-electronics-is-reporting-element → NA
es-electronics-serial-no → frus.serial_number
es-part-number → frus.part_number
es-revision → NA
es-swap-count → NA +

sas-connector-list

See comment column for details

connector-no → ports.id
comment: ports.id is zero-based
is-cable-connected → ports.state
comment: is-cable-connected is converted to "connected" and "disconnected" in REST
is-connector-error → NA
shelf-module → ports.module_id
connector-designator → ports.designator
swap-count → NA
cable-manufacturer → NA
cable-type → NA
cable-technology → ports.designator
cable-length → ports.cable.length
cable-end-identifier → NA
cable-serial-no → ports.cable.identifier
attached-serial-number → ports.cable.serial_number
cable-part-no → ports.cable.part_number
cable-remote-con-wwn → ports.remote.wwn
cable-local-conn-wwn → ports.wwn +

alternate-control-path-information

See comment column for details

acp-element-no → NA
is-acp-element-not-installed → NA
is-acp-element-error → NA
is-controller-acp-enabled → acps.enabled
is-controller-acp-active → NA
controller-acp-connection-status → NA
controller-acp-ethernet-port → NA
controller-acp-ip-address → NA
controller-acp-domain → NA
controller-acp-netmask → NA
module-mac-address → NA
module-name → NA
module-ip-address → NA
module-reset-count → NA
module-firmware-revision → NA
module-status → NA
module-status-time → NA +

processor-complex-information

No REST Equivalent

enclosure-type

No REST Equivalent

module-list

See comment column for details

module-number → frus.id
is-module-error → frus.state
comment: is-module-error is simplified to "ok" and "error" in REST
is-sas-expander-master-module → NA
module-connector-wwn → NA +

shelf-environ-channel-address

See comment column for details

shelf-environ-channel-address-map.address-map → bays.id
drawer-address-map.drawer-number → bays.drawer.id
drawer-address-map.address-map → bays.drawer.slot +

dcm-list

See comment column for details

dcm-number → NA
is-dcm-installed → NA
is-dcm-error → drawers.state
comment: is-dcm-error is simplified to "ok" and "error" in REST
dcm-serial-number → drawers.serial_number
dcm-part-number → drawers.part_number
dcm-firmware-version → NA
dcm-type → NA
dcm-vendor → NA +

attached-shelf-drawer-bay-list

See comment column for details

shelf-drawer-bay.drawer-number → bays.drawer.id
shelf-drawer-bay.attached-drawer-bay-list → bays.drawer.slot +

attached-shelf-drawer-bay-error-list

No REST Equivalent

storage-shelf-get-shelf-info

GET /api/storage/shelves

Note: The REST API GET method contains some of this information, but not all, and not in the desired format.

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

ONTAPI attribute REST attribute Comment

channel-name

paths.name

node-name

paths.node.name

shelf-id

id

storage-shelf-list-info

GET /api/storage/shelves

Note: The GET method contains some of this information, but not all, and not in the desired format.

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

ONTAPI attribute REST attribute Comment

channel-name

paths.name

node-name

paths.node.name

shelf-id

id

storage-shelf-enclosure-list-info

GET /api/storage/shelves

Note: The GET method contains some of this information, but not all, and not in the desired format.

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

There are no attributes defined for this ONTAPI call.