Managing resources by using virtual storage machines

A virtual storage machine can be used as a global-active device or for nondisruptive migration. By registering resources in virtual storage machines, you can collectively manage resources of multiple physical storage systems on a single virtual storage machine, or divide resources of a single physical storage system into multiple virtual storage machines and manage the resources separately.

The following figure shows examples of virtual storage machine configurations:

In this figure, a virtual storage machine of the virtual model VSP G1000 (virtual serial number: 11223) and a virtual storage machine of the virtual model VSP G600 (virtual serial number: 123456) are created in a VSP G900 storage system (serial number: 101111), and the resources registered in the virtual storage machines are allocated to the hosts. When the configuration is set up like this, from the virtual point of view it seems as if host A is accessing VSP G1000 (virtual serial number: 11223), and host B is accessing VSP G600 (virtual serial number: 123456).

For details on how to manage resources by using virtual storage machines, see the manual Provisioning Guide for Open Systems or Provisioning Guide.

Create a virtual storage machine, and then register the required resources. Allocate the registered resources to the hosts in the same way as allocating resources of a physical storage system, or use the registered resources in the volumes of a global-active device pair.

• Create a virtual storage machine

  Create a virtual storage machine, and then specify the model name and serial number. A resource group to be used on the virtual storage machine is also created at the same time.

• Get a list of the virtual storage machines

  Get information such as the storage device IDs of the created virtual storage machines, and the IDs of resource groups on the virtual storage machines.

• Add resource groups on a virtual storage machine (optional)

  If necessary, add resource groups to the virtual storage machine. Perform this operation by executing the API request for creating resource groups.

• Add resources to the virtual storage machines

  In the resource groups of the virtual storage machine, add resources such as host numbers, host group numbers, and LDEV numbers. Perform this operation by executing the API request for adding a resource to a resource group.

  • To add an LDEV number, first delete the set virtual LDEV number, and then add the LDEV number. After adding the LDEV number in the virtual storage machine, set the virtual LDEV number.
  • To add a host group number or iSCSI target number, add an undefined host group or iSCSI target.

Delete the resources on a virtual storage machine before you delete the virtual storage machine.

• Delete the virtual LDEV number

  Delete the virtual LDEV number that was set for the virtual LDEV on the virtual storage machine.

• Remove the resources in the virtual storage machine

  Delete the LDEVs, parity groups, host numbers, and all other resources that are added in the resource group in the virtual storage machine. Perform this operation by executing the API request for removing resources from resource groups.

• Delete the virtual storage machine

  Delete the virtual storage machine. Note that when all of the resource groups are deleted from the virtual storage machine, the virtual storage machine is automatically deleted.

Storage Administrator (View Only)

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

• Object ID

  None.

• Query parameters

  None.

• Body

  None.

• Body

  {
    "data" : [
      {
        "virtualStorageDeviceId" : "800000002015",
        "virtualSerialNumber" : "2015",
        "virtualModel" : "VSP G1000/G1500 and VSP F1500",
        "resourceGroupIds" : [ 
          1,
          3
        ]
      },
      {
        "virtualStorageDeviceId" : "882000400002",
        "virtualSerialNumber" : "400002",
        "virtualModel" : "VSP G350",
        "resourceGroupIds" : [ 
          0, 
          2, 
          4
        ]
      }
    ]
  }

  Attribute	Type	Description
  virtualStorageDeviceId	string	Storage device ID of the virtual storage machine
  virtualSerialNumber	string	Serial number of the virtual storage machine
  virtualModel	string	Model name of the virtual storage machine
  resourceGroupIds	int[]	Resource group ID

For details on the status codes for the request that performs this operation, see the description of HTTP status codes.

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/virtual-storages

Storage Administrator (View Only)

GET base-URL/v1/objects/virtual-storages/object-ID

• Object ID

  Specify the virtualStorageDeviceId value obtained by getting information about the virtual storage machine.

  Attribute	Type	Description
  virtualStorageDeviceId	string	(Required) Storage device ID of the virtual storage machine

• Query parameters

  None.

• Body

  None.

• Body

  {
    "virtualStorageDeviceId" : "882000400002",
    "virtualSerialNumber" : "400002",
    "virtualModel" : "VSP G350",
    "resourceGroupIds" : [
      0, 
      2, 
      4
    ]
  }

  Attribute	Type	Description
  virtualStorageDeviceId	string	Storage device ID of the virtual storage machine
  virtualSerialNumber	string	Serial number of the virtual storage machine
  virtualModel	string	Model name of the virtual storage machine
  resourceGroupIds	int[]	Resource group ID

