Setting the command device

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 and releases the command device specified for the LDEV. The request also changes the attributes of the command device.
Note:

If you do not specify the isSecurityEnabled attribute, the isUserAuthenticationEnabled attribute, or the isDeviceGroupDefinitionEnabled attribute, the settings will be disabled after execution, even if the settings were enabled before execution. If you change a command device attribute, specify this item to prevent the setting from being unexpectedly disabled.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/ldevs/object-ID/actions/set-as-command-device/invoke

Request message

Object ID
Specify the ldevId value obtained by getting information about volumes.

Attribute

Type

Description

ldevId

int

(Required) Specify the LDEV number with a decimal (base 10) number.

Query parameters
None.
Body

The following coding example sets the command device:

{
  "parameters": {
    "isCommandDevice": true
  }
}

The following coding example sets the command device, security, user authentication, and device group information authentication:

{
  "parameters": {
    "isCommandDevice": true,
    "isSecurityEnabled": true,
    "isUserAuthenticationEnabled": true,
    "isDeviceGroupDefinitionEnabled": true
  }
}

Attribute

Type

Description

isCommandDevice

boolean

(Required) Specify whether to set the specified LDEV for the command device.

  • true: Enables the settings for the command device.
  • false: Disables the settings for the command device.

isSecurityEnabled

boolean

(Optional) Specify whether to enable the security settings for the command device.

  • true: Enables the security settings.
  • false: Disables the security settings.

If this value is omitted, false is assumed. Specify this item to prevent the setting from being unexpectedly disabled.

isUserAuthenticationEnabled

boolean

(Optional) Specify whether to enable the user authentication setting for the command device.

  • true: Enables the user authentication setting.
  • false: Disables the user authentication setting.

If this value is omitted, false is assumed. Specify this item to prevent the setting from being unexpectedly disabled.

isDeviceGroupDefinitionEnabled

boolean

(Optional) Specify whether to enable the settings for device group information authentication for the command device.

  • true: Enables the settings for device group information authentication.
  • false: Disables the settings for device group information authentication.

If this value is omitted, false is assumed. Specify this item to prevent the setting from being unexpectedly disabled.

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 volume for which the command device attribute has been changed

Action template

GET base-URL/v1/objects/ldevs/object-ID/actions/set-as-command-device

Status codes

The following table describes the meanings of the status codes of the request for this operation. For details on other status codes, see the description on HTTP status codes.

Status code

Message

Description

412

Precondition Failed

The LDEV status is inappropriate. The LDEV might be in one of the following statuses:

  • The LDEV is used as a virtual volume of Thin Image.
  • The LDEV is used as a Quorum disk.
  • The LDEV is used as a system disk.
  • The LDEV is used as a deduplication system data volume (fingerprint).
  • The LDEV is used as a pool volume.
  • The LDEV is used as a Volume Migration volume.

Coding example

To get an action template:

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/ldevs/1/actions/set-as-command-device

To run the request after getting an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/ldevs/1/actions/set-as-command-device/invoke