lun
Suggest changes
PDFs
lun-alignment-get-iter
This ONTAPI call does not have an equivalent REST API call.
lun-alignment-reset-statistics
This ONTAPI call does not have an equivalent REST API call.
lun-bind
POST /api/protocols/san/vvol-bindings
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
protocol-endpoint-path |
protocol_endpoint.name |
|
vvol-path |
vvol.name |
lun-bind-get-iter
GET /api/protocols/san/vvol-bindings
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-optimal |
is_optimal |
|
protocol-endpoint-path |
protocol_endpoint.name |
|
protocol-endpoint-uuid |
protocol_endpoint.uuid |
|
reference-count |
count |
|
secondary-lun |
No REST Equivalent |
|
vserver |
svm |
|
vvol-path |
vvol.name |
|
vvol-uuid |
vvol.uuid |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging.. |
lun-clear-persistent-reservation-info
This ONTAPI call does not have an equivalent REST API call.
lun-cluster-config-get
This ONTAPI call does not have an equivalent REST API call.
lun-copy-cancel
Note: The preferred method for canceling a copy is to delete the destination LUN.
This ONTAPI call does not have an equivalent REST API call.
lun-copy-get-iter
GET /api/storage/luns
Note: Active LUN copy operations are reported in the "copy" properties of LUN GET. "copy.destinations" is populated with LUNs that are the destination of one or more copies of the containing LUN, which is the source. "copy.source" is populated with the LUN that is the source of a copy of the containing LUN, which is the destination.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cutover-time |
No REST Equivalent |
|
destination-path |
copy.destinations.name or name depending on the containing LUN's relationship to the copy operation. |
|
destination-vserver |
svm.name |
|
elapsed-time |
No REST Equivalent |
|
is-destination-ready |
No REST Equivalent |
|
is-promoted-early |
No REST Equivalent |
All LUN copy operations started using the LUN REST API use early promotion. |
is-snapshot-fenced |
copy.destinations.progress.volume_snapshot_blocked or copy.source.progress.volume_snapshot_blocked |
|
job-status |
copy.destinations.progress.state or copy.source.progress.state |
|
job-uuid |
No REST Equivalent |
A particular LUN copy job is identified in REST by its source and destination. |
last-failure-reason |
copy.destinations.progress.failure or copy.source.progress.failure |
|
lun-index |
No REST Equivalent |
A particular LUN copy job is identified in REST by its source and destination. |
max-throughput |
copy.destinations.max_throughput or copy.source.max_throughput |
|
progress-percent |
copy.destinations.progress.percent_complete or copy.source.progress.percent_complete |
|
scanner-progress |
No REST Equivalent |
|
scanner-total |
No REST Equivalent |
|
source-path |
copy.source.name or name depending on the containing LUN's relationship to the copy operation. |
|
source-snapshot-instance-uuid |
No REST Equivalent |
|
source-vserver |
svm.name |
|
max-records |
No REST Equivalent |
lun-copy-modify
PATCH /api/storage/luns/{uuid}
Note: PATCH property "copy.source.max_throughput" of the destination copy destination LUN.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-uuid |
No REST Equivalent |
A particular LUN copy job is identified in REST by its source and destination. |
lun-index |
No REST Equivalent |
A particular LUN copy job is identified in REST by its source and destination. |
max-throughput |
copy.source.max_throughput |
lun-copy-pause
PATCH /api/storage/luns/{uuid}
Note: PATCH property "source.copy.progress.state" of the copy destination LUN to "pause".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-uuid |
No REST Equivalent |
A particular LUN copy job is identified in REST by its source and destination. |
lun-index |
No REST Equivalent |
A particular LUN copy job is identified in REST by its source and destination. |
lun-copy-resume
PATCH /api/storage/luns/{uuid}
Note: PATCH property "source.copy.progress.state" of the copy destination LUN to "replicating".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-uuid |
No REST Equivalent |
A particular LUN copy job is identified in REST by its source and destination. |
lun-index |
No REST Equivalent |
A particular LUN copy job is identified in REST by its source and destination. |
lun-copy-start
POST /api/storage/luns
Note: POST a LUN and specify property "copy.source.uuid" and/or "copy.source.name" to start an asynchronous LUN copy operation.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
destination-vserver |
svm.name |
|
max-throughput |
No REST Equivalent |
|
paths |
name and source.name |
|
promote-early |
No REST Equivalent |
All copy operations started with the REST API use early protmotion. |
reference-path |
No REST Equivalent |
|
serial-number |
No REST Equivalent |
|
source-vserver |
svm.name |
lun-create-by-size
POST /api/storage/luns
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
application |
No REST Equivalent |
|
block-size |
No REST Equivalent |
|
caching-policy |
No REST Equivalent |
|
class |
class |
|
comment |
comment |
|
foreign-disk |
No REST Equivalent |
|
ostype |
os_type |
|
path |
name |
In the REST API, the LUN name is the traditional LUN path from the CLI/ONTAPI. The traditional LUN tuple of (volume, qtree, lun) is now represented by the location property of the LUN REST APIs. |
prefix-size |
No REST Equivalent |
|
qos-adaptive-policy-group |
qos_policy.name |
|
qos-policy-group |
qos_policy.name |
|
size |
space.size |
|
space-allocation-enabled |
space.scsi_thin_provisioning_support_enabled |
|
space-reservation-enabled |
space.guarantee.requested |
|
type |
os_type |
|
use-exact-size |
No REST Equivalent |
lun-create-from-file
PATCH /api/storage/luns/{uuid}
Note: Creating a LUN from a file can be accomplished by creating the LUN, then using
the LUN data write functionality of the REST API to copy the file contents
to the LUN.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
application |
No REST Equivalent |
|
block-size |
No REST Equivalent |
|
caching-policy |
No REST Equivalent |
|
class |
No REST Equivalent |
|
comment |
No REST Equivalent |
|
file-name |
No REST Equivalent |
|
ostype |
No REST Equivalent |
|
path |
No REST Equivalent |
|
preserve-ids |
No REST Equivalent |
|
qos-adaptive-policy-group |
No REST Equivalent |
|
qos-policy-group |
No REST Equivalent |
|
space-allocation-enabled |
No REST Equivalent |
|
space-reservation-enabled |
No REST Equivalent |
lun-debug-get
This ONTAPI call does not have an equivalent REST API call.
lun-destroy
DELETE /api/storage/luns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
destroy-application-lun |
No REST Equivalent |
|
destroy-fenced-lun |
No REST Equivalent |
|
force |
allow_delete_while_mapped |
|
path |
name |
The best practice with the REST API is to delete LUNs by specifying the UUID in the URI. |
lun-generate-serial
This ONTAPI call does not have an equivalent REST API call.
lun-get-attribute
GET /api/storage/luns/{lun.uuid}/attributes/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
name |
No REST Equivalent |
The attribute name is specified as part of the endpoint URI. |
path |
No REST Equivalent |
The LUN is specified using the LUN's UUID as part of the endpoint URI. |
value |
value |
lun-get-attributes
GET /api/storage/luns/{lun.uuid}/attributes
Note: Attributes can also be fetched using GET /api/storage/luns/{lun.uuid}?fields=attributes.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
name |
name |
|
path |
No REST Equivalent |
The LUN is specified using the LUN's UUID as part of the endpoint URI. |
lun-get-comment
GET /api/storage/luns/{uuid}
Note: Use the query: fields=comment
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
name |
lun-get-geometry
This ONTAPI call does not have an equivalent REST API call.
lun-get-inquiry-info
GET /api/protocols/san/igroups
Note: See the target property of the initiator group endpoint.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator-group-name |
name |
lun-get-iter
GET /api/storage/luns
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
alignment |
No REST Equivalent |
|
application |
No REST Equivalent |
|
application-uuid |
No REST Equivalent |
|
backing-snapshot |
No REST Equivalent |
|
block-size |
No REST Equivalent |
|
caching-policy |
No REST Equivalent |
|
class |
class |
|
clone-backing-snapshot |
No REST Equivalent |
|
comment |
comment |
|
creation-timestamp |
create_time |
|
device-binary-id |
No REST Equivalent |
|
device-id |
No REST Equivalent |
|
device-text-id |
No REST Equivalent |
|
is-clone |
No REST Equivalent |
|
is-clone-autodelete-enabled |
auto_delete |
|
is-inconsistent-import |
No REST Equivalent |
|
is-restore-inaccessible |
No REST Equivalent |
|
is-space-alloc-enabled |
space.scsi_thin_provisioning_support_enabled |
|
is-space-reservation-enabled |
space.guarantee.requested |
|
mapped |
status.mapped |
|
multiprotocol-type |
os_type |
|
node |
location.node.name |
|
online |
enabled |
|
path |
name |
|
prefix-size |
No REST Equivalent |
|
qos-adaptive-policy-group |
qos_policy.name |
|
qos-policy-group |
qos_policy.name |
|
qtree |
location.qtree.name |
|
read-only |
status.read_only |
|
serial-7-mode |
No REST Equivalent |
|
serial-number |
serial_number |
|
share-state |
No REST Equivalent |
|
size |
space.size |
|
size-used |
space.used |
|
staging |
No REST Equivalent |
|
state |
status.state |
|
suffix-size |
No REST Equivalent |
|
uuid |
uuid |
|
volume |
location.volume.name |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
lun-get-maxsize
This ONTAPI call does not have an equivalent REST API call.
lun-get-minsize
This ONTAPI call does not have an equivalent REST API call.
lun-get-occupied-size
This ONTAPI call does not have an equivalent REST API call.
lun-get-persistent-reservation-info
This ONTAPI call does not have an equivalent REST API call.
lun-get-select-attribute
This ONTAPI call does not have an equivalent REST API call.
lun-get-serial-number
GET /api/storage/luns/{uuid}
Note: Use the query: fields=serial_number
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
name |
lun-get-space-reservation-info
This ONTAPI call does not have an equivalent REST API call.
lun-get-vdisk-attributes
GET /api/storage/luns
Note: Use the query: serial_number={value}. Note that both the
ONTAPI and REST API equivalent are not optimized and might
check every LUN in the system, which will be slow with a
large number of LUNs.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
serial-number |
serial_number |
lun-group-internal-rebuild
This ONTAPI call does not have an equivalent REST API call.
lun-has-scsi-reservations
This ONTAPI call does not have an equivalent REST API call.
lun-import-create
This ONTAPI call does not have an equivalent REST API call.
lun-import-delete
This ONTAPI call does not have an equivalent REST API call.
lun-import-get-iter
This ONTAPI call does not have an equivalent REST API call.
lun-import-pause
This ONTAPI call does not have an equivalent REST API call.
lun-import-resume
This ONTAPI call does not have an equivalent REST API call.
lun-import-start
This ONTAPI call does not have an equivalent REST API call.
lun-import-stop
This ONTAPI call does not have an equivalent REST API call.
lun-import-throttle
This ONTAPI call does not have an equivalent REST API call.
lun-import-verify-start
This ONTAPI call does not have an equivalent REST API call.
lun-import-verify-stop
This ONTAPI call does not have an equivalent REST API call.
lun-initiator-list-map-info
GET /api/protocols/san/igroups
Note: The contents of this ONTAPI are split across the initiator group (igroup), LUN, and LUN map REST API endpoints. The igroups endpoint efficiently finds the igroups that
contain the specified initiator by using the query ?initiators.name={initiator}. The "lun_maps" property of the igroup API returns the mapped LUNs.
From there, you can query the LUNs or LUN maps APIs with the LUN UUIDs of the mapped LUNs to return the remaining details that are provided by this ONTAPI.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator |
initiators.name |
lun-initiator-logged-in
GET /api/network/fc/logins
Note: Another valid endpoint is: /api/protocols/san/iscsi/sessions.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator |
initiator.wwpn |
initiator.name is valid for both possible endpoints. |
lun-lun-rescan
This ONTAPI call does not have an equivalent REST API call.
lun-map
POST /api/protocols/san/lun-maps
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
additional-reporting-node |
additional_reporting_node |
Specify the cluster node name and/or UUID in additional_reporting_node.name and/or additional_reporting_node.uuid. |
force |
No REST Equivalent |
|
initiator-group |
igroup.name |
|
lun-id |
logical_unit_number |
|
path |
lun.name |
lun-map-add-reporting-nodes
POST /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
all |
No REST Equivalent |
This is not supported in the REST API. It was added to ZAPI to address upgrade/revert issues when the Selective LUN Map (SLM) feature was added to ONTAP and is now obsolete. |
destination-aggregate |
No REST Equivalent |
This is not supported directly in the REST API, but a caller can determine the cluster node of a LUN move destination aggregate and use POST /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes to acheive the same result. |
destination-volume |
No REST Equivalent |
This is not supported directly in the REST API, but a caller can determine the cluster node of a LUN move destination volume and use POST /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes to acheive the same result. |
igroup |
No REST Equivalent |
The initiator group (igroup) is specified using the igroup UUID in the resource URI. |
nodes |
No REST Equivalent |
Specify the uuid and/or name property in the POST body. |
path |
No REST Equivalent |
The LUN is specified using the LUN UUID in the resource URI. |
lun-map-get-iter
GET /api/protocols/san/lun-maps
Note: LUN maps are also available through the GET /api/storage/luns and
GET /api/protocols/san/igroups endpoints.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator-group |
igroup.name |
|
initiator-group-uuid |
igroup.uuid |
|
lun-id |
logical_unit_number |
|
lun-uuid |
lun.uuid |
|
node |
lun.node.name |
|
path |
lun.name |
|
reporting-nodes |
reporting_nodes |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
lun-map-list-info
GET /api/storage/luns/{uuid}
Note: Use the query: fields=lun_maps. Note that the initiators are not
included in this API, but you can retrieve them from the /api/protocols/san/igroups REST API endpoint.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
name |
lun-map-remove-reporting-nodes
DELETE /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
igroup |
No REST Equivalent |
The initiator group (igroup) is specified using the igroup UUID in the resource URI. |
nodes |
No REST Equivalent |
The cluster node is specified using the node UUID in the resource URI. |
path |
No REST Equivalent |
The LUN is specified using the LUN UUID in the resource URI. |
lun-move
PATCH /api/storage/luns/{uuid}
Note: A PATCH that modifies the qtree and/or base name portion of the
LUN name is considered a rename operation.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
new-path |
name |
|
path |
name |
lun-move-cancel
This ONTAPI call does not have an equivalent REST API call.
lun-move-get-iter
GET /api/storage/luns
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cutover-time |
No REST Equivalent |
|
destination-path |
movement.paths.destination |
|
elapsed-time |
movement.progress.elapsed |
|
is-destination-ready |
No REST Equivalent |
|
is-promoted-late |
No REST Equivalent |
Always false if started from the REST API. |
is-snapshot-fenced |
movement.progress.volume_snapshot_blocked |
|
job-status |
movement.progress.state |
|
job-uuid |
No REST Equivalent |
A particular LUN move job is identified in REST by the LUN's unique identifier. |
last-failure-reason |
movement.progress.failure.message |
|
lun-index |
No REST Equivalent |
A particular LUN move job is identified in REST by the LUN's unique identifier. |
max-throughput |
movement.max_throughput |
|
progress-percent |
movement.progress.percent_complete |
|
scanner-progress |
No REST Equivalent |
|
scanner-total |
No REST Equivalent |
|
source-path |
movement.paths.source |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
lun-move-modify
PATCH /api/storage/luns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-uuid |
No REST Equivalent |
A particular LUN move job is identified in REST by the LUN's unique identifier. |
lun-index |
No REST Equivalent |
A particular LUN move job is identified in REST by the LUN's unique identifier. |
max-throughput |
movement.max_throughput |
lun-move-pause
PATCH /api/storage/luns/{uuid}
Note: PATCH the "movement.progress.state" property of a moving LUN to "paused".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-uuid |
No REST Equivalent |
A particular LUN move job is identified in REST by the LUN's unique identifier. |
lun-index |
No REST Equivalent |
A particular LUN move job is identified in REST by the LUN's unique identifier. |
lun-move-resume
PATCH /api/storage/luns/{uuid}
Note: PATCH the "movement.progress.state" property of a moving LUN to "replicating".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-uuid |
No REST Equivalent |
A particular LUN move job is identified in REST by the LUN's unique identifier. |
lun-index |
No REST Equivalent |
A particular LUN move job is identified in REST by the LUN's unique identifier. |
lun-move-start
PATCH /api/storage/luns/{uuid}
Note: In the REST API, changing the volume of a LUN by using the "name",
"location.volume.name", or "location.volume.uuid" property
starts a LUN move to the specified volume.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
max-throughput |
movement.max_throughput |
|
paths |
No REST Equivalent |
The REST API is limited to moving one LUN at a time. |
promote-late |
No REST Equivalent |
In the REST API, LUN moves are always promoted late. |
reference-path |
No REST Equivalent |
lun-offline
PATCH /api/storage/luns/{uuid}
Note: PATCH the "enabled" property to "false".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
name |
lun-online
PATCH /api/storage/luns/{uuid}
Note: PATCH the "enabled" property to "true".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
force |
No REST Equivalent |
|
path |
name |
lun-os-type-list
This ONTAPI call does not have an equivalent REST API call.
lun-port-has-scsi-reservations
This ONTAPI call does not have an equivalent REST API call.
lun-prepare-to-downgrade
This ONTAPI call does not have an equivalent REST API call.
lun-resize
PATCH /api/storage/luns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
force |
No REST Equivalent |
Always false in the REST API. |
path |
name |
|
size |
space.size |
lun-set-attribute
PATCH /api/storage/luns/{lun.uuid}/attributes/{name}
Note: Attributes can be set while creating a LUN using POST /api/storage/luns.
Additional attributes can be added to an existing LUN using POST /api/storage/luns/{lun.uuid}/attributes.
The values for existing attributes can be modified using PATCH /api/storage/luns/{lun.uuid}/attributes/{name}.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
name |
No REST Equivalent |
The attribute name is specified as part of the endpoint URI. |
path |
No REST Equivalent |
The LUN is specified using the LUN's UUID as part of the endpoint URI. |
value |
value |
lun-set-comment
PATCH /api/storage/luns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
|
path |
name |
lun-set-device-id
This ONTAPI call does not have an equivalent REST API call.
lun-set-qos-policy-group
PATCH /api/storage/luns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
name |
|
qos-adaptive-policy-group |
qos_policy.name |
|
qos-policy-group |
qos_policy.name |
lun-set-select-attribute
This ONTAPI call does not have an equivalent REST API call.
lun-set-serial-number
Note: The REST API does not support user provided LUN serial numbers. This ONTAPI is only supported for backward compatibility and should not be used.
This ONTAPI call does not have an equivalent REST API call.
lun-set-space-alloc
PATCH /api/storage/luns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
enable |
space.scsi_thin_provisioning_support_enabled |
|
path |
name |
lun-set-space-reservation-info
PATCH /api/storage/luns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
enable |
space.guarantee.requested |
|
path |
name |
lun-stats-get-iter
GET /api/storage/luns/{uuid}
Note: While not a one-to-one replacement, the "metric" and "statistics" properties of the LUN REST API
are intended to replace the functionality of this ONTAPI. Note that while the property names are similar,
the REST API implementation is more advanced and might return slightly different values than the corresponding ONTAPI property.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
block-size |
No REST Equivalent |
|
last-zeroed |
No REST Equivalent |
|
other-ops |
No REST Equivalent |
|
path |
name |
|
read-blocks |
No REST Equivalent |
|
read-ops |
No REST Equivalent |
|
scsi-errors |
No REST Equivalent |
|
vserver |
svm.name |
|
write-blocks |
No REST Equivalent |
|
write-ops |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
lun-test-vdisk-size
This ONTAPI call does not have an equivalent REST API call.
lun-testmap
This ONTAPI call does not have an equivalent REST API call.
lun-transition-7mode-destroy
This ONTAPI call does not have an equivalent REST API call.
lun-transition-7mode-get-iter
This ONTAPI call does not have an equivalent REST API call.
lun-transition-start
This ONTAPI call does not have an equivalent REST API call.
lun-transition-volume-get-iter
This ONTAPI call does not have an equivalent REST API call.
lun-unbind
DELETE /api/protocols/san/vvol-bindings/{protocol_endpoint.uuid}/{vvol.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
force |
delete_all_references |
|
protocol-endpoint-path |
No REST Equivalent |
The protocol endpoint LUN of the vVol binding is specified in REST endpoint path using the UUID in place of the LUN path. |
vvol-path |
No REST Equivalent |
The vVol LUN of the vVol binding is specified in REST endpoint path using the UUID in place of the LUN path. |
lun-unmap
DELETE /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator-group |
No REST Equivalent |
The initiator group of the LUN map is specified in REST endpoint path using the UUID in place of the initiator group name. |
path |
No REST Equivalent |
The LUN of the LUN map is specified in REST endpoint path using the UUID in place of the LUN path. |
lun-unset-attribute
DELETE /api/storage/luns/{lun.uuid}/attributes/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
name |
No REST Equivalent |
The attribute name is specified as part of the endpoint URI. |
path |
No REST Equivalent |
The LUN is specified using the LUN's UUID as part of the endpoint URI. |
lun-unset-device-id
This ONTAPI call does not have an equivalent REST API call.
lun-alignment-list-info
This ONTAPI call does not have an equivalent REST API call.
lun-write-raw
PATCH /api/storage/luns/{uuid}
Note: Writing data is performed using a PATCH request on the LUN endpoint. The request header must
include Content-Type: multipart/form-data. The request body must be multipart/form-data
content with exactly one form entry containing the data to write.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
No REST Equivalent |
The LUN to which to write is identfied by the UUID in the REST URI. |
offset |
data.offset |
|
length |
No REST Equivalent |
The size of the data to write is implied by the REST request content. |
encoded-data |
No REST Equivalent |
lun-read-raw
GET /api/storage/luns/{uuid}
Note: Reading data is performed using a GET request on the LUN endpoint. The request header must
include Accept: multipart/form-data. Data is returned as multipart/form-data content
with exactly one form entry containing the data.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
No REST Equivalent |
The LUN from which to read is identfied by the UUID in the REST URI. |
offset |
data.offset |
|
length |
data.size |
lun-create-vld-metadir-entry
This ONTAPI call does not have an equivalent REST API call.
lun-delete-vld-metadir-entry
This ONTAPI call does not have an equivalent REST API call.
lun-preserve-qtree-nondisruptive-restore
This ONTAPI call does not have an equivalent REST API call.
lun-restore-qtree-nondisruptive-restore
This ONTAPI call does not have an equivalent REST API call.
lun-cleanup-qtree-nondisruptive-restore
This ONTAPI call does not have an equivalent REST API call.
lun-id-swap
This ONTAPI call does not have an equivalent REST API call.
lun-lba-hole-range-query
This ONTAPI call does not have an equivalent REST API call.
lun-lba-is-hole
This ONTAPI call does not have an equivalent REST API call.