For details on the status codes for the request that performs this operation, see the description of HTTP status codes.

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/virtual-storages/882000400002

Security Administrator (View & Modify)

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

• 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 F900 VSP F700 VSP F370 VSP F350 VSP G900 VSP G700 VSP G370 VSP G350 VSP G130 VSP G800 and VSP F800# VSP G400/G600 and VSP F400/F600# VSP G200 HUS VM VSP G1000/G1500 and VSP F1500 VSP USP VM USP V
  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.

  #: 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.

• 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

For details on the status codes of the request for this operation, see the description on HTTP status codes.

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/

Security Administrator (View & Modify)

DELETE base-URL/v1/objects/virtual-storages/object-ID

• Object ID

  Specify the virtualStorageDeviceId value obtained by getting information about the virtual storage machine.

  Attribute	Type	Description
  virtualStorageDeviceId	string	(Required) Storage device ID of the virtual storage machine

• Query parameters

  None.

• Body

  None.

• 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 deleted virtual storage machine

For details on the status codes of the request for this operation, see the description on HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE https://192.0.2.100/ConfigurationManager/v1/objects/virtual-storages/409900010000

Storage Administrator (View Only)

GET base-URL/v1/objects/ldevs

• Object ID

  None.

• Query parameters

  You can filter the execution result by specifying conditions, or request additional detailed information about virtual LDEVs. To get information about virtual LDEVs, specify the target virtual storage machine by using the virtualSerialNumber parameter.

  • When filtering the execution result

    By default, information about a maximum of 100 virtual LDEVs is obtained. You can get information about a maximum of 16,384 virtual LDEVs by specifying the count parameter. When the ldevOption parameter or the poolId parameter is specified, if the number of virtual LDEVs for which information is to be obtained exceeds 16,384, use the headVirtualLdevId parameter and specify a value so that the virtual LDEV numbers whose information is to be obtained are included in the range. The information that can be obtained is only about the number of virtual LDEVs that are included in the range specified by the combination of the headVirtualLdevId parameter and the count parameter.

    Important

    For this API, the number of concurrent executions might be restricted due to the number of LDEVs to be obtained and the details of other processing to be executed at the same time. For details about restriction conditions, see the notes about the number of concurrent executions.

    For query parameters that can be specified at the same time, see the following table that lists the combinations of query parameters that can be specified.

    Parameter	Type	Filter Condition
    virtualSerialNumber	string	(Required) Specify the serial number of a virtual storage machine. Information about virtual LDEVs on the virtual storage machine is obtained in the ascending order of virtual LDEV numbers.
    headVirtualLdevId	int	(Optional) Specify the virtual LDEV number (a decimal) from which the processing to get information is to start. Information about the LDEVs is obtained in the ascending order of virtual LDEV numbers, starting with the specified virtual LDEV number. If this parameter is omitted, 0 is assumed. When specifying this parameter, be sure to also specify the virtualSerialNumber parameter.
    count	int	(Optional) Specify the number of virtual LDEVs about which you want to obtain information. Specify a value in the range from 1 to 16384. If this parameter is omitted, 100 is assumed.
    ldevOption	string	(Optional) Virtual LDEV conditions for getting information You can specify the following conditions: defined Get information about virtual LDEVs that have been implemented. undefined Get information about virtual LDEVs that are not implemented. dpVolume Obtaining DP volume information luMapped Get information about virtual LDEVs for which LU paths are defined. luUnmapped Get information about virtual LDEVs for which LU paths have not been defined. externalVolume Get information about external volumes. If this is omitted, information about all types of virtual LDEVs will be obtained.
    poolId	int	(Optional) Pool number Get information about the virtual LDEVs that are associated with the specified pool. By using the ldevOption parameter when specifying conditions, the following information can be obtained: If dpVolume is specified for the ldevOption parameter: Gets information about the DP volumes that are associated with the specified pool. If luMapped is specified for the ldevOption parameter: Gets information about virtual LDEVs for which LU paths associated with the specified pool are defined. If luUnmapped is specified for the ldevOption parameter: Gets information about virtual LDEVs for which LU paths associated with the specified pool have not been defined. If you specify this parameter without specifying the ldevOption parameter, the API gets information about the volumes that make up the pool (pool volumes).
    resourceGroupId	int	(Optional) ID of the resource group to which virtual LDEVs for which information is to be obtained belong
    journalId	int	(Optional) ID of the journal to which virtual LDEVs for which information is to be obtained belong
    parityGroupId	string	(Optional) Number of the parity group to which LDEVs for which information is to be obtained belong Specify concatenated parity groups in the same way as the above. If the concatenated parity groups are 1-3-1, 1-3-2, or 1-3-3, specify as follows: parityGroupId=1-3

    The following table shows the combinations of query parameters that can be specified.

    Parameter	virtual​Serial​Number	head​Virtual​Ldev​Id	count	ldev​Option	poolId	resource​Group​Id	journal​Id	parity​Group​Id
    virtual​Serial​Number	--	Y	Y	Y	Y	Y	Y	Y
    head​Virtual​Ldev​Id	Y	--	Y	N	N	N	N	N
    count	Y	Y	--	Y	Y	Y	Y	Y
    ldevOption	Y	N	Y	--	Y#	Y	N	N
    poolId	Y	N	Y	Y#	--	Y	N	N
    resourceGroupId	Y	N	Y	Y	Y	--	Y	Y
    journalId	Y	N	Y	N	N	Y	--	N
    parityGroupId	Y	N	Y	N	N	Y	N	--

    #: If defined, undefined, or externalVolume is specified as the value of the ldevOption parameter, you cannot specify this combination of parameters.

  • When requesting additional detailed information

    Parameter	Type	Description
    detailInfoType	string	(Optional) Type of detailed information to be obtained You can use this parameter together with parameters that filter the execution results. The following values can be specified. To specify multiple values, separate the values by using commas. FMC Adds detailed information about accelerated compression for the virtual LDEVs that belong to parity groups with drive type SSD(FMC). virtualSerialNumber Adds detailed information about virtual storage machines. savingInfo Adds detailed information about capacity saving function (dedupe and compression).

• Body

  None.

• Body

  {
    "data": [
      {
        "ldevId": 0,
        "virtualLdevId": 0,
        "virtualSerialNumber": "410012",
        "clprId": 0,
        "emulationType": "OPEN-V-CVS",
        "byteFormatCapacity": "1.00 G",
        "blockCapacity": 2097152,
        "numOfPorts": 1,
        "ports": [
          {
            "portId": "CL3-B",
            "hostGroupNumber": 25,
            "hostGroupName": "bs10300-7",
            "lun": 19
          }
        ],
        "attributes": [
          "CVS",
          "HDP",
          "GAD"
        ],
        "status": "NML",
        "mpBladeId": 2,
        "ssid": "0004",
        "poolId": 4,
        "numOfUsedBlock": 0,
        "isFullAllocationEnabled": false,
        "resourceGroupId": 6,
        "dataReductionStatus": "DISABLED",
        "dataReductionMode": "disabled",
        "isAluaEnabled": false
      },
      {
        "ldevId": 1,
        "virtualLdevId": 1,
        "virtualSerialNumber": "410012",
        "clprId": 0,
        "emulationType": "OPEN-V-CVS",
        "byteFormatCapacity": "1.00 G",
        "blockCapacity": 2097152,
        "numOfPorts": 1,
        "ports": [
          {
            "portId": "CL3-B",
            "hostGroupNumber": 25,
            "hostGroupName": "bs10300-7",
            "lun": 21
          }
        ],
        "attributes": [
          "CVS",
          "HDP",
          "GAD"
        ],
        "label": "ldev_label_1",
        "status": "NML",
        "mpBladeId": 0,
        "ssid": "0004",
        "poolId": 10,
        "numOfUsedBlock": 0,
        "isFullAllocationEnabled": false,
        "resourceGroupId": 6,
        "dataReductionStatus": "DISABLED",
        "dataReductionMode": "disabled",
        "isAluaEnabled": false
      }
    ]
  }

  The following table describes the attributes to be obtained in the body of the response message. For details on attributes to be obtained, see the description of the API function for getting volume information.

  Attribute	Type	Description
  ldevId	int	LDEV number
  virtualLdevId	int	Virtual LDEV number
  virtualSerialNumber	string	Serial number of the virtual storage machine

  If you execute the request with virtualSerialNumber specified for the detailInfoType query parameter, the request also obtains detailed information about the virtual storage machines.

  Attribute	Type	Description
  virtualModel	string	Model name of the virtual storage machine

  If you run the request with savingInfo specified for the detailInfoType query parameter, the request also obtains detailed information about the capacity saving function.

  {
    "data": [
      {
        "ldevId": 12,
        ...
        ...
        "dataReductionTotalSavingRatio": "2.44",
        "isDataReductionTotalSavingBlockAvailable": true,
        "dataReductionTotalSavingBlock": 13878844,
        "dataReductionSavingBlockCompression": 12134812,
        "dataReductionSavingBlockDeduplication": 808078,
        "dataReductionSavingBlockReclaim": 1076144,
        "dataReductionSystemBlock": 140190,
        "dataReductionPreUsedBlock": 23489911,
        "dataReductionPoolBlock": 9611067
      }
    ]

  Attribute	Type	Description
  dataReductionTotalSavingRatio	string	The ratio of volume capacity reduced by using the capacity reduction function The capacity before data reduction is displayed as a ratio of the capacity after data reduction, where the capacity after data reduction is assigned a value of 1.
  isDataReductionTotalSavingBlockAvailable	boolean	Whether the size of the data can be reduced true : The size of the data can be reduced. If the value of this attribute is true, the size of the data that has been reduced is displayed for the dataReductionTotalSavingBlock attribute. false : The size of the data cannot be reduced (for example, if the size of the data after data reduction is greater than the size of the data before data reduction).
  dataReductionTotalSavingBlock	long	Total number of blocks reduced by using the capacity saving function This value is displayed when the isDataReductionTotalSavingBlockAvailable attribute is set to true. This value includes the amount of zero data that was reduced and the volume of metadata and garbage data generated by the storage system.
  dataReductionSavingBlockCompression	long	Number of blocks reduced by using the capacity saving function (compression) The value does not include the volume of metadata and garbage data generated by the storage system.
  dataReductionSavingBlockDeduplication	long	Number of blocks reduced by using the capacity saving function (deduplication) The value does not include the volume of metadata and garbage data generated by the storage system.
  dataReductionSavingBlockReclaim	long	Number of blocks reduced by using the capacity saving function (reclaiming of the specified data pattern) The value does not include the volume of metadata and garbage data generated by the storage system.
  dataReductionSystemBlock	long	Total number of blocks of system data (metadata and garbage collection) used by the capacity saving function The value does not include the volume of metadata and garbage data in the deduplication system data volumes.
  dataReductionPreUsedBlock	long	Number of blocks before data reduction
  dataReductionPoolBlock	long	Number of blocks in the pool volume used by the volume

For details on the status codes of the request for this operation, see the section explaining HTTP status codes.

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?count=2&virtualSerialNumber=410012"

A maximum of two requests to get more than 2,048 LDEVs can be run at the same time for each storage system. The HTTP status code 503 is returned for the unaccepted request. In such case, wait a while, and then run the API request again.

For API requests that obtain 2,048 or fewer LDEVs, the number of concurrent executions might be restricted due to the details of other processing to be executed at the same time. The following processing affects the number of concurrent executions:

• Processing to get resource group information
• Processing to get multiple pieces of LDEV information
• Processing to get port information (when executed with detailInfoType=logins specified in the query)
• Processing to get information about host groups or iSCSI targets
• Processing to get global-active device pair information
• Processing to get a list of external path groups
• Processing to get information about a specific external path group

If the above processes are running, use the following as a reference for the maximum number of requests to obtain LDEV information that can be executed at the same time:

If you simultaneously execute the request to get global-active device pair information, the approximate maximum number of requests is the same as when you execute the request to get resource group information.

Security Administrator (View & Modify)

POST base-URL/v1/objects/ldevs/object-ID/actions/assign-virtual-ldevid/invoke

• 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 virtual LDEV number 405 for a LDEV:

  {
    "parameters": {
      "virtualLdevId": 405
    }
  }

  Attribute	Type	Description
  virtualLdevId	int	(Required) Specify the virtual LDEV number with a decimal (base 10) number. If you specify 65535, the reserved attribute of global-active device will be set.

• 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 LDEV for which the virtual LDEV number is set

GET base-URL/v1/objects/ldevs/object-ID/actions/assign-virtual-ldevid

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

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/assign-virtual-ldevid

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/assign-virtual-ldevid/invoke

Security Administrator (View & Modify)

POST base-URL/v1/objects/ldevs/object-ID/actions/unassign-virtual-ldevid/invoke

• Object ID

  Specify the ldevId value obtained by getting information about the virtual LDEV number.

  Attribute	Type	Description
  ldevId	int	(Required) Specify the LDEV number with a decimal (base 10) number.

• Query parameters

  None.

• Body

  The following coding example deletes virtual LDEV number 405:

  {
    "parameters": {
      "virtualLdevId": 405
    }
  }

  Attribute	Type	Description
  virtualLdevId	int	(Required) Specify the virtual LDEV number with a decimal (base 10) number. If you specify 65535, the reserved attribute of global-active device is canceled.

• 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 LDEV for which the virtual LDEV number is deleted

GET base-URL/v1/objects/ldevs/object-ID/actions/unassign-virtual-ldevid

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

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/unassign-virtual-ldevid

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/unassign-virtual-ldevid/invoke