Setting a secret for the CHAP user

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request sets a secret for the specified CHAP user. If a secret is already set for the specified CHAP user, the current secret is overwritten.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/v1/objects/chap-users/object-ID

Request message

Object ID

Specify the chapUserId value obtained by getting information about the CHAP user. You can also specify the following attributes and connect them with commas:

portId,hostGroupNumber,wayOfChapUser,chapUserName 

Attribute

Type

Description

portId

string

(Required) Port number

hostGroupNumber

int

(Required) Target ID of the iSCSI target

wayOfChapUser

string

(Required) Type of the CHAP user name

  • TAR: The CHAP user name of the iSCSI target side
  • INI: The CHAP user name of the host bus adapter (iSCSI initiator) side

chapUserName

string

(Required) The CHAP user name

Query parameters
None.
Body

When setting the secret password for the CHAP user:

{
  "chapPassword": "TopSecretForMyChap"
}

When resetting the secret password of the CHAP user:

{
  "chapPassword": ""
}

Attribute

Type

Description

chapPassword

string

Specify a secret consisting of 12 to 32 characters for the specified CHAP user.

If you specify a null character, the password is reset.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the CHAP user name for which the secret was set

Action template

None.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/chap-users/CL1-D,1,TAR,MyRESTChapUser