Creating a virtual storage machine

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 creates a virtual storage machine. A resource group is also created at the same time.
Note:

If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Security Administrator (View & Modify)

Request line

POST base-URL/v1/objects/virtual-storages

Request message

Object ID

None.

Query parameters

None.

Body
{
  "virtualSerialNumber": "422222",
  "virtualModel": "VSP G700",
  "resourceGroupName": "DevGroup"
}

Attribute

Type

Description

virtualSerialNumber

string

(Required) Serial number of the virtual storage machine

virtualModel

string

(Required) Model name of the virtual storage machine

Specifiable values are as follows:

  • VSP E1090

  • VSP E990

  • VSP E790

  • VSP E590

  • VSP E1090H

  • VSP E790H

  • VSP E590H

  • VSP F900

  • VSP F700

  • VSP F370

  • VSP F350

  • VSP G900

  • VSP G700

  • VSP G370

  • VSP G350

  • VSP G130

  • VSP G800 and VSP F800#1

  • VSP G400/G600 and VSP F400/F600#1

  • VSP G200

  • HUS VM

  • VSP 5100, 5500#2

  • VSP 5200, 5600#2

  • VSP 5100H, 5500H#2

  • VSP 5200H, 5600H#2

  • VSP G1000/G1500 and VSP F1500

  • VSP

resourceGroupName

string

(Required) Name of the resource group to be created when the virtual storage machine is created

Specify a name consisting of 1 to 32 characters.

#1: If the storage system model is VSP N400 or VSP N600, specify VSP G400/G600 and VSP F400/F600. If the storage system model is VSP N800, specify VSP G800 and VSP F800.

#2: If the storage system is in the VSP 5000 series, note the following.

  • To maintain compatibility, you can specify VSP 5000 series AFA instead of VSP 5100, 5500. In this case, the request is run in the same way as if VSP 5100, 5500 were specified.

  • To maintain compatibility, you can also specify VSP 5000 series hybrid instead of VSP 5100H, 5500H. In this case, the request is run in the same way as if VSP 5100H, 5500H were specified.

  • If you run the API request that gets information about a virtual storage machine with VSP 5100, 5500, VSP 5200, 5600, VSP 5100H, 5500H, or VSP 5200H, 5600H specified for the virtualModel attribute, the series name (VSP 5000 series AFA or VSP 5000 series hybrid) will be output for the virtualModel attribute, and the value you specified will be output for the virtualModelDetail attribute.

Response message

Body

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

Attribute

Description

affectedResources

URL of the created virtual storage machine

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 POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/virtual-storages/