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

Update iSCSI credentials

Contributors
PDFs

PATCH /protocols/san/iscsi/credentials/{svm.uuid}/{initiator}

Introduced In: 9.6

Updates specified iSCSI credentials.

  • vserver iscsi security add-initiator-address-ranges

  • vserver iscsi security default

  • vserver iscsi security modify

  • vserver iscsi security remove-initiator-address-ranges

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

path

True

The unique identifier of an SVM.

initiator

string

path

True

The iSCSI initiator of the credentials object.

add_initiator_addresses

boolean

query

False

If true, the initiator addresses in the body merge into the existing addresses in the iSCSI security object rather than replace the existing addresses.

  • Default value:

remove_initiator_addresses

boolean

query

False

If true, the initiator addresses in the body are removed from the existing addresses in the iSCSI security object rather than replace the existing addresses.

  • Default value:

Request Body

Name Type Description

_links

_links

authentication_type

string

The iSCSI authentication type. Required in POST and 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
Example request 
{
  "_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"
  }
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2621462

An SVM with the specified UUID does not exist.

2621706

Both the SVM UUID and SVM name were supplied, but they do not refer to the same SVM.

2621707

No SVM was specified. Either svm.name or svm.uuid must be supplied.

5374145

The iSCSI security password must contain an even number of valid hex digits.

5374147

The CHAP inbound and outbound passwords must be different.

5374149

The inbound user and password properties are required for CHAP authentication.

5374150

Outbound CHAP authentication requires an outbound password.

5374155

The functionality is not supported for the default security credential.

5374855

The value for property initiator_address.ranges.start is greater than the value for property initiator_address.ranges.end.

5374856

The value for property initiator_address.ranges.start does not belong to the same IP address family as the value for property initiator_address.ranges.end.

5374895

The iSCSI security credential does not exist on the specified SVM.

5374900

Setting the CHAP authentication properties are not supported with authentication types none or deny.
Name Type Description

error

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

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.

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.

chap

Challenge-Handshake Authentication Protocol (CHAP) credentials.

Name Type Description

inbound

inbound

Inbound CHAP credentials.

outbound

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

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

iscsi_credentials

Name Type Description

_links

_links

authentication_type

string

The iSCSI authentication type. Required in POST and 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

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.