iscsi
Suggest changes
PDFs
iscsi-add
This ONTAPI call does not have an equivalent REST API call.
iscsi-auth-add-initiator-address-ranges
PATCH /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator |
initiator |
|
initiator-address-ranges |
initiator_address.ranges |
iscsi-auth-generate-chap-password
This ONTAPI call does not have an equivalent REST API call.
iscsi-auth-remove-initiator-address-ranges
PATCH /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator |
initiator |
|
initiator-address-ranges |
initiator_address.ranges |
iscsi-connection-get-iter
GET /api/protocols/san/iscsi/sessions
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
connection-id |
connections.cid |
|
connection-state |
No REST Equivalent |
|
has-session |
No REST Equivalent |
The REST API only reports connections with a session. |
interface-name |
connections.interface.name |
|
local-ip-address |
connections.interface.ip.address |
|
local-ip-port |
connections.interface.ip.port |
|
remote-ip-address |
connections.initiator_address.address |
|
remote-ip-port |
connections.initiator_address.port |
|
session-id |
isid |
|
tpgroup-name |
target_portal_group |
|
tpgroup-tag |
target_portal_group_tag |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
iscsi-connection-shutdown
This ONTAPI call does not have an equivalent REST API call.
iscsi-delete
This ONTAPI call does not have an equivalent REST API call.
iscsi-initiator-add-auth
POST /api/protocols/san/iscsi/credentials
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
auth-type |
authentication_type |
|
initiator |
initiator |
|
initiator-address-ranges |
initiator_address.ranges |
|
outbound-passphrase |
No REST Equivalent |
|
outbound-password |
chap.outbound.password |
|
outbound-user-name |
chap.outbound.user |
|
passphrase |
No REST Equivalent |
|
password |
chap.inbound.password |
|
radius |
No REST Equivalent |
|
user-name |
chap.inbound.user |
iscsi-initiator-auth-get-iter
GET /api/protocols/san/iscsi/credentials
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
auth-chap-policy |
No REST Equivalent |
|
auth-type |
authentication_type |
|
initiator |
initiator |
|
initiator-address-ranges |
initiator_address.ranges |
|
outbound-user-name |
chap.outbound.user |
|
user-name |
chap.inbound.user |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
iscsi-initiator-delete-auth
DELETE /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator |
initiator |
iscsi-initiator-get-auth
GET /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator |
initiator |
iscsi-initiator-get-default-auth
GET /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator}
Note: Provide "default" for {initiator}.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
iscsi-initiator-get-iter
GET /api/protocols/san/iscsi/sessions
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator-aliasname |
initiator.alias |
|
initiator-group-list |
igroups.name |
|
initiator-nodename |
No REST Equivalent |
|
isid |
isid |
|
target-session-id |
No REST Equivalent |
|
tpgroup-name |
target_portal_group |
|
tpgroup-tag |
target_portal_group_tag |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
iscsi-initiator-modify-chap-params
PATCH /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
initiator |
initiator |
|
outbound-passphrase |
No REST Equivalent |
|
outbound-password |
chap.outbound.password |
|
outbound-user-name |
chap.outbound.user |
|
passphrase |
No REST Equivalent |
|
password |
chap.inbound.password |
|
radius |
No REST Equivalent |
|
remove-outbound |
chap.outbound.user |
You need to pass the empty string as the outbound user to clear the |
user-name |
chap.inbound.user |
iscsi-initiator-set-default-auth
PATCH /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator}
Note: Provide "default" for {initiator}.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
auth-type |
authentication_type |
|
outbound-passphrase |
No REST Equivalent |
|
outbound-password |
chap.outbound.password |
|
outbound-user-name |
chap.outbound.user |
|
passphrase |
No REST Equivalent |
|
password |
chap.inbound.password |
|
radius |
No REST Equivalent |
|
user-name |
chap.inbound.user |
iscsi-interface-accesslist-add
This ONTAPI call does not have an equivalent REST API call.
iscsi-interface-accesslist-get-iter
This ONTAPI call does not have an equivalent REST API call.
iscsi-interface-accesslist-remove
This ONTAPI call does not have an equivalent REST API call.
iscsi-interface-disable
This ONTAPI call does not have an equivalent REST API call.
iscsi-interface-enable
This ONTAPI call does not have an equivalent REST API call.
iscsi-interface-get-iter
GET /api/network/ip/interfaces
Note: Use the query: services=data_iscsi
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
current-node |
location.node.name |
|
current-port |
location.port.name |
|
interface-name |
name |
|
ip-address |
ip.address |
|
ip-port |
No REST Equivalent |
|
is-interface-enabled |
enabled |
|
relative-port-id |
No REST Equivalent |
|
sendtargets-fqdn |
No REST Equivalent |
|
tpgroup-name |
No REST Equivalent |
|
tpgroup-tag |
No REST Equivalent |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
iscsi-interface-modify
Note: The REST API does not support modifying the sendtargets-fqdn.
This ONTAPI call does not have an equivalent REST API call.
iscsi-isns-config
This ONTAPI call does not have an equivalent REST API call.
iscsi-isns-create
This ONTAPI call does not have an equivalent REST API call.
iscsi-isns-destroy
This ONTAPI call does not have an equivalent REST API call.
iscsi-isns-get-info
This ONTAPI call does not have an equivalent REST API call.
iscsi-isns-get-iter
This ONTAPI call does not have an equivalent REST API call.
iscsi-isns-start
This ONTAPI call does not have an equivalent REST API call.
iscsi-isns-stop
This ONTAPI call does not have an equivalent REST API call.
iscsi-isns-update
This ONTAPI call does not have an equivalent REST API call.
iscsi-node-get-name
GET /api/protocols/san/iscsi/services/{svm.uuid}
Note: Use the query: fields=target.name
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
iscsi-node-set-name
Note: The REST API does not support modifying the iSCSI node name. It does support modification of the alias.
This ONTAPI call does not have an equivalent REST API call.
iscsi-query
This ONTAPI call does not have an equivalent REST API call.
iscsi-remove
This ONTAPI call does not have an equivalent REST API call.
iscsi-service-create
POST /api/protocols/san/iscsi/services
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
alias-name |
target.alias |
|
node-name |
target.name |
|
start |
enabled |
iscsi-service-destroy
DELETE /api/protocols/san/iscsi/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.
iscsi-service-get-iter
GET /api/protocols/san/iscsi/services
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
alias-name |
target.alias |
|
is-available |
No REST Equivalent |
|
login-timeout |
No REST Equivalent |
|
max-cmds-per-session |
No REST Equivalent |
|
max-conn-per-session |
No REST Equivalent |
|
max-error-recovery-level |
No REST Equivalent |
|
node-name |
target.name |
|
retain-timeout |
No REST Equivalent |
|
tcp-window-size |
No REST Equivalent |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
iscsi-service-modify
PATCH /api/protocols/san/iscsi/services/{svm.uuid}
Note: The REST API only supports enabling/disabling the service and changing the target alias.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
login-timeout |
No REST Equivalent |
|
max-cmds-per-session |
No REST Equivalent |
|
max-conn-per-session |
No REST Equivalent |
|
max-error-recovery-level |
No REST Equivalent |
|
retain-timeout |
No REST Equivalent |
|
tcp-window-size |
No REST Equivalent |
iscsi-service-start
PATCH /api/protocols/san/iscsi/services/{svm.uuid}
Note: Set property "enabled" to "true".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
iscsi-service-status
GET /api/protocols/san/iscsi/services/{svm.uuid}
Note: Use the query: fields=enabled
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
iscsi-service-stop
PATCH /api/protocols/san/iscsi/services/{svm.uuid}
Note: Set property "enabled" to "false".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
iscsi-session-get-iter
GET /api/protocols/san/iscsi/sessions
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cmd-window-size |
No REST Equivalent |
|
data-pdu-in-order |
No REST Equivalent |
|
data-sequence-in-order |
No REST Equivalent |
|
default-time-to-retain |
No REST Equivalent |
|
default-time-to-wait |
No REST Equivalent |
|
error-recovery-level |
No REST Equivalent |
|
first-burst-length |
No REST Equivalent |
|
immediate-data-enabled |
No REST Equivalent |
|
initial-r2t-enabled |
No REST Equivalent |
|
initiator-aliasname |
initiator.alias |
|
initiator-nodename |
initiator.name |
|
iscsi-session-connection-list-entries |
No REST Equivalent |
|
iscsi-sesssion-cmd-list-entries |
No REST Equivalent |
|
isid |
isid |
|
max-burst-length |
No REST Equivalent |
|
max-connections |
No REST Equivalent |
This attribute is considered obsolete and is expected to |
max-ios-per-session |
No REST Equivalent |
|
max-outstanding-r2t |
No REST Equivalent |
|
session-type |
No REST Equivalent |
|
target-session-id |
No REST Equivalent |
|
tpgroup-name |
target_portal_group |
|
tpgroup-tag |
target_portal_group_tag |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
iscsi-session-shutdown
This ONTAPI call does not have an equivalent REST API call.
iscsi-stats-get-iter
This ONTAPI call does not have an equivalent REST API call.
iscsi-target-alias-clear-alias
PATCH /api/protocols/san/iscsi/services/{svm.uuid}
Note: Set property "target.alias" to the empty string.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
iscsi-target-alias-get-alias
GET /api/protocols/san/iscsi/services/{svm.uuid}
Note: Use the query: fields=target.alias
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
iscsi-target-alias-set-alias
PATCH /api/protocols/san/iscsi/services/{svm.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
alias-name |
target.alias |
iscsi-tpgroup-create
This ONTAPI call does not have an equivalent REST API call.
iscsi-tpgroup-destroy
This ONTAPI call does not have an equivalent REST API call.
iscsi-tpgroup-get-iter
GET /api/protocols/san/iscsi/sessions
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
interface-list-entries |
No REST Equivalent |
|
is-user-defined |
No REST Equivalent |
|
tpgroup-alua-preferred |
No REST Equivalent |
|
tpgroup-alua-state |
No REST Equivalent |
|
tpgroup-name |
target_portal_group |
|
tpgroup-tag |
target_portal_group_tag |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging.. |
iscsi-tpgroup-interface-add
This ONTAPI call does not have an equivalent REST API call.
iscsi-tpgroup-interface-delete
This ONTAPI call does not have an equivalent REST API call.