Retrieve iSCSI credentials
Retrieves iSCSI credentials to access and manage iSCSI targets within your storage network. This helps ensure secure communication between your hosts and storage systems.
HTTP method and endpoint
GET /protocols/san/iscsi/credentials
Introduced in
ONTAP 9.6
Related ONTAP commands
-
vserver iscsi security show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
chap.inbound.user |
string |
query |
False |
Filter by chap.inbound.user |
chap.outbound.user |
string |
query |
False |
Filter by chap.outbound.user |
authentication_type |
string |
query |
False |
Filter by authentication_type |
initiator |
string |
query |
False |
Filter by initiator |
initiator_address.masks.netmask |
string |
query |
False |
Filter by initiator_address.masks.netmask |
initiator_address.masks.family |
string |
query |
False |
Filter by initiator_address.masks.family |
initiator_address.masks.address |
string |
query |
False |
Filter by initiator_address.masks.address |
initiator_address.ranges.family |
string |
query |
False |
Filter by initiator_address.ranges.family |
initiator_address.ranges.end |
string |
query |
False |
Filter by initiator_address.ranges.end |
initiator_address.ranges.start |
string |
query |
False |
Filter by initiator_address.ranges.start |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records. |
records |
array[iscsi_credentials] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"authentication_type": "string",
"chap": {
"inbound": {
"user": "string"
},
"outbound": {
"user": "string"
}
},
"initiator": "iqn.1998-01.com.corp.iscsi:name1",
"initiator_address": {
"masks": [
{
"address": "10.10.10.7",
"family": "string",
"netmask": "24"
}
],
"ranges": [
{
"end": "10.10.10.7",
"family": "string",
"start": "10.10.10.7"
}
]
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
inbound
Inbound CHAP credentials.
| Name | Type | Description |
|---|---|---|
user |
string |
The inbound CHAP user name. Optional in POST and PATCH. |
outbound
Output CHAP credentials.
| Name | Type | Description |
|---|---|---|
user |
string |
The outbound CHAP user name. Optional in POST and PATCH. |
chap
Challenge-Handshake Authentication Protocol (CHAP) credentials.
| Name | Type | Description |
|---|---|---|
inbound |
Inbound CHAP credentials. |
|
outbound |
Output CHAP credentials. |
ip_info
IP information
| Name | Type | Description |
|---|---|---|
address |
string |
IPv4 or IPv6 address |
family |
string |
IPv4 or IPv6 |
netmask |
string |
Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always netmask length. |
ip_address_range
IP address range
| Name | Type | Description |
|---|---|---|
end |
string |
IPv4 or IPv6 address |
family |
string |
IPv4 or IPv6 |
start |
string |
IPv4 or IPv6 address |
initiator_address
Initiator address ranges.
| Name | Type | Description |
|---|---|---|
masks |
array[ip_info] |
|
ranges |
array[ip_address_range] |
svm
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
iscsi_credentials
| Name | Type | Description |
|---|---|---|
_links |
||
authentication_type |
string |
The iSCSI authentication type. Required in POST and optional in PATCH. |
chap |
Challenge-Handshake Authentication Protocol (CHAP) credentials. |
|
initiator |
string |
The iSCSI initiator to which the credentials apply. Required in POST. |
initiator_address |
Initiator address ranges. |
|
svm |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |