nvme
Suggest changes
PDFs
nvme-create
POST /api/protocols/nvme/services
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-available |
enabled |
|
return-record |
return_records |
nvme-delete
DELETE /api/protocols/nvme/services/{svm.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
nvme-disable-experimental
This ONTAPI call does not have an equivalent REST API call.
nvme-enable-experimental
This ONTAPI call does not have an equivalent REST API call.
nvme-feature-get
This ONTAPI call does not have an equivalent REST API call.
nvme-get-iter
GET /api/protocols/nvme/services
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-available |
enabled |
|
vserver |
svm.name |
|
vserver-uuid |
svm.uuid |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
nvme-initialize-anagrpids
This ONTAPI call does not have an equivalent REST API call.
nvme-interface-get-iter
GET /api/protocols/nvme/interfaces
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
No REST Equivalent |
You can retrieve the comment property by using the HTTP GET method at the /api/network/fc/interfaces endpoint. |
fc-wwnn |
fc_interface.wwnn |
|
fc-wwpn |
fc_interface.wwpn |
|
home-node |
node.name |
|
home-port |
fc_interface.port.name |
|
lif |
name |
|
lif-uuid |
uuid |
|
physical-protocol |
No REST Equivalent |
|
status-admin |
enabled |
|
transport-address |
transport_address |
|
transport-protocols |
No REST Equivalent |
|
vserver |
svm.name |
|
vserver-uuid |
svm.uuid |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
nvme-license-grace-period-get
This ONTAPI call does not have an equivalent REST API call.
nvme-modify
PATCH /api/protocols/nvme/services/{svm.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-available |
enabled |
nvme-namespace-create
POST /api/storage/namespaces
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
application |
No REST Equivalent |
|
block-size |
space.block_size |
|
comment |
comment |
|
ostype |
os_type |
|
path |
name |
|
return-record |
return_records |
|
size |
space.size |
|
uuid |
uuid |
nvme-namespace-delete
DELETE /api/storage/namespaces/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
destroy-application-namespace |
No REST Equivalent |
|
path |
uuid |
The REST API call provides the namespace UUID instead of the namespace path. |
skip-mapped-check |
allow_delete_while_mapped |
nvme-namespace-get-iter
GET /api/storage/namespaces
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
anagrpid |
subsystem_map.anagrpid |
|
application |
No REST Equivalent |
|
application-uuid |
No REST Equivalent |
|
block-size |
space.block_size |
|
comment |
comment |
|
creation-timestamp |
create_time |
|
is-read-only |
status.read_only |
|
node |
location.node.name |
|
nsid |
subsystem_map.nsid |
|
ostype |
os_type |
|
path |
name |
|
qtree |
location.qtree.name |
|
restore-inaccessible |
No REST Equivalent |
|
size |
space.size |
|
size-used |
space.used |
|
state |
status.state |
|
subsystem |
subsystem_map.subsystem.name |
|
uuid |
subsystem_map.subsystem.uuid |
|
volume |
location.volume.name |
|
vserver |
svm.name |
|
vserver-uuid |
svm.uuid |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
nvme-namespace-modify
PATCH /api/storage/namespaces/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
|
path |
uuid |
The REST API call provides the namespace UUID instead of the namespace path. |
nvme-namespace-os-type-list
This ONTAPI call does not have an equivalent REST API call.
nvme-namespace-resize
Note: The REST API does not support resizing namespaces.
This ONTAPI call does not have an equivalent REST API call.
nvme-revert-anagrpids
This ONTAPI call does not have an equivalent REST API call.
nvme-subsystem-controller-get-iter
GET /api/protocols/nvme/subsystem-controllers
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
admin-queue-depth |
admin_queue.depth |
|
controller-id |
id |
|
host-nqn |
host.nqn |
|
initiator-transport-address |
interface.transport_address |
|
io-queue-count |
io_queue.count |
|
io-queue-depth |
io_queue.depth |
|
lif |
interface.name |
|
lif-uuid |
interface.uuid |
|
node |
node.name |
|
subsystem |
subsystem.name |
|
subsystem-uuid |
subsystem.uuid |
|
transport-protocol |
No REST Equivalent |
|
vserver |
svm.name |
|
vserver-uuid |
svm.uuid |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
nvme-subsystem-controller-shutdown
This ONTAPI call does not have an equivalent REST API call.
nvme-subsystem-create
POST /api/protocols/nvme/subsystems
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
|
delete-on-unmap |
delete_on_unmap |
|
ostype |
os_type |
|
return-record |
return_records |
|
subsystem |
name |
nvme-subsystem-delete
DELETE /api/protocols/nvme/subsystems/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
skip-host-check |
allow_delete_with_hosts |
|
skip-mapped-check |
allow_delete_while_mapped |
|
subsystem |
No REST Equivalent |
The REST API call provides the subsystem UUID instead of the subsystem name. |
nvme-subsystem-get-iter
GET /api/protocols/nvme/subsystems
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
|
default-io-queue-count |
io_queue.default.count |
|
default-io-queue-depth |
io_queue.default.depth |
|
delete-on-unmap |
delete_on_unmap |
|
ostype |
os_type |
|
serial-number |
serial_number |
|
subsystem |
name |
|
target-nqn |
target_nqn |
|
uuid |
uuid |
|
vserver |
svm.name |
|
vserver-uuid |
svm.uuid |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
nvme-subsystem-host-add
POST /api/protocols/nvme/subsystems/{subsystem.uuid}/hosts
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
host-nqn |
nqn |
|
subsystem |
subsystem.uuid |
The REST API call provides the subsystem UUID instead of the subsystem name. |
nvme-subsystem-host-get-iter
GET /api/protocols/nvme/subsystems/{subsystem.uuid}/hosts
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
host-nqn |
nqn |
|
io-queue-count |
io_queue.count |
|
io-queue-depth |
io_queue.depth |
|
subsystem |
subsystem.uuid |
The REST API call provides the subsystem UUID instead of the subsystem name. You can retrieve the subsystem name by sending a GET request to the /api/protocols/nvme/subsystems/{uuid} endpoint. |
subsystem-uuid |
subsystem.uuid |
The REST API call provides the subsystem UUID instead of the subsystem name. You can retrieve the subsystem UUID by sending a GET request to the /api/protocols/nvme/subsystems/{uuid} endpoint. |
vserver |
No REST Equivalent |
You can retrieve the vserver nameby sending a GET request to the /api/protocols/nvme/subsystems/{uuid} endpoint. |
vserver-uuid |
No REST Equivalent |
You can retrieve the vserver UUID by sending a GET request to the /api/protocols/nvme/subsystems/{uuid} endpoint. |
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
nvme-subsystem-host-remove
DELETE /api/protocols/nvme/subsystems/{subsystem.uuid}/hosts/{nqn}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
host-nqn |
nqn |
|
subsystem |
subsystem.uuid |
The REST API call provides the subsystem UUID instead of the subsystem name. |
nvme-subsystem-map-add
POST /api/protocols/nvme/subsystem-maps
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
namespace.name |
|
subsystem |
subsystem.name |
nvme-subsystem-map-get-iter
GET /api/protocols/nvme/subsystem-maps
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
anagrpid |
anagrpid |
|
namespace-uuid |
namespace.uuid |
|
nsid |
nsid |
|
path |
namespace.name |
|
subsystem |
subsystem.name |
|
subsystem-uuid |
subsystem.uuid |
|
vserver |
svm.name |
|
vserver-uuid |
svm.uuid |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
nvme-subsystem-map-remove
DELETE /api/protocols/nvme/subsystem-maps/{subsystem.uuid}/{namespace.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
namespace.uuid |
The REST API call provides the namespace UUID instead of the namespace path. |
subsystem |
subsystem.uuid |
The REST API call provides the subsystem UUID instead of the subsystem name. |
nvme-subsystem-modify
PATCH /api/protocols/nvme/subsystems/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
|
delete-on-unmap |
delete_on_unmap |
|
subsystem |
uuid |
The REST API call provides the subsystem UUID instead of the subsystem name. |
nvme-subsystem-os-type-list
This ONTAPI call does not have an equivalent REST API call.