Changing the host group or iSCSI target settings

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 the host mode or host mode option for a host group or an iSCSI target. For iSCSI targets, settings related to CHAP authentication can also be specified.

Execution permission

Storage Administrator (Provisioning)

Request line

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

Request message

Object ID

Specify the hostGroupId value obtained by getting information about the host group or the iSCSI target. 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 (target ID for an iSCSI port)

Query parameters
None.
Body

When setting the host mode option of the host group:

{
  "hostMode": "WIN",
  "hostModeOptions": [12,33]
}

When resetting the host mode option of the host group:

{
  "hostMode": "HP-UX",
  "hostModeOptions": [-1]
}

When setting the CHAP authentication mode and CHAP authentication direction for the iSCSI target:

{
  "hostMode": "WIN",
  "authenticationMode": "CHAP",
  "iscsiTargetDirection": "D"
}

Attribute

Type

Description

hostMode

string

(Required) Host mode

The specifiable types are as follows:

HP-UX, SOLARIS, AIX, WIN, LINUX/IRIX, TRU64, OVMS, NETWARE, VMWARE, VMWARE_EX, or WIN_EX

hostModeOptions

int[]

(Optional) Number of options for setting host mode options

The values are updated (overwritten) by the specified values. When specifying values, specify all the numbers for the host mode options that you want to set.

For details on the specifiable numbers, see the Provisioning Guide for Open Systems , or the Provisioning Guide .

To specify multiple option values, separate the values by commas.

If you set -1, the set host mode option will be reset.

authenticationMode

string

(Optional) CHAP authentication mode for the iSCSI target

The specifiable types are as follows:

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

iscsiTargetDirection

string

(Optional) Direction of CHAP authentication for the iSCSI target

The specifiable types are as follows:

S: Unidirectional authentication mode (The iSCSI target authenticates the iSCSI initiator.)

D: Bidirectional authentication mode (The iSCSI target and the iSCSI initiator authenticate each other.)

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 changed host group or iSCSI target

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