storage-disk

Contributors

storage-disk-get-iter

GET /api/storage/disks

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

ONTAPI attribute REST attribute Comment

disk-inventory-info

See comment column for details

bytes-per-sector → bytes_per_sector
capacity-sectors → sector_count
carrier-id → NA
carrier-serialno → NA
checksum-compatibility → NA
disk-class → class
disk-cluster-name → name
disk-type → type
disk-effective-type → effective-type
disk-uid → uid
drawer → drawer.id
drawer-slot → drawer.slot
firmware-revision → firmware_version
grown-defect-list-count → NA
health-monitor-time-interval → NA
hw-minimum-os → NA
is-dynamically-qualified → NA
is-foreign → NA
is-multidisk-carrier → NA
is-shared → container_type
location → NA
location-id → NA
media-scrub-count → NA
media-scrub-last-done-time-interval → NA
model → model
reservation-key → NA
reservation-type → NA
right-size-sectors → NA
rpm → rpm
serial-number → serial_number
shelf → NA
comment: shelf available as the "id" attribute under the URL returned by using the GET /api/storage/disks/{uuid}?fields=shelf endpoint
shelf-bay → bay
shelf-uid → shelf.uid
stack-id → NA
storage-sed-info.data-key-id → key_id.data
storage-sed-info.fips-key-id → key_id.fips
storage-sed-info.is-fips-sed → fips_certified
storage-sed-info.is-non-fips-sed → NA
storage-sed-info.is-power-on-lock-enabled → NA
storage-sed-info.is-sed → self_encrypting
storage-sed-info.protection-mode → protection_mode
storage-ssd-info.percent-rated-life-used → rated_life_used_percent
storage-ssd-info.percent-spares-consumed → NA
storage-ssd-info.percent-spares-consumed-limit → NA
vendor → vendor
virtual-machine-disk-info.vmdisk-adapter-device → NA
virtual-machine-disk-info.vmdisk-adapter-driver → NA
virtual-machine-disk-info.vmdisk-adapter-model → NA
virtual-machine-disk-info.vmdisk-adapter-pci → NA
virtual-machine-disk-info.vmdisk-container-name → NA
virtual-machine-disk-info.vmdisk-lun-canonical-name → NA
virtual-machine-disk-info.vmdisk-lun-capacity → NA
virtual-machine-disk-info.vmdisk-lun-model → NA
virtual-machine-disk-info.vmdisk-lun-partition → NA
virtual-machine-disk-info.vmdisk-lun-vendor-name → NA
virtual-machine-disk-info.vmdisk-object-name → NA
virtual-machine-disk-info.vmdisk-storage-account → NA
virtual-machine-disk-info.vmdisk-store-capacity → NA
virtual-machine-disk-info.vmdisk-store-nas-path → NA
virtual-machine-disk-info.vmdisk-store-type → NA
virtual-machine-disk-info.vmdisk-target-iscsi-address → NA
virtual-machine-disk-info.vmdisk-target-iscsi-name → NA
virtual-machine-disk-info.vmdisk-target-lun-id → NA
virtual-machine-disk-info.vmhost-error → NA
vmdisk-backing-info.vmdisk-backing-device-id → NA
vmdisk-backing-info.vmdisk-backing-disk-model → NA
vmdisk-backing-info.vmdisk-backing-serial-number → NA
vmdisk-backing-info.vmdisk-backing-vendor-id → NA
vmdisk-target-address → NA

disk-metrocluster-info

See comment column for details

is-local-attach → local +

disk-name

name

disk-ownership-info

See comment column for details

