Getting information about a specific 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 gets information about the specified CHAP user. Note that if the iSCSI target name or CHAP user name contains a space, the CHAP user name cannot be obtained.

Execution permission

Storage Administrator (View Only)

Request line

GET 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

None.

Response message

Body
{
  "chapUserId": "CL1-D,0,INI,mychap",
  "portId": "CL1-D",
  "hostGroupNumber": 0,
  "hostGroupName": "1D-G00",
  "chapUserName": "mychap",
  "wayOfChapUser": "INI"
}

Attribute

Type

Description

chapUserId

string

Object ID for the CHAP user

portId

string

Port number

hostGroupNumber

int

Target ID of the iSCSI target

hostGroupName

string

Name of the iSCSI target

chapUserName

string

CHAP user name

wayOfChapUser

string

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

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 GET https://192.0.2.100/ConfigurationManager/v1/objects/chap-users/CL1-D,0,INI,mychap