Getting information about a specific host group or iSCSI target

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 by specifying the host group number of the port or the target ID of the iSCSI target.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-groups/object-ID

Request message

Object ID

Specify the hostGroupId value obtained by getting information about the host groups or iSCSI targets. You can also specify the following attributes and connect them with commas:

portId,hostGroupNumber

Attribute

Type

Description

portId

string

(Required) Port number

hostGroupNumber

int

(Required) Host group number of the port (for the iSCSI target, target ID)

Query parameters

None.

Body

None.

Response message

Body

The following is an example of the output generated when getting information by specifying the port number and the host group number:

{
  "hostGroupId": "CL1-A,0",
  "portId": "CL1-A",
  "hostGroupNumber": 0,
  "hostGroupName": "hostA",
  "hostMode": "WIN",
  "hostModeOptions": [
    1,
    2
  ]
}

For an iSCSI target, the following is an example of the output generated when getting information by specifying the port number and the target ID:

{
  "hostGroupId": "CL1-A,0",
  "portId": "CL1-A",
  "hostGroupNumber": 0,
  "hostGroupName": "hostA",
  "iscsiName": "iqn.rest.example.of.iqn.host",
  "authenticationMode": "CHAP",
  "iscsiTargetDirection": "S",
  "hostMode": "WIN",
  "hostModeOptions": [
    1,
    2
  ]
}

Attribute

Type

Description

hostGroupId

string

Object ID for the host group or iSCSI target

portId

string

Port number

hostGroupNumber

int

Host group number of the port (for the iSCSI target, target ID)

hostGroupName

string

Host group name (for the iSCSI target, target ID)

iscsiName

string

iSCSI name of the iSCSI target of the port

This information is obtained in the case of an iSCSI port.

authenticationMode

string

Authentication mode for the iSCSI target

This information is obtained in the case of an iSCSI port.

  • CHAP: CHAP-authentication mode
  • NONE: No-authentication mode
  • BOTH: Both CHAP-authentication mode and no-authentication mode

iscsiTargetDirection

string

Direction of CHAP authentication for the iSCSI target

This information is obtained in the case of an iSCSI port.

  • S: One-way (The iSCSI target authenticates the iSCSI initiator.)
  • D: Mutual (The iSCSI target and the iSCSI initiator authenticate each other.)

hostMode

string

Host mode for setting the host adapter of the host group

For details on the values to be obtained, see the description of the API function for changing the host group or iSCSI target settings.

hostModeOptions

int[]

Number of the host mode option set for the host group

This is not output if a host mode option is not set.

For details on the number to be obtained, see the Provisioning Guide for Open Systems , or the Provisioning Guide .

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/host-groups/CL1-A,0