Getting information about virtual LDEVs

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 about the virtual LDEVs (LDEVs to which virtual LDEV numbers have been assigned) on a virtual storage machine. If no virtual LDEVs exist in the specified range, an empty list will be returned. To get information about virtual LDEVs, use multiple query parameters so that virtual LDEVs are included.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/ldevs

Request message

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.

    Tip:

    Of the resources displayed by the filter, you can obtain information only about the resources for which you have been granted access permissions.

    For example, if you specify 10 for the count parameter and you have permission to access all virtual LDEVs, information about 10 virtual LDEVs will be obtained. If you have permission to access specific virtual LDEVs only, information will be obtained only about virtual LDEVs for which you have been granted access permissions.

    Important:

    For a VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage system, pay attention to the number of concurrent executions of this API request. For details, see "Implementing retry processing".

    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.

    • mappedNamespace

      Gets information about the virtual LDEV where the namespace is set.

      This value can be specified if the storage system is VSP 5000 series, VSP E1090, or VSP E1090H.

    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

    Y

    N

    N

    N

    N

    count

    Y

    Y

    --

    Y

    Y

    Y

    Y

    Y

    ldevOption

    Y

    Y

    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.

    • class

      Adds additional information from the storage system's cache.

      You can specify this item for VSP 5000 series.

      To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

      Immediately after you create an LDEV, if you specify class and at the same time specify defined in the query parameter ldevOption and then run the command, the volume status might be output as unimplemented. In such a case, wait a while and then run this request again. Alternatively, run the API request that updates the cache of storage system configuration information, and then run this request again.

    • qos

      Adds information about QoS settings.

    • nguId

      Adds the NGUID (Namespace Globally Unique Identifier).

      You can specify this value for VSP 5000 series, VSP E1090, VSP E1090H.

Body
None.

Response message

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

virtualModelDetail#

string

Detailed model name of the virtual storage machine

This parameter is output if the virtual storage machine is in the VSP 5000 series.

#: For virtual storage machines in the VSP 5000 series, the series name VSP 5000 series AFA or VSP 5000 series hybrid is output for the virtualModel attribute, and VSP 5100, 5500, VSP 5200, 5600, VSP 5100H, 5500H, or VSP 5200H, 5600H is output for the virtualModelDetail attribute.

If you run this request with class specified for detailInfoType in the query parameters, additional information from the storage system's cache is also obtained.

Attribute

Type

Description

virtualEmulationType

string

Virtual emulation type of the virtual LDEV

virtualSsId

int

Virtual SSID of the virtual LDEV

isVirtualCvs

boolean

Whether a virtual CVS is set for the virtual LDEV

  • true: Set
  • false: Not set

Status codes

For details on the status codes of the request for this operation, see the section explaining 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/ldevs?count=2&virtualSerialNumber=410012"