Skip to main content
A newer release of this product is available.

Retrieve iSCSI credentials

Contributors
PDFs

GET /protocols/san/iscsi/credentials

Introduced In: 9.6

Retrieves iSCSI credentials.

  • 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

initiator_address.masks.address

string

query

False

Filter by initiator_address.masks.address

initiator_address.masks.family

string

query

False

Filter by initiator_address.masks.family

initiator_address.masks.netmask

string

query

False

Filter by initiator_address.masks.netmask

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

authentication_type

string

query

False

Filter by authentication_type

chap.outbound.user

string

query

False

Filter by chap.outbound.user

  • maxLength: 128

  • minLength: 1

chap.inbound.user

string

query

False

Filter by chap.inbound.user

  • maxLength: 128

  • minLength: 1

initiator

string

query

False

Filter by initiator

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.

  • Default value: 1

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

The number of records in the response.

records

array[iscsi_credentials]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "authentication_type": "string",
      "chap": {
        "inbound": {
          "password": "string",
          "user": "string"
        },
        "outbound": {
          "password": "string",
          "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

returned_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

href

self

href

_links

Name Type Description

self

href

inbound

Inbound CHAP credentials.

Name Type Description

password

string

The inbound CHAP password. Write-only; optional in POST and PATCH.

user

string

The inbound CHAP user name. Optional in POST and PATCH.

outbound

Output CHAP credentials.

To clear previously set outbound CHAP credentials, set property chap.outbound.user to an empty string in PATCH.

Name Type Description

password

string

The outbound CHAP password. Write-only; optional in POST and PATCH.

user

string

The outbound CHAP user name. Optional in POST and PATCH.

To clear previously set outbound CHAP credentials, set this property to an empty string in PATCH.

chap

Challenge-Handshake Authentication Protocol (CHAP) credentials.

Name Type Description

inbound

inbound

Inbound CHAP credentials.

outbound

outbound

Output CHAP credentials.

To clear previously set outbound CHAP credentials, set property chap.outbound.user to an empty string in PATCH.

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

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

iscsi_credentials

Name Type Description

_links

_links

authentication_type

string

The iSCSI authentication type. Required in POST; optional in PATCH.

chap

chap

Challenge-Handshake Authentication Protocol (CHAP) credentials.

initiator

string

The iSCSI initiator to which the credentials apply. Required in POST.

initiator_address

initiator_address

Initiator address ranges.

svm

svm

SVM, applies only to SVM-scoped objects.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.