data-home → NA
data-home-id → NA
data-owner → NA
data-owner-id → NA
data1-home → NA
data1-home-id → NA
data1-owner → NA
data1-owner-id → NA
data2-home → NA
data2-home-id → NA
data2-owner → NA
data2-owner-id → NA
disk-uid → uid
dr-home-node-id → NA
dr-home-node-name → dr_node.name
home-node-id → NA
comment: home-node-id can be accessed via GET on cluster/nodes?fields=nvram.id%#38;name={home-node-id}
home-node-name → home_node.name
is-failed → NA
owner-node-id → system.uuid
owner-node-name → node.name
pool → pool
reserved-by-node-id → NA
root-home → NA
root-home-id → NA
root-owner → NA
root-owner-id → NA

disk-paths

See comment column for details

initiator → paths.initiator
disk-port → paths.port_name
disk-port-name → paths.port_type
comment: Port type is derived from disk-port-name
disk-target-wwnn → paths.wwnn
disk-target-wwpn → paths.wwpn +

disk-raid-info

See comment column for details

active-node-name → node.name
container-type → container_type
disk-aggregate-info.aggregate-name → aggregates.name
disk-aggregate-info.checksum-type → NA
disk-aggregate-info.copy-destination-cluster-name → NA
disk-aggregate-info.copy-destination-name → NA
disk-aggregate-info.copy-percent-complete → NA
disk-aggregate-info.is-media-scrubbing → NA
disk-aggregate-info.is-offline → NA
disk-aggregate-info.is-prefailed → NA
disk-aggregate-info.is-reconstructing → NA
disk-aggregate-info.is-replacing → NA
disk-aggregate-info.is-zeroed → NA
disk-aggregate-info.is-zeroing → NA
disk-aggregate-info.plex-name → NA
disk-aggregate-info.raid-group-name → NA
disk-aggregate-info.reconstruct-percent-complete → NA
disk-aggregate-info.zeroing-percent-complete → NA
disk-outage-info.is-in-fdr → outage.persistently_failed
disk-outage-info.reason → outage.reason
disk-shared-info.aggregate-list → aggregates.name
disk-shared-info.checksum-type → NA
disk-shared-info.copy-destination-cluster-name → NA
disk-shared-info.copy-destination-name → NA
disk-shared-info.copy-percent-complete → NA
disk-shared-info.is-media-scrubbing → NA
disk-shared-info.is-offline → NA
disk-shared-info.is-prefailed → NA
disk-shared-info.is-reconstructing → NA
disk-shared-info.is-replacing → NA
disk-shared-info.is-sparecore → NA
disk-shared-info.is-zeroed → NA
disk-shared-info.is-zeroing → NA
disk-shared-info.partitioning-type → NA
disk-shared-info.reconstruct-percent-complete → NA
disk-shared-info.storage-pool → NA
disk-shared-info.zeroing-percent-complete → NA
disk-spare-info.is-media-scrubbing → NA
disk-spare-info.is-offline → NA
disk-spare-info.is-sparecore → NA
disk-spare-info.is-zeroed → NA
comment: We do not consider this attribute meaningful in ONTAP releases 9.4 and above.
disk-spare-info.is-zeroing → NA
comment: We do not consider this attribute meaningful in ONTAP releases 9.4 and above.
disk-spare-info.zeroing-percent-complete → NA
disk-uid → uid
effective-disk-type → effective_type
effective-rpm → NA
physical-blocks → NA
position → NA
spare-pool → pool
standard-disk-type → NA
used-blocks → usable_size
error-text-list → errors.reason
error-type → errors.type +

disk-stats-info

See comment column for details

average-latency → stats.average_latency
bytes-per-sector → bytes_per_sector
disk-io-kbps → stats.throughput
comment: disk-io-kbps is changed to bytes per second in REST
disk-iops → stats.iops_total
disk-uid → uid
import-in=progress → NA
path-error-count → stats.path_error_count
power-on-time-interval → stats.power_on_hours
comment: power-on-time-interval is in seconds in ONTAPI, but not in REST
sectors-read → NA
sectors-written → NA

disk-uid

uid

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-disk-remove-reservation

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

storage-disk-set-foreign-lun

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

storage-disk-setstate

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