Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Volume allocation

You can assign volumes to hosts. Assigning volumes to hosts involves creating a volume that meets host requirements, configuring a port, and setting the LU path to access volumes (LDEVs) in the storage system.

Overview of volume allocation

Volume allocation means setting LU paths to allow the host to access volumes in the storage system.

In the REST API, allocate a volume by performing the following procedure:

  1. Create a volume that meets the host requirements.

    You can either use a volume that meets the requirements from an existing LDEV or create an LDEV from the parity group or pool.

    When the host is connected to the external storage system by using Universal Volume Manager, you can create an external volume from an existing external parity group (external volume group).

  2. Configure a port.

    Configure a host group or an iSCSI target for the storage system port. Register information about the host that is to access the LDEV in the host group or the iSCSI target.

    Specify the host mode and host mode options according to the host type.

  3. Set the LU path.

    Setting the LU path between the LDEV and the port's host group or iSCSI target enables access from the host to the LDEV.

GUID-DE71E4C6-74F5-44B7-8B66-F02D11D77D29-low.gif

In the preceding figure, an LDEV is created from the parity group, and the LU path is set for the host group in which the WWN of host A is registered. In addition, another LDEV is created from the DP pool, and the LU path is set for the host group in which the WWNs of host B and host C are registered. By registering the WWNs of multiple hosts in the host group, you can apply the same settings for accessing the LDEV to the hosts at the same time.

For details about the requirements for creating volumes and how to specify settings for host groups or iSCSI targets, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

Note

For host groups that use external ports or initiator ports, do not run this request from the REST API.

Getting information about the capacity of a storage system

The following request gets information about the total capacity and the size of free space of all parity groups configured in the target storage system.
Important

The size of free space (freeSpace) and the total capacity (totalCapacity) do not include the size of areas where, because of boundary limitations, volumes cannot be created. For this reason, after certain operations, such as those to create or delete volumes, the total capacity value might change. For details about volume capacity, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/total-capacities/instance
Request message
  • Object ID

    Specify a value for instance. For objects that have only one instance, the value of instance is a fixed value (the object ID).

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "internal": {
        "freeSpace": 30405195264,
        "totalCapacity": 34921689272
      },
      "external": {
        "freeSpace": 0,
        "totalCapacity": 142606336
      },
      "total": {
        "freeSpace": 30405195264,
        "totalCapacity": 35064295608
      }
    }

    Attribute

    Type

    Description

    internal

    object

    An attribute related to the capacity of internal volumes is output.

    • freeSpace (long)

      The amount of free space in which users can create volumes (KB)

    • totalCapacity (long)

      The sums of the total capacity and the size of free space of all volumes created by the user (KB)

    external

    object

    An attribute related to the capacity of external volumes is output.

    If no external volumes are connected, the value 0 is output.

    • freeSpace (long)

      The amount of free space in which users can create volumes (KB)

    • totalCapacity (long)

      The sums of the total capacity and the size of free space of all volumes created by the user (KB)

    total

    object

    An attribute related to the total capacity of internal volumes and external volumes is output.

    • freeSpace (long)

      The amount of free space in which users can create volumes (KB)

    • totalCapacity (long)

      The sums of the total capacity and the size of free space of all volumes created by the user (KB)

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 GET https://192.0.2.100/ConfigurationManager/v1/objects/total-capacities/instance

Getting information about the total efficiency of a storage system

Obtain information about the saving efficiency for consumption of capacity (total efficiency) achieved by using the functions for increasing the usage efficiency of a storage system such as the capacity saving function (dedupe and compression), the accelerated compression function, the creation of backup data by using snapshots, and the virtualization of capacity by using Dynamic Provisioning.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/total-efficiencies/instance
Request message
  • Object ID

    Specify instance. If an object has only one instance, the value for instance is the fixed value that specifies the object ID.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "isCalculated" : true,
      "totalRatio" : "8.46",
      "compressionRatio" : "1.18",
      "snapshotRatio" : "97.21",
      "provisioningRate" : "85",
      "calculationStartTime" : "2016-07-31T16:55:07Z",
      "calculationEndTime" : "2016-07-31T17:06:35Z",
      "dedupeAndCompression" : {
        "totalRatio" : "1.47",
        "compressionRatio" : "1.08",
        "dedupeRatio" : "1.35",
        "reclaimRatio" : "1.00"
      },
      "acceleratedCompression" : {
        "totalRatio" : "1.11",
        "compressionRatio" : "1.10",
        "reclaimRatio" : "1.00"
      }
    }

    Attribute

    Type

    Description

    isCalculated

    boolean

    Calculation status of the total efficiency

    This attribute indicates whether the total efficiency has been calculated.

    • true: The values have been calculated.
    • false: The values have not been calculated.

    Information about the other attributes will only be obtained if the value for this attribute is true.

    calculationStartTime

    ISO8601string

    The date and time when the calculation of the total efficiency began (UTC)

    The local time of the storage system is displayed in YYYY-MM-DDThh:mm:ssZ format.

    calculationEndTime

    ISO8601string

    The date and time when the calculation of the total efficiency ended (UTC)

    The local time of the storage system is displayed in YYYY-MM-DDThh:mm:ssZ format.

    totalRatio

    string

    The total efficiency of the entire storage system#

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

    If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

    After a volume is created from a pool and before data is written to the volume, the maximum value (92233720368547758.07) is displayed.

    compressionRatio

    string

    The efficiency of capacity saving performed by using the capacity saving function (dedupe and compression) or accelerated compression#

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

    If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

    snapshotRatio

    string

    The efficiency of capacity saving performed by using snapshots to back up data#

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

    If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

    provisioningRate

    string

    The percentage (%) of saving efficiency for consumption of capacity achieved by using Dynamic Provisioning to virtualize capacity

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

    If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

    dedupeAndCompression

    object

    Attributes related to the efficiency of capacity saving performed by using the capacity saving function (dedupe and compression) are displayed.

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

    If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

    • totalRatio (string)

      total efficiency of capacity saving performed by using the capacity saving function#

    • compressionRatio (string)

      Efficiency of capacity saving performed by using compression#

    • dedupeRatio (string)

      Efficiency of capacity saving performed by using deduplication (dedupe)#

    • reclaimRatio (string)

      Efficiency of capacity saving performed by reclaiming the specified data pattern#

    acceleratedCompression

    object

    Attributes related to the efficiency of capacity saving performed by using accelerated compression are displayed.

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    If the volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed.

    If the calculation cannot be performed for the volume because the volume is blocked or some other reason, the value from the previous calculation is displayed.

    • totalRatio (string)

      Total efficiency of capacity saving performed by using accelerated compression#

    • compressionRatio (string)

      Efficiency of capacity saving performed by using compression#

    • reclaimRatio (string)

      Efficiency of capacity saving performed by reclaiming the specified data pattern#

    #: This value represents the capacity before reduction as a ratio of the capacity after reduction, where the capacity after reduction is 1.

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/total-efficiencies/instance

Getting volume information

The following request obtains information about multiple LDEVs. You can get information about consecutive LDEVs by specifying the number of the first LDEV and the number of LDEVs. You can also get information filtered by LDEV conditions (attributes) or resource group.
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 volume information.

    • When filtering the execution result

      You can obtain information about 100 LDEVs by default, and information about 16,384 LDEVs by specifying the count parameter. If information about more than 16,384 LDEVs is obtained by specifying the ldevOption parameter or the poolId parameter, use the headLdevId parameter to obtain information about 16,385 or more LDEVs.

      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 LDEVs, information about 10 LDEVs will be obtained. If you have permission to access specific LDEVs only, information will be obtained only about 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 details on query parameters that can be specified at the same time, see the following table showing the combinations of query parameters that can be specified.

      Parameter

      Type

      Filter Condition

      count

      int

      (Optional) Specify a value from 1 to 16384 for the number of LDEVs for which information is to be obtained.

      If this parameter is omitted, information about 100 LDEVs will be obtained.

      headLdevId

      int

      (Optional) Specify the number of the LDEV from which processing to get information is to start.

      The request gets information about the LDEVs in the ascending order of LDEV numbers, starting with the specified LDEV number.

      If this parameter is omitted, 0 is assumed.

      ldevOption

      string

      (Optional) LDEV conditions for getting information

      You can specify the following conditions:

      • defined

        Gets information about implemented LDEVs.

      • undefined

        Gets information about LDEVs that are not implemented.

      • dpVolume

        Gets information about DP volumes.

      • luMapped

        Gets information about LDEVs for which LU paths are defined.

      • luUnmapped

        Gets information about LDEVs for which LU paths are undefined.

      • externalVolume

        Gets information about external volumes.

      • mappedNamespace

        Gets information about the 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 LDEVs will be obtained.

      poolId

      int

      (Optional) Pool number

      Gets information about the LDEVs that are associated with the specified pool.

      By using the ldevOption parameter when specifying conditions, the following information will 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 LDEVs that are associated with the specified pool and that have one or more LU paths defined.

      • If luUnmapped is specified for the ldevOption parameter:

        Gets information about LDEVs that are associated with the specified pool and that do not have one or more LU paths defined.

      If you specify this parameter without specifying the ldevOption parameter, the processing gets information about the volumes that make up the pool (pool volumes).

      If defined or undefined is specified for the ldevOption parameter, you cannot specify this parameter.

      resourceGroupId

      int

      (Optional) ID of the resource group to which LDEVs for which information is to be obtained belong

      journalId

      int

      (Optional) ID of the journal to which LDEVs for which information is to be obtained belong

      parityGroupId

      string

      (Optional) ID 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

      count

      head​Ldev​Id

      ldev​Option

      pool​Id

      resource​Group​Id

      journal​Id

      parity​Group​Id

      count

      --

      Y

      Y

      Y

      Y

      Y

      Y

      head​Ldev​Id

      Y

      --

      Y

      N

      N

      N

      N

      ldev​Option

      Y

      Y

      --

      Y#

      Y

      N

      N

      pool​Id

      Y

      N

      Y#

      --

      Y

      N

      N

      resource​Group​Id

      Y

      N

      Y

      Y

      --

      Y

      Y

      journal​Id

      Y

      N

      N

      N

      Y

      --

      N

      parity​Group​Id

      Y

      N

      N

      N

      Y

      N

      --

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

    • 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 LDEVs that belong to parity groups with drive type SSD(FMC).

      • externalVolume

        Adds detailed information about external volumes.

      • virtualSerialNumber

        Adds detailed information about virtual storage machines.

      • savingInfo

        Adds detailed information about the capacity saving function (dedupe and compression).

      • 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.

    Query parameters can be specified as shown in the following examples.

    • The following example retrieves information about 30 LDEVs from LDEV number 1234:
      ?headLdevId=1234&count=30
    • The following example obtains information about 30 implemented LDEVs that belong to resource group number 5:
      ?ldevOption=defined&count=30&resourceGroupId=5
    • The following example obtains information about 30 DP volumes that are associated with pool number 7, out of the LDEVs that belong to resource group number 5:
      ?ldevOption=dpVolume&pool=7&count=30&resourceGroupId=5
    • The following example retrieves information about 30 LDEVs, for which detailed information about accelerated compression is added:
      ?detailInfoType=FMC&count=30
  • Body

    None.

Response message
  • Body

    For details on attributes to be obtained in the body of the response message, see the description of the API function for getting information about a specific volume.

    {
      "data": [
        {
          "ldevId": 0,
          "clprId": 0,
          "emulationType": "OPEN-V-CVS",
          "byteFormatCapacity": "1.00 G",
          "blockCapacity": 2097152,
          "numOfPorts": 2,
          "ports": [
            {
              "portId": "CL1-A",
              "hostGroupNumber": 0,
              "hostGroupName": "1A-G00",
              "lun": 1
            },
            {
              "portId": "CL2-A",
              "hostGroupNumber": 0,
              "hostGroupName": "2A-G00",
              "lun": 1
            }
          ],
          "attributes": [
            "CVS",
            "HDP"
          ],
          "label": "JH-26216_DP",
          "status": "NML",
          "mpBladeId": 2,
          "ssid": "0012",
          "poolId": 63,
          "numOfUsedBlock": 86016,
          "isFullAllocationEnabled": false,
          "resourceGroupId": 0,
          "dataReductionStatus": "ENABLED",
          "dataReductionMode": "compression_deduplication",
          "dataReductionProcessMode" : "post_process",
          "isAluaEnabled": false
        },
        {
          "ldevId": 1,
          "clprId": 0,
          "emulationType": "OPEN-V-CVS",
          "byteFormatCapacity": "1.00 G",
          "blockCapacity": 2097152,
          "numOfPorts": 2,
          "ports": [
            {
              "portId": "CL1-A",
              "hostGroupNumber": 0,
              "hostGroupName": "1A-G00",
              "lun": 2
            },
            {
              "portId": "CL2-A",
              "hostGroupNumber": 0,
              "hostGroupName": "2A-G00",
              "lun": 2
            }
          ],
          "attributes": [
            "CVS",
            "HDP"
          ],
          "label": "JH-26216_DP",
          "status": "NML",
          "mpBladeId": 0,
          "ssid": "0012",
          "poolId": 63,
          "numOfUsedBlock": 0,
          "isFullAllocationEnabled": false,
          "resourceGroupId": 0,
          "dataReductionStatus": "DISABLED",
          "dataReductionMode": "disabled",
          "isAluaEnabled": false
        }
      ]
    }

If the LDEV is not implemented:

Attribute

Type

Description

ldevId

int

LDEV number

virtualLdevId

int

Virtual LDEV number

If the virtual LDEV number is not set, 65534 (FF:FE) is output.

If the reserved attribute of global-active device is set, 65535 (FF:FF) is output.

emulationType

string

NOT DEFINED (a value that indicates the LDEV is not implemented) is output.

ssid

string

SSID

This attribute is output only if an SSID has been set.

resourceGroupId

int

ID of the resource group to which LDEVs for which information is to be obtained belong

If the volume is an internal volume:

Attribute

Type

Description

ldevId

int

LDEV number

virtualLdevId

int

Virtual LDEV number

If the virtual LDEV number is not set, 65534 (FF:FE) is output.

If the reserved attribute of global-active device is set, 65535 (FF:FF) is output.

clprId

int

CLPR number

emulationType

string

The LDEV emulation type or the LDEV status information is output by using one of the following values:

  • NOT DEFINED: The LDEV is not implemented.
  • DEFINING: The LDEV is being created.
  • REMOVING: The LDEV is being removed.

byteFormatCapacity

string

Capacity of the LDEV

The value is output to the second decimal place.

blockCapacity

long

Number of blocks of the LDEV

numOfPorts

int

Number of ports for which a path to the LDEV is defined

If a namespace is set for the LDEV, 0 is output.

ports

object[]

For ports for which a path to the LDEV is defined, the following attributes are output.

If a namespace is set for the LDEV, this attribute is not output.

  • portId (string)

    Port number

  • hostGroupNumber (int)

    Host group number

  • hostGroupName (string)

    Host group name

    This request can obtain host group names that are no more than 16 characters. To obtain a host group name that exceeds 16 characters, run the API function for getting information about the host group or the iSCSI target.

  • lun (int)

    LUN

composingPoolId

int

Pool ID of the pool that includes the LDEV

attributes

string[]

LDEV attributes

The following attributes are output:

  • CMD: Command device (except for command devices for mainframes)
  • CLUN: Cache LUN (DCR)
  • CVS: CVS volume
  • ALUN: Volume Migration volume
  • ELUN: External volume
  • OLG: OpenLDEV Guard volume
  • VVOL: Virtual volume
  • HORC: Pair volume (P-VOL or S-VOL) for remote copy (TrueCopy,TrueCopy for Mainframe, Universal Replicator, Universal Replicator for Mainframe)
  • MRCF: ShadowImage volume (P-VOL or S-VOL)
  • HTI: Thin Image volume (P-VOL or S-VOL)
  • JNL: Journal volume
  • HDP: HDP volume or Dynamic Provisioning for Mainframe volume
  • HDT: HDT volume
  • POOL: Pool volume
  • QRD: Quorum disk
  • ENCD: Encrypted disk
  • SYSD: System disk
  • TSE: HDP volume used for FCSE
  • GAD: global-active device volume
  • T10PI: Volume for which the T10 PI attribute is enabled
  • RCMD: Remote command device
  • ESE: Virtual volume capable of page release by the User Directed Space Release function

raidLevel

string

RAID level

raidType

string

Drive configuration

numOfParityGroups

int

Number of parity groups to which the LDEV belongs

parityGroupIds

string[]

Parity group to which the LDEV belongs

driveType

string

Code indicating the drive type of the drive belonging to the LDEV

driveByteFormatCapacity

string

Capacity of the drive belonging to the LDEV

The value is output to the second decimal place.

driveBlockCapacity

long

Number of blocks of the drive belonging to the LDEV

label

string

Label of the LDEV

status

string

Status of the LDEV

  • NML: The LDEV is in normal status.
  • BLK: The LDEV is blocked.
  • BSY: The LDEV status is being changed.
  • Unknown: The LDEV status is unknown (not supported).

operationType

string

The operation in progress:

  • FMT: Formatting is in progress.
  • QFMT: Quick formatting is in progress.
  • CCOPY: Collection copying is in progress.
  • CACCS: Collection access is in progress.
  • SHRD: Shredding is in progress.
  • ZPD: Pages are being released.
  • SHRPL: Deletion from the pool is in progress.
  • RLC: Pools are being reallocated.
  • RBL: Pools are being rebalanced.

preparingOperationProgressRate

int

Progress of formatting or shredding

For cases other than above, 100 is output.

mpBladeId

int

MP blade ID

ssid

string

SSID

This attribute is output only if an SSID has been set.

resourceGroupId

int

ID of the resource group

isAluaEnabled

boolean

Whether the ALUA (Asymmetric Logical Unit Access) attribute is enabled

  • true: The ALUA attribute is enabled.
  • false: The ALUA attribute is disabled.

namespaceId

string

Namespace ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and a namespace is set for the LDEV.

nvmSubsystemId

string

NVM subsystem ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and an NVM subsystem is set for the LDEV.

If the volume is an external volume:

Attribute

Type

Description

ldevId

int

LDEV number

virtualLdevId

int

Virtual LDEV number

If the virtual LDEV number is not set, 65534 (FF:FE) is output.

If the reserved attribute of global-active device is set, 65535 (FF:FF) is output.

clprId

int

CLPR number

emulationType

string

The LDEV emulation type or the LDEV status information is output by using one of the following values:

  • NOT DEFINED: The LDEV is not implemented.
  • DEFINING: The LDEV is being created.
  • REMOVING: The LDEV is being removed.

byteFormatCapacity

string

Capacity of the LDEV

The value is output to the second decimal place.

blockCapacity

long

Number of blocks of the LDEV

numOfPorts

int

Number of ports for which a path to the LDEV is defined

If a namespace is set for the LDEV, 0 is output.

ports

object[]

For ports for which a path to the LDEV is defined, the following attributes are output.

If a namespace is set for the LDEV, this attribute is not output.

  • portId (string)

    Port number

  • hostGroupNumber (int)

    Host group number

  • hostGroupName (string)

    Host group name

    This request can obtain host group names that are no more than 16 characters. To obtain a host group name that exceeds 16 characters, run the API function for getting information about the host group or the iSCSI target.

  • lun (int)

    LUN

composingPoolId

int

Pool ID of the pool that includes the LDEV

attributes

string[]

LDEV attributes

The following attributes are output:

  • CMD: Command device (except for command devices for mainframes)
  • CLUN: Cache LUN (DCR)
  • CVS: CVS volume
  • ALUN: Volume Migration volumes
  • ELUN: External volume
  • OLG: OpenLDEV Guard volume
  • VVOL: Virtual volume
  • HORC: Pair volume (P-VOL or S-VOL) for remote copy (TrueCopy, TrueCopy for Mainframe, Universal Replicator, Universal Replicator for Mainframe)
  • MRCF: ShadowImage volume (P-VOL or S-VOL)
  • HTI: Thin Image volume (P-VOL or S-VOL)
  • JNL: Journal volume
  • HDP: HDP volume or Dynamic Provisioning for Mainframe volume
  • HDT: HDT volume
  • POOL: Pool volume
  • QRD: Quorum disk
  • ENCD: Encrypted disk
  • SYSD: System disk
  • TSE: HDP volume used for FCSE
  • GAD: global-active device volume
  • MG: Volume used for data migration
  • ESE: Virtual volume capable of page release by the User Directed Space Release function

label

string

Label of the LDEV

status

string

Status of the LDEV

  • NML: The LDEV is in normal status.
  • BLK: The LDEV is blocked.
  • BSY: The LDEV status is being changed.
  • Unknown: The LDEV status is unknown (not supported).

operationType

string

The operation in progress:

  • FMT: Formatting is in progress.
  • QFMT: Quick formatting is in progress.
  • CCOPY: Collection copying is in progress.
  • CACCS: Collection access is in progress.
  • SHRD: Shredding is in progress.
  • ZPD: Pages are being released.
  • SHRPL: Deletion from the pool is in progress.
  • RLC: Pools are being reallocated.
  • RBL: Pools are being rebalanced.

preparingOperationProgressRate

int

Progress of formatting or shredding

For cases other than above, 100 is output.

mpBladeId

int

MP blade ID

ssid

string

SSID

This attribute is output only if an SSID has been set.

resourceGroupId

int

ID of the resource group

externalVendorId

string

Vendor information in SCSI information for the external volume

externalProductId

string

Storage system that is connected using the external storage connection functionality of Universal Volume Manager

externalVolumeId

string

Device identification information in SCSI information for the external volume (output in hexadecimal number format)

externalVolumeIdString

string

Device identification information in SCSI information for the external volume (output in ASCII format)

numOfExternalPorts

int

Number of alternate paths

externalPorts

object[]

For the defined alternate paths, the following attributes are output:

  • portId (string)

    Port number

  • hostGroupNumber (int)

    This attribute is currently not in use. 0 is always displayed for this attribute.

  • lun (int)

    LUN

  • wwn (string)

    WWN

quorumDiskId

int

ID of the Quorum disk

This attribute is output only if the external volume is a Quorum disk of the global-active device.

quorumStorageSerialNumber

string

Device number of the Quorum disk

This attribute is output only if the external volume is a Quorum disk of the global-active device.

quorumStorageTypeId

string

ID for identifying the Quorum disk device

This attribute is output only if the external volume is a Quorum disk of the global-active device.

R7: Virtual Storage Platform

R8: VSP G1000, VSP G1500, VSP F1500

R9: VSP 5000 series

M7: HUS VM

M8: VSP E series, VSP Gx00 models, VSP Fx00 models

isAluaEnabled

boolean

Whether the ALUA attribute is enabled:

  • true: The ALUA attribute is enabled.
  • false: The ALUA attribute is disabled.

namespaceId

string

Namespace ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and a namespace is set for the LDEV.

nvmSubsystemId

string

NVM subsystem ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and an NVM subsystem is set for the LDEV.

If the volume is a virtual volume:

Attribute

Type

Description

ldevId

int

LDEV number

virtualLdevId

int

Virtual LDEV number

If the virtual LDEV number is not set, 65534 (FF:FE) is output.

If the reserved attribute of global-active device is set, 65535 (FF:FF) is output.

clprId

int

CLPR number

emulationType

string

The LDEV emulation type or the LDEV status information is output by using one of the following values:

  • NOT DEFINED: The LDEV is not implemented.
  • DEFINING: The LDEV is being created.
  • REMOVING: The LDEV is being removed.

byteFormatCapacity

string

Capacity of the LDEV

The value is output to the second decimal place.

blockCapacity

long

Number of blocks of the LDEV

numOfPorts

int

Number of ports for which a path to the LDEV is defined

If a namespace is set for the LDEV, 0 is output.

ports

object[]

For ports for which a path to the LDEV is defined, the following attributes are output.

If a namespace is set for the LDEV, this attribute is not output.

  • portId (string)

    Port number

  • hostGroupNumber (int)

    Host group number

  • hostGroupName (string)

    Host group name

    This request can obtain host group names that are no more than 16 characters. To obtain a host group name that exceeds 16 characters, run the API function for getting information about the host group or the iSCSI target.

  • lun (int)

    LUN

attributes

string[]

LDEV attributes

The following attributes are output:

  • CMD: Command device (except for command devices for mainframes)
  • CLUN: Cache LUN (DCR)
  • CVS: CVS volume
  • ALUN: Volume Migration volume
  • ELUN: External volume
  • OLG: OpenLDEV Guard volume
  • VVOL: Virtual volume
  • HORC: Pair volume (P-VOL or S-VOL) for remote copy (TrueCopy, TrueCopy for Mainframe , Universal Replicator, Universal Replicator for Mainframe)
  • MRCF: ShadowImage volume (P-VOL or S-VOL)
  • HTI: Thin Image volume (P-VOL or S-VOL)
  • JNL: Journal volume
  • HDP: HDP volume or Dynamic Provisioning for Mainframe volume
  • HDT: HDT volume
  • POOL: Pool volume
  • DRS: Data reduction shared volume
  • QRD: Quorum disk
  • ENCD: Encrypted disk
  • SYSD: System disk
  • TSE: HDP volume used for FCSE
  • GAD: global-active device volume
  • DSD: Deduplication system data volume (fingerprint)
  • DS: Deduplication system data volume (data store)
  • MG: Volume used for data migration
  • ESE: Virtual volume capable of page release by the User Directed Space Release function

label

string

Label of the LDEV

status

string

Status of the LDEV

  • NML: The LDEV is in normal status.
  • BLK: The LDEV is blocked.
  • BSY: The LDEV status is being changed.
  • Unknown: The LDEV status is unknown (not supported).

operationType

string

The operation in progress:

  • FMT: Formatting is in progress.
  • QFMT: Quick formatting is in progress.
  • CCOPY: Collection copying is in progress.
  • CACCS: Collection access is in progress.
  • SHRD: Shredding is in progress.
  • ZPD: Pages are being released.
  • SHRPL: Deletion from the pool is in progress.
  • RLC: Pools are being reallocated.
  • RBL: Pools are being rebalanced.

preparingOperationProgressRate

int

Progress of formatting or shredding

For cases other than above, 100 is output.

mpBladeId

int

MP blade ID

ssid

string

SSID

This attribute is output only if an SSID has been set.

poolId

int

ID of the pool with which the LDEV is associated

  • For DP volumes: ID of the associated DP pool
  • For virtual volumes for Thin Image: ID of the pool in which the snapshot data was created

numOfUsedBlock

long

Number of blocks used in the pool.

This includes the number of blocks whose pages are reserved by the Full Allocation functionality.

resourceGroupId

int

ID of the resource group

snapshotPoolId

int

ID of the pool in which the snapshot data was created

This attribute is output when the LDEV is both an S-VOL of a Thin Image pair and an HDP volume.

isRelocationEnabled

boolean

Status of relocation

  • true: Relocation is enabled.
  • false: Relocation is stopped.

tierLevel

string

Tiering policy used for relocation

  • all: All tiers are used for relocation (level 0)
  • 1 to 5: Relocation is performed by following the tiering policy (levels 1 to 5)
  • 6 to 31: Relocation is performed by following the tiering policy (custom policy)

usedCapacityPerTierLevel1

long

Capacity allocated to tier 1 (in MB)

usedCapacityPerTierLevel2

long

Capacity allocated to tier 2 (in MB)

usedCapacityPerTierLevel3

long

Capacity allocated to tier 3 (in MB)

tierLevelForNewPageAllocation

string

New page assignment tier

  • H: The page is allocated to a higher-level tier (High)
  • M: The page is allocated to a middle-level tier (Middle)
  • L: The page is allocated to a lower-level tier (Low)

tier1AllocationRateMin

int

Minimum capacity of tier 1 of the set tiering policy

tier1AllocationRateMax

int

Maximum capacity of tier 1 of the set tiering policy

tier3AllocationRateMin

int

Minimum capacity of tier 3 of the set tiering policy

tier3AllocationRateMax

int

Maximum capacity of tier 3 of the set tiering policy

fullAllocationCapacity

long

Capacity for which pages are reserved by the Full Allocation functionality (in MB)

isFullAllocationEnabled

boolean

Whether pages are reserved by the Full Allocation functionality

  • true: The page reservation setting is enabled.
  • false: The page reservation setting is disabled.

dataReductionMode

string

Setting of the capacity saving function (dedupe and compression)

  • compression: The capacity saving function (compression) is enabled.
  • compression_deduplication: The capacity saving function (compression and deduplication) is enabled.
  • disabled: The capacity saving function (compression and deduplication) is disabled.

dataReductionProcessMode

string

Capacity-saving mode

  • post_process: Post-process mode
  • inline: Inline mode

This attribute is displayed for volumes for which the capacity saving function is enabled.

isCompressionAccelerationEnabled

boolean

Whether the compression accelerator of the capacity saving function (dedupe and compression) is enabled#1

  • true: Enabled
  • false: Disabled

This attribute is displayed for volumes for which the capacity saving function is enabled and that are in a storage system for which a compression accelerator is enabled.

dataReductionStatus

string

Status of the capacity saving function

  • ENABLED: The capacity saving function is enabled.
  • DISABLED: The capacity saving function is disabled.
  • ENABLING: The capacity saving function is being enabled.
  • REHYDRATING: The capacity saving function is being disabled.
  • DELETING: The volumes for which the capacity saving function is enabled are being deleted.
  • CONVERTING: The capacity saving function that uses a compression accelerator is being enabled or disabled.#1
  • FAILED: An attempt to enable the capacity saving function failed.

dataReductionProgressRate

int

Progress rate of the capacity saving function (%)

This attribute is output when one of the following is output for the dataReductionStatus attribute.

ENABLING, REHYDRATING, DELETING, CONVERTING#1

compressionAccelerationStatus

string

Status of the capacity saving function that uses a compression accelerator#1

  • ENABLED: The capacity saving function that uses a compression accelerator is enabled.
  • DISABLED: The capacity saving function that uses a compression accelerator is disabled.
  • HYBRID#2: The volume contains both data for which the capacity saving function that uses a compression accelerator is enabled and data for which the capacity saving function that uses a compression accelerator is disabled.

    HYBRID is displayed for the dataReductionStatus attribute even if the status is CONVERTING.

This attribute is displayed for volumes for which the capacity saving function is enabled and that are in a storage system for which a compression accelerator is enabled.

isAluaEnabled

boolean

Whether the ALUA attribute is enabled:

  • true: The ALUA attribute is enabled.
  • false: The ALUA attribute is disabled.

namespaceId

string

Namespace ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and a namespace is set for the LDEV.

nvmSubsystemId

string

NVM subsystem ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and an NVM subsystem is set for the LDEV.

#1 If you enabled the capacity saving function that uses a compression accelerator by running the API request to change volume settings, check whether the settings have been changed successfully based on the following attributes.

  • The dataReductionStatus attribute: If the value is CONVERTING, the capacity saving function that uses a compression accelerator is being enabled or disabled.
  • The isCompressionAccelerationEnabled attribute: If the value is true, the setting is being changed from disabled to enabled.

If the values of these attributes are as follows, this indicates that the capacity saving function that uses a compression accelerator has been enabled.

  • dataReductionStatus: ENABLED
  • isCompressionAccelerationEnabled: true

If the capacity saving function that uses a compression accelerator setting does not change, perform the following steps:

  • If the value of the dataReductionStatus attribute does not change to CONVERTING, the relevant volume or hardware is not in a state where the setting can be changed. Check whether the volume or hardware is in a state where the setting can be changed by referring to the Provisioning Guide for Open Systems, or the Provisioning Guide.
  • If the value of the dataReductionStatus attribute is CONVERTING and the value of the dataReductionProgressRate attribute (the progress rate) does not change, a compression accelerator might be blocked. Use the API request for acquiring a list of alert information to check whether a compression accelerator is blocked. If it is not blocked, refer to the troubleshooting section of the Provisioning Guide for Open Systems, or the Provisioning Guide.

#2 Of the volumes in a pool, if the capacity saving function that uses a compression accelerator is enabled for even one volume for which deduplication is enabled, the capacity saving function that uses a compression accelerator will be enabled for the duplicate data in that pool. For this reason, for a volume for which the capacity saving function that uses a compression accelerator is disabled, the capacity saving function that uses a compression accelerator will be enabled for some data in the volume and disabled for other data in the volume, depending on whether the data is duplicated. As a result, the value of the compressionAccelerationStatus attribute is HYBRID.

If the volume is a Thin Image P-VOL:

In addition to the attributes output if the volume is an internal volume, the following attribute is obtained.

Attribute

Type

Description

usedCapacityForSnapshot

long

Capacity used for snapshots in a Thin Image P-VOL (in MB)

The snapshot capacity that is allocated from the pool and used as data is output.

For the root volume of a snapshot tree, the snapshot capacity of the root volume is output.

usedTotalCapacityForSnapshot

long

Capacity of all snapshots that are allocated from the pool used by the root volume (in MB)

This attribute is output for VSP 5000 series.

This attribute is output when a Thin Image root volume is used.

This value includes the volume of metadata and garbage data generated by the storage system.

garbageDataCapacityForSnapshot

long

Volume of snapshot garbage data (in MB)

This attribute is output for VSP 5000 series.

This attribute is output when a Thin Image root volume is used, if the processing to delete snapshot garbage data is not in progress.

If the volume is less than 1 MB, this value is rounded up.

This attribute is not output when a Thin Image Advanced root volume is used.

deletingGarbageDataStatusForSnapshot

string

Deletion status of snapshot garbage data

This attribute is output for VSP 5000 series.

This attribute is output when a Thin Image root volume is used.

  • PROCESSING: The deletion processing is in progress
  • STOPPING: The deletion process is stopped
  • NONE: The deletion processing is not in progress

This attribute is not output when a Thin Image Advanced root volume is used.

deletingGarbageDataProgressRateForSnapshot

int

Progress of the processing for deleting snapshot garbage data (%)

This attribute is output for VSP 5000 series.

This attribute is output when a Thin Image root volume is used, if snapshot garbage data is in the process of being deleted.

This attribute is not output when a Thin Image Advanced root volume is used.

If the drive type of the parity group to which the volumes belong is SSD(FMC):

Specify FMC for the detailInfoType query parameter, and then run the request to obtain additional detailed information for accelerated compression.

{
  "data": [
    {
      "ldevId": 280,
      ...
      ...
      "isExpandedSpaceUsed": true
    }
  ]
}

Attribute

Type

Description

isExpandedSpaceUsed

boolean

Indicates whether the LDEV uses the expanded area.

  • true: The LDEV uses the expanded area.
  • false:The LDEV uses the physical area.

If the volume is an external volume:

Specify externalVolume for the detailInfoType query parameter, and then run the request to obtain additional detailed information for the external volume.

Attribute

Type

Description

externalStorageSerialNumber

string

Serial number of the storage system that is connected using the external storage connection functionality of Universal Volume Manager

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

virtualSerialNumber

string

Serial number of the virtual storage machine

virtualModel#

string

Model name of the virtual storage machine

virtualModelDetail#

string

Detailed model name of the virtual storage machine

This attribute 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 the request with savingInfo specified for the detailInfoType query parameter, the request also obtains detailed information about the capacity saving function for the volumes for which the capacity saving function is enabled.

In the case of a Thin Image Advanced pair, the request obtains detailed information of the snapshot tree root volume only.

{
  "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 data) 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

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

isDataDirectMapping

boolean

Whether the data direct mapping attribute is enabled

  • true: Enabled
  • false: Disabled

dataDirectMappingLdevId

int

LDEV number of the volume mapped by using data direct mapping

This information is output if a volume exists that is mapped by using data direct mapping.

This information is output when the value of the isDataDirectMapping attribute is true.

  • If the volume is an HDP volume: LDEV number of the pool volume
  • If the volume is a pool volume: LDEV number of the HDP volume

If no volume mapped by using data direct mapping exists, -1 is output, indicating an invalid value.

slotSize

long

Slot size (KB)

cacheResidencyMode

string

Cache residency mode

Unknown is always output.

readOnly

boolean

This attribute is currently not in use. false is always output.

usedCapacity

long

Used capacity of the DP volume (KB)

This information is output if the volume is a DP volume.

The used capacity that is output includes the capacity for which pages are reserved.

relocationPriority

string

Relocation priority

This information is output if the volume is an HDT volume.

  • Default: No priority is set.
  • Prioritized: Data is relocated preferentially when tier relocation is performed.

conglomerateLunDevice

string

Whether the volume is an ALU or an SLU

  • ALU
  • SLU
  • Unknown: Status unknown (unsupported)

commandDevice

object

Attributes related to the command device

This information is output when the volume is used as a command device.

  • isSecurityEnabled (boolean)

    Whether the security setting for the command device is enabled

    • true: Enabled
    • false: Disabled
  • isUserAuthenticationEnabled (boolean)

    Whether the user authentication setting for the command device is enabled

    • true: Enabled
    • false: Disabled
  • isDeviceGroupDefinitionEnabled (boolean)

    Whether the device group information authentication setting for the command device is enabled

    • true: Enabled
    • false: Disabled

externalDriveTypeName

string

Drive type of the external volume

  • SAS
  • SATA
  • BD
  • SSD
  • SCM
  • Unknown: Status unknown (unsupported)

If the information cannot be obtained, Unknown is output.

guardStatuses

string[]

Attribute related to access to the volume

  • Read/Write: The volume can be read and written to from all hosts.
  • Read Only: The volume can be read, but cannot be written to, from all hosts.
  • Protect: The volume cannot be read or written to from any host.
  • S-VOL Disable: Access to the secondary volume is not permitted.
  • Invisible: Invisible mode (Access via a SCSI command is not permitted.)
  • Zero Read Capacity: Zero Read Capacity mode (0 is returned as the response to a SCSI command.)
  • Unknown: Status unknown

If you run this request with qos specified for detailInfoType in the query parameters, information about QoS settings is also obtained.

Attribute

Type

Description

qos

object

Information about QoS settings

If QoS settings are configured, the following information is output.

  • upperIops (long)

    Upper limit on the IOPS

  • upperTransferRate (int)

    Upper limit on the amount of data that can be transferred per second (in MB)

  • upperAlertAllowableTime (int)

    Amount of time to wait before issuing an alert when the IOPS or the amount of data transferred per second exceeds the upper limit for a continuous period of time (in seconds)

  • upperAlertTime (ISO8601string)

    Time when the last alert was issued because the IOPS or the amount of data transferred per second had exceeded the upper limit for a continuous period of time (UTC)

    This parameter is output in the format YYYY-MM-DDThh:mm:ssZ.

  • lowerIops (long)

    Lower limit on the IOPS

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • lowerTransferRate (int)

    Lower limit on the amount of data that can be transferred per second (in MB)

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • lowerAlertAllowableTime (int)

    Amount of time to wait before issuing an alert when the IOPS or the amount of data transferred per second falls below the lower limit for a continuous period of time (in seconds)

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • lowerAlertTime (ISO8601string)

    Time when the last alert was issued because the IOPS or the amount of data transferred per second had fallen below the lower limit for a continuous period of time

    This parameter is output in the format YYYY-MM-DDThh:mm:ssZ.

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • responsePriority (int)

    Priority level of the I/O processing

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • targetResponseTime (int)

    Target response time (in milliseconds) based on the priority level (responsePriority)

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • responseAlertAllowableTime (int)

    Amount of time to wait before issuing an alert when the response time exceeds the target response time for a continuous period of time (in seconds)

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • responseAlertTime (ISO8601string)

    Time when the last alert was issued because the response time had exceeded the target response time for a continuous period of time (UTC)

    This parameter is output in the format YYYY-MM-DDThh:mm:ssZ.

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

If you run this request with nguId specified for detailInfoType in the query parameters, information about NGUID settings is also obtained.

Attribute

Type

Description

nguId

string

Namespace identifier information

This attribute is not output if the namespace is not set.

If the namespace is set but the NGUID cannot be obtained, Unknown is output.

Status codes

For details on the status codes for the request of 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?headLdevId=0&count=2"

Getting information about a specific volume

The following request gets information about a specific LDEV by specifying the LDEV number.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/ldevs/object-ID
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

    None.

Response message
  • Body

    {
      "ldevId": 1,
      "clprId": 0,
      "emulationType": "OPEN-V-CVS",
      "byteFormatCapacity": "1.00 G",
      "blockCapacity": 2097152,
      "numOfPorts": 2,
      "ports": [
        {
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "1A-G00",
          "lun": 1
        },
        {
          "portId": "CL2-A",
          "hostGroupNumber": 0,
          "hostGroupName": "2A-G00",
          "lun": 1
        }
      ],
      "attributes": [
        "CVS",
        "HDP"
      ],
      "label": "JH-26216_DP",
      "status": "NML",
      "mpBladeId": 2,
      "ssid": "0012",
      "poolId": 63,
      "numOfUsedBlock": 86016,
      "isFullAllocationEnabled": false,
      "resourceGroupId": 0,
      "dataReductionStatus": "ENABLED",
      "dataReductionMode": "compression_deduplication",
      "dataReductionProcessMode" : "post_process",
      "isAluaEnabled": false
      "naaId": "60060e8006cf2e000000cf2e00000000"
    }

    The following attribute is output in addition to the attributes output from the API of getting volume information.

    Attribute

    Type

    Description

    naaId

    string

    The NAA ID of the volume whose LU path was specified is output.

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/1

Creating a volume

The following request creates a volume by using the specified parity groups or pools. Specify a parity group for creating a basic volume, an external parity group (external volume group) for creating the external volume, and a pool for creating a virtual volume (a DP volume or a virtual volume for Thin Image).
Tip

If you want to simultaneously execute multiple requests for creating DP volumes, we recommend that you execute the corresponding jobs in parallel by specifying true for the isParallelExecutionEnabled attribute. If you do not specify this setting, the jobs will be executed sequentially, which takes more time than parallel execution.

Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/ldevs
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    The following coding example creates an LDEV (basic volume) by specifying the parity group:

    {
      "ldevId": 0,
      "parityGroupId": "1-1",
      "byteFormatCapacity": "1G"
    }
    

    The following coding example creates an external volume by specifying an external parity group:

    {
      "ldevId": 3,
      "externalParityGroupId": "1-1",
      "byteFormatCapacity": "1G"
    }

    The following coding example creates a DP volume for which the capacity saving function (dedupe and compression) is enabled by specifying a pool:

    {
      "ldevId": 1,
      "poolId": 0,
      "byteFormatCapacity": "1G",
      "dataReductionMode": "compression_deduplication"
    }

Attribute

Type

Description

ldevId

int

(Optional) Specify an LDEV number that is not implemented with a decimal (base 10) number.

This attribute cannot be specified at the same time as the isParallelExecutionEnabled attribute.

If this attribute is omitted, the minimum LDEV number that is not implemented is assumed.

isParallelExecutionEnabled

boolean

(Optional) If you want to execute multiple requests at the same time, specify whether to execute the corresponding jobs in parallel.

You can specify this attribute only when you are creating DP volumes.

  • true: Execute jobs in parallel.
  • false: Do not execute jobs in parallel. (Execute jobs sequentially.)

If this attribute is omitted, the value false is assumed.

If you specify the ldevId attribute, parityGroupId attribute, or externalParityGroupId attribute, you cannot specify this attribute.

If you specify this attribute, an unused LDEV number is automatically assigned to the created LDEV.

If there are LDEV numbers that cannot be used, exclude those numbers by using the startLdevId and endLdevId attributes.

isDataReductionSharedVolumeEnabled

boolean

(Optional) Specify whether to create a data reduction shared volume.

You can specify this attribute for VSP 5000 series.

If you want to create a volume for Thin Image Advanced, specify true.

  • true: Creates a volume.#1
  • false: Does not create a volume.

If you specify true, you must also specify the poolId attribute. If this attribute is omitted, the value false is assumed.

startLdevId

int

(Optional) The first LDEV number in the range of LDEV numbers to be automatically assigned, if such a range is specified

You can specify this attribute if the isParallelExecutionEnabled attribute is set to true. If you specify this attribute, you must also specify the endLdevId attribute. The value of this attribute must be smaller than that of the endLdevId attribute.

endLdevId

int

(Optional) The last LDEV number in the range of LDEV numbers to be automatically assigned, if such a range is specified

You can specify this attribute if the isParallelExecutionEnabled attribute is set to true. If you specify this attribute, you must also specify the startLdevId attribute. The value of this attribute must be greater than that of the startLdevId attribute.

parityGroupId

string

(Optional) Parity group number

Be sure to specify this attribute when creating an LDEV (basic volume).

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"

If you specify the isParallelExecutionEnabled attribute, you cannot specify this attribute.

externalParityGroupId

string

(Optional) External parity group number

Be sure to specify this attribute when creating an external volume.

If you specify the isParallelExecutionEnabled attribute, you cannot specify this attribute.

poolId

int

(Optional) Pool number

Be sure to specify this item when creating a virtual volume from a pool.

  • To create a DP volume: For the DP pool number, specify a decimal (base 10) number equal to or greater than 0.

  • To create a virtual volume for Thin Image (excluding Thin Image Advanced): Specify -1.

For the VSP 5000 series, if you specify true for the isDataReductionSharedVolumeEnabled attribute, you must specify this attribute. In such cases, you can specify only the pool number of an HDP pool.#2

dataReductionMode

string

(Optional) Whether to enable the capacity saving function (dedupe and compression)

If you enable this attribute, a DP volume for which the capacity saving function (compression or deduplication) is enabled is created.

The specifiable values are as follows:

  • compression: Enable the capacity saving function (compression)
  • compression_deduplication: Enable the capacity saving function (compression and deduplication)
  • disabled: Disable the capacity saving function (compression and deduplication)

If you specify compression or compression_deduplication and the storage system is one for which a compression accelerator can be used, the capacity saving function that uses a compression accelerator will be automatically enabled.

The values are not case sensitive.

For VSP 5000 series

  • If this attribute is omitted when the isDataReductionSharedVolumeEnabled attribute is false, the value disabled is assumed.

  • If this attribute is omitted when the isDataReductionSharedVolumeEnabled attribute is true, the value compression_deduplication is assumed.

  • If the isDataReductionSharedVolumeEnabled attribute is true, you cannot specify disabled.

For other storage systems

If this attribute is omitted, disabled will be set.

isCompressionAccelerationEnabled

boolean

(Optional) Whether to enable the compression accelerator of the capacity saving function (dedupe and compression)

  • true: Enable
  • false: Disable

If you enable the capacity saving function and the storage system is one for which a compression accelerator can be used, the capacity saving function that uses a compression accelerator will be enabled even if you omit this attribute.

If you specify this attribute and simultaneously execute multiple requests, the corresponding jobs will be executed in parallel.

byteFormatCapacity

string

(Optional) Capacity of the volume to be created, and the unit of the capacity.

You must specify either this attribute or the blockCapacity attribute.

The following units can be specified:

  • T or t
  • G or g
  • M or m
  • K or k

To allocate all free space, specify "all".

The following is an example of specifying a capacity of 1 GB:

"byteFormatCapacity":"1G"

blockCapacity

long

(Optional) Capacity of the volume to be created in blocks (1 block = 512 bytes).

You must specify either this attribute or the byteFormatCapacity attribute.

The following is an example of specifying a capacity of 1 GB:

"blockCapacity":2097152

#1: An error might occur while a volume is being created internally on the storage system and the data reduction shared volume might not be able to be created. Get information about the volume to check the volume status. If the following conditions indicating a normal status are not met, delete the relevant volume.

  • Conditions for a normal status:

    • The value of the status attribute is NML (normal status).

    • The value of the dataReductionStatus attribute is ENABLED (the capacity saving function is enabled).

    • If the compression accelerator is enabled, the value of the isCompressionAccelerationEnabled attribute is true (enabled).

#2: You cannot create a data reduction shared volume from pools other than an HDP pool. In addition, you can create a data reduction shared volume only when all of the volumes that make up an HDP pool are SSD-type volumes (volumes implemented in a parity group that uses an SSD drive).

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 created volume

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/ldevs

Formatting a volume

The following request formats an LDEV (basic volume) or DP volume.
Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/ldevs/object-ID/actions/format/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

    {
      "parameters": {
        "operationType": "FMT"
      }
    }

    Attribute

    Type

    Description

    operationType

    string

    (Required) Format type.

    The specifiable types are as follows:

    FMT: Normal formatting

    QFMT: Quick formatting

    For a DP volume for which the capacity saving function (dedupe and compression) is enabled, you must specify FMT.

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 formatted volume

Action template

GET base-URL/v1/objects/ldevs/object-ID/actions/format
Status codes

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.

Status code

Message

Description

412

Precondition Failed

The specified action cannot run because the volume meets one of the following conditions:

  • 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 pool 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/format

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/format/invoke
When forcibly formatting the DP volume for which the capacity saving function (dedupe and compression) is enabled:
Note

The formatting of deduplicated data might take some time. Be sure to take this into account when planning when to format such data. In addition, use the status of the target resource rather than the status of the job to check whether the data has been formatted.

When format the DP volume for which the capacity saving function (compression or deduplication) is enabled, in the request body, specify FMT for the operationType attribute, and true for the isDataReductionForceFormat attribute.

The following coding example forcibly formats the DP volume for which the capacity saving function (compression or deduplication) is enabled:

{
  "parameters": {
    "operationType": "FMT",
    "isDataReductionForceFormat": true
  }
}

Attribute

Type

Description

isDataReductionForceFormat

boolean

(Optional) Specify whether to forcibly format the DP volume for which the capacity saving function (compression or deduplication) is enabled.

  • true: Format forcibly
  • false: Do not format forcibly

When the attribute is omitted, false is assumed.

Expanding the capacity of a volume

The following request expands the capacity of a DP volume.
Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/ldevs/object-ID/actions/expand/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

    When specifying in bytes:

    {
      "parameters": {
        "additionalByteFormatCapacity": "1G"
      }
    }

    When specifying in blocks:

    {
      "parameters": {
        "additionalBlockCapacity": 2097152
      }
    }

    Attribute

    Type

    Description

    additionalByteFormatCapacity

    string

    (Optional) The capacity to be added and its unit.

    You must specify either additionalByteFormatCapacity or additionalBlockCapacity.

    The specifiable units are as follows:

    • T or t
    • G or g
    • M or m
    • K or k

    The following is an example of specifying a capacity of 1 GB:

    "additionalByteFormatCapacity":"1G"

    additionalBlockCapacity

    long

    (Optional) The capacity to be added in blocks (1 block = 512 bytes).

    You must specify either additionalByteFormatCapacity or additionalBlockCapacity.

    The following is an example of specifying a capacity of 1 GB:

    "additionalBlockCapacity":2097152

    enhancedExpansion

    boolean

    (Optional) Whether to expand the capacity of the volumes used by the copy pair.

    For a data reduction shared volume, always specify true.

    • true: Expand the volumes.
    • false: Do not expand the volumes used by the copy pair.

    If you do not specify a value, false is assumed.

    The capacity of volumes can be expanded if the status of the pair is PSUS or SSUS. For information on other prerequisite conditions and the workflow, see the manual of each software product.

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 expanded volume

Action template

GET base-URL/v1/objects/ldevs/object-ID/actions/expand
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 specified LDEV is not a DP 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/expand

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/expand/invoke

Changing the volume settings

The following request sets the label for the specified volume, tier relocation of HDT volumes, and whether page reservations are enabled for DP volumes.
Execution permission

Storage Administrator (Provisioning)

Request line
PATCH base-URL/v1/objects/ldevs/object-ID
Request message
  • Object ID

    Specify the value of ldevId that was obtained by the processing to get 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 shows an example of code for changing the label for a volume:

    {
      "label": "REST_API_10GVolume"
    }

    The following shows an example of code for setting tier relocation and the new page assignment tier:

    {
      "isRelocationEnabled": true,
      "tierLevelForNewPageAllocation": "L"
    }

    The following shows an example of code for setting the tiering policy (already defined):

    {
      "tieringPolicy": {
        "tierLevel": 2
      }
    }

    The following shows an example of code for setting the tiering policy (custom policy):

    {
      "tieringPolicy": {
        "tierLevel": 23,
        "tier1AllocationRateMin": 20,
        "tier1AllocationRateMax": 40,
        "tier3AllocationRateMin": 10,
        "tier3AllocationRateMax": 40
      }
    }

    The following shows an example of code for enabling the page reservation setting:

    {
      "isFullAllocationEnabled": true
    }

    The following shows an example of code for enabling the capacity saving function (dedupe and compression):

    {
      "dataReductionMode": "compression_deduplication"
    }

    Attribute

    Type

    Description

    label

    string

    (Optional) Label to be set for the volume

    Specify a label consisting of 0 to 32 characters. You can use the following characters.

    • Alphanumeric characters
    • The following symbols:

      ! # $ % & ' ( ) + , - . : = @ [ ] ^ _ ` { } ~ / \

      You can specify a hyphen as the first character of the value.

    • Spaces

      The label cannot start or end with a space.

    dataReductionMode

    string

    (Optional) Specify whether to enable the capacity saving function (dedupe and compression)

    If you enable this attribute, the capacity saving function (compression or deduplication) of the DP volume is enabled.

    The specifiable values are as follows:

    • compression: Enable the capacity saving function (compression)
    • compression_deduplication: Enable the capacity saving function (compression and deduplication)
    • disabled: Disable the capacity saving function (compression and deduplication)#1

    The values are not case sensitive.

    If this attribute is changed from disabled to compression or compression_deduplication, the following applicable value is set by default for the dataReductionProcessMode attribute (the capacity-saving mode).

    • inline

    If you change this attribute from disabled to compression or compression_deduplication and the storage system is one for which a compression accelerator can be used, the capacity saving function that uses a compression accelerator will be automatically enabled.

    dataReductionProcessMode

    string

    (Optional) Specify the capacity-saving mode.

    • post_process: Post-process mode
    • inline: Inline mode

    This attribute can be specified when the capacity saving function is enabled.

    This attribute cannot be specified at the same time as any other attribute.

    isCompressionAccelerationEnabled

    boolean

    (Optional) Specify whether to enable the compression accelerator of the capacity saving function (dedupe and compression).#2

    • true: Enable
    • false: Disable

    This attribute can be specified when the capacity saving function is enabled.

    This attribute cannot be specified at the same time as any other attribute.

    If you specify this attribute and simultaneously execute multiple requests, the corresponding jobs will be executed in parallel.

    isRelocationEnabled

    boolean

    (Optional) Specify whether to enable the tier relocation setting for the HDT volume.

    • true : Enable the tier relocation.
    • false : Disable the tier relocation.

    tieringPolicy

    object

    Specify the tiering policy to be assigned to the HDT volume.

    Specifying this attribute automatically enables tier relocations for the HDT volume.

    If you specify false for the isRelocationEnabled attribute, you cannot specify this attribute.

    • (Optional) tierLevel (int)

      Level of the tiering policy

      If you specify the tiering policy, you must specify this setting.

      Specify a value from 0 to 31.

      • 0: All tiers are used for relocations.
      • 1 to 5: Relocations are performed by following the tiering policy (levels 1 to 5).
      • 6 to 31: Relocations are performed by following the tiering policy (custom policy).

      When an HDT volume is created, 0 is set.

    If you specify a custom policy of 6 to 31 for the tierLevel attribute, you can also specify the percentage of pages to be allocated to each tier.#3

    There are four attributes for specifying the percentage. If you specify these attributes, you must specify all of them. Specify a value from 1 to 100.#4

    You can specify the following attributes:

    • (Optional) tier1AllocationRateMin (int)

      From among the total capacity of the pages to be allocated when tier relocation is performed, the minimum rate (%) of the capacity to be relocated to tier 1

    • (Optional) tier1AllocationRateMax (int)

      From among the total capacity of the pages to be allocated when tier relocation is performed, the maximum rate (%) of the capacity to be relocated to tier 1

    • (Optional) tier3AllocationRateMin (int)

      From among the total capacity of the pages to be allocated when tier relocation is performed, the minimum rate (%) of the capacity to be relocated to tier 3

    • (Optional) tier3AllocationRateMax (int)

      From among the total capacity of the pages to be allocated when tier relocation is performed, the maximum rate (%) of the capacity to be relocated to tier 3

    tierLevelForNewPageAllocation

    string

    (Optional) Specify which tier of the HDT pool will be prioritized when a new page is allocated.

    The type is not case sensitive.

    • H: Higher-level tier (High)
    • M: Middle-level tier (Middle)
    • L: Lower-level tier (Low)

    When an HDT volume is created, M is set.

    isFullAllocationEnabled

    boolean

    (Optional) Specify whether to reserve pages of the pool associated with the DP volume by using the Full Allocation functionality.

    • true: Enable the page reservation setting.
    • false: Disable the page reservation setting.

    When a DP volume is created, false is set.

    isAluaEnabled

    boolean

    (Optional) Specify whether to enable the ALUA attribute.

    You can specify this attribute for a volume used for a global-active device in a cross-path configuration (using a Fibre Channel connection).

    • true: Enable the ALUA attribute.
    • false: Disable the ALUA attribute.

#1: If the data of the volume has been deduplicated, disabling the capacity saving function might take time. For details about the task to disable the capacity saving function, see the Provisioning Guide for Open Systems, or the Provisioning Guide. In addition, use the status of the target resource rather than the status of the job to check whether the settings have been changed.

#2: After the settings of the compression accelerator of the capacity saving function are changed, data conversion processing is performed. This data conversion processing takes time. Thus, if you want to change the settings of the compression accelerator, we recommend that you do so in a planned manner. For details, see the Provisioning Guide for Open Systems, or the Provisioning Guide. In addition, to check the progress of the data conversion processing of a volume, run the API for getting volume information, and then check the values of the isCompressionAccelerationEnabled and dataReductionStatus attributes.

#3: If you do not specify the percentage, the values stored in the storage system are set.

#4: If you specify the value of each attribute, make sure that the value meets the following conditions:

  • The value of the tier1AllocationRateMin attribute is equal to or less than the value of the tier1AllocationRateMax attribute.
  • The value of the tier3AllocationRateMin attribute is equal to or less than the value of the tier3AllocationRateMax attribute.
  • The sum of the values of the tier1AllocationRateMin and tier3AllocationRateMin attributes is equal to or less than 100.
  • The difference between the values of the tier1AllocationRateMax and tier1AllocationRateMin attributes is a multiple of 10.
  • The difference between the values of the tier3AllocationRateMax and tier3AllocationRateMin attributes is a multiple of 10.
Response message
  • Body

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

    Attribute

    Description

    affectedResources

    URL of the volume whose settings were changed

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/ldevs/100

Changing the volume status

The following request changes the status of a volume. The volume status can be changed to blocked before a volume is shredded or returned to the normal status after shredding is stopped.
Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/ldevs/object-ID/actions/change-status/invoke
Request message
  • Object ID

    Specify the value of ldevId that was obtained by the processing to get 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 is a coding example for changing the volume status to blocked:

    {
      "parameters": {
        "status": "blk"
      }
    }

    Attribute

    Type

    Description

    status

    string

    (Required) Volume status

    The specifiable values are as follows:

    blk: Change the status to blocked

    nml: Change the status to normal

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 whose status was changed

Action template

GET base-URL/v1/objects/ldevs/object-ID/actions/change-status
Status codes

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.

Status code

Message

Description

412

Precondition Failed

The specified action cannot run because the volume meets one of the following conditions:

  • The LDEV is used as a Quorum disk.
  • The LDEV is used as a system disk.
  • The LDEV is used as a pool volume.
  • The LDEV is used as a Volume Migration volume.
  • The LDEV is used as a pair volume of a global-active device.
  • The LDEV is used as a pair volume of ShadowImage.
  • The LDEV is used as a pair volume of TrueCopy or Universal Replicator.
  • The LDEV is used as a pair volume of Thin Image or Copy-on-Write Snapshot.
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/100/actions/change-status

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/100/actions/change-status/invoke

Shredding a volume

The following request shreds an LDEV (basic volume) or DP volume. Overwrite the volume three times with dummy data. You can stop shredding before its completion. Change the status of the volume to be shredded to blocked. When shredding is complete, the status of the volume is automatically changed to normal. If you stopped shredding before completion, the status of the volume remains as blocked.
Notes when stopping shredding

If you make a request to stop shredding, all of the volumes that are currently being shredded are stopped.

Shredding might not stop even if you make a request to stop shredding. In such case, make the request according to the progress status of the shredding. The progress of the shredding can be checked from the value of the preparingOperationProgressRate attribute that is obtained from the information of the target volume.

  • When the value of the attribute is 0, shredding has not started.

    When the value is 0, shredding is not stopped even if a request is made.

    Request the stopping of the shredding after the value is greater than or equal to 1.

  • When a request for stopping shredding is made but the value of the attribute does not change to 100, shredding is not stopped.

    In such case, make a request to stop the shredding again.

Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/ldevs/object-ID/actions/shred/invoke
Request message
  • Object ID

    Specify the value of ldevId that was obtained by the processing to get 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 is a coding example for performing shredding by specifying the dummy data pattern:

    {
      "parameters": {
        "operationType": "start",
        "pattern": "F0F0F0"
      }
    }

    The following is a coding example for performing shredding without specifying the dummy data pattern:

    {
      "parameters": {
        "operationType": "start"
      }
    }

    The following is a coding example for stopping shredding before completion:

    {
      "parameters": {
        "operationType": "stop"
      }
    }

    Attribute

    Type

    Description

    operationType

    string

    (Required) Run or stop shredding.

    The specifiable values are as follows:

    start: Run shredding

    stop: Stop shredding

    pattern

    string

    (Optional) Dummy data pattern to be used for the second overwrite

    Specify a pattern consisting of 1 to 8 characters in a hexadecimal format.

    Specification example: 0F0F0F

    If the value is not specified, the default pattern FFFFFFFF will be used.

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 shredded volume

Action template

GET base-URL/v1/objects/ldevs/object-ID/actions/shred
Status codes

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.

Status code

Message

Description

412

Precondition Failed

The specified action cannot run because the volume meets one of the following conditions:

  • The LDEV status is normal or the status is being changed.
  • The LDEV is used as a Quorum disk.
  • The LDEV is used as a system disk.
  • The LDEV is used as a pool volume.
  • The LDEV is used as a deduplication system data volume (fingerprint).
  • The LDEV is used as a journal volume.
  • The LDEV is used as a pair volume of a global-active device.
  • The LDEV is used as a pair volume of ShadowImage.
  • The LDEV is used as a pair volume of TrueCopy or Universal Replicator.
  • The LDEV is used as a pair volume of Thin Image or Copy-on-Write Snapshot.
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/100/actions/shred

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/100/actions/shred/invoke

Reclaiming zero pages of a DP volume

The following request reclaims zero pages of a DP volume to release the pages. By releasing pages, you can increase the free capacity of a pool.
Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/ldevs/object-ID/actions/discard-zero-page/invoke
Request message
  • Object ID

    Specify the value of ldevId that was obtained by the processing to get information about volumes.

    Attribute

    Type

    Description

    ldevId

    int

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

  • Query parameters

    None.

  • Body

    None.

Response message

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 zero pages were reclaimed

Action template

None.

Status codes

The following table explains the meanings of the status codes for this API. For details on other status codes, see the section explaining HTTP status codes.

Status code

Message

Description

412

Precondition Failed

The specified action cannot run because the volume meets one of the following conditions:

  • The volume is not a DP volume.
  • The volume is in the blocked status.
  • The volume is used as a pair volume of one of the following copy types:

    • ShadowImage
    • TrueCopy
    • Universal Replicator
    • Copy-on-Write Snapshot
  • The volume is used as a journal volume of Universal Replicator.
  • The volume is used as a Volume Migration volume.
Coding example
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/ldevs/1/actions/discard-zero-page/invoke -d ""

Changing the MP blade assigned to a volume

The following request changes the MP blade assigned to a volume.
Note

When changing the MP blade assigned to a volume, make sure to take into account the effect the change will have on I/O performance. For notes on changing the MP blade assigned to a volume, see the Provisioning Guide for Open Systems or the Provisioning Guide for the storage system.

Execution permission

Storage Administrator (System Resource Management)

Request line

POST base-URL/v1/objects/ldevs/object-ID/actions/assign-mp-blade/invoke
Request message
  • Object ID

    Specify the ldevId value obtained by getting volume information.

    Attribute

    Type

    Description

    ldevId

    int

    (Required) LDEV number

  • Query parameters

    None.

  • Body

    {
        "parameters": {
            "mpBladeId": 1
        }
    }

    Attribute

    Type

    Description

    mpBladeId

    int

    (Required) MP blade number of the MP blade to be assigned to the volume

Response message
  • Body

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

    Attribute

    Description

    affectedResources

    URL of the volume for which the MP blade number was changed

Action template

None.

Status codes

For details about the status codes of the request for this operation, see the description of the 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/ldevs/99/actions/assign-mp-blade/invoke

Deleting a volume

The following request deletes an LDEV (basic volume) or a virtual volume (a DP volume or a virtual volume for Thin Image).
Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/v1/objects/ldevs/object-ID
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

    None.

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 deleted volume

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/ldevs/105
When forcibly deleting the DP volume for which the capacity saving function (dedupe and compression) is enabled
ImportantDeleting data on a DP volume for which the capacity saving function (compression or deduplication) is enabled takes time. Be sure to take this into account when planning when to delete such data. In addition, use the status of the target resource rather than the status of the job to check whether the volume has been deleted.

When deleting the DP volume for which the capacity saving function (compression or deduplication) is enabled, in the request body, specify true for the isDataReductionDeleteForceExecute attribute.

The following coding example forcibly deletes the DP volume for which the capacity saving function (compression or deduplication) is enabled:

{
  "isDataReductionDeleteForceExecute": true
}

Attribute

Type

Description

isDataReductionDeleteForceExecute

boolean

(Optional) Specify whether to forcibly delete the DP volume for which the capacity saving function (compression or deduplication) is enabled.

  • true: Forcibly deletes
  • false: Does not forcibly delete

When the attribute is omitted, false is assumed.

Getting port information

The following request obtains information about ports.
Important
  • If the storage system model is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, if you execute this API request with detailInfoType=logins specified, pay attention to the number of concurrent executions of this API request. For details, see "Implementing retry processing".

  • Pay attention to the number of concurrent executions if this API request is run when the storage system is VSP E1090 or VSP E1090H, detailInfoType=loginHostNqn is specified in the query, and portId is not specified. For details, see "Implementing retry processing".

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/ports
Request message
  • Object ID

    None.

  • Query parameters

    You can filter execution results by specifying conditions, or get additional detailed port information.

    When filtering execution results:

    Parameter

    Type

    Filter condition

    portType

    string

    (Optional) Port type

    You can specify the following conditions:

    • FIBRE
    • SCSI
    • ISCSI
    • ENAS
    • ESCON
    • FICON

    If this parameter is omitted, information about ports of all port types will be obtained.

    If you specify portId, you cannot specify this parameter.

    portAttributes

    string

    (Optional) Port attribute

    You can specify the following conditions:

    • TAR: Target port (Fibre Target port)
    • MCU: Initiator port (MCU Initiator port)
    • RCU: RCU target port (RCU Target port)
    • ELUN: External port (External Initiator port)

    If this parameter is omitted, information about all port attributes will be obtained.

    Information about bidirectional ports will be obtained regardless of which value is specified for this parameter.

    If you specify portId, you cannot specify this parameter.

    portId

    string

    (Optional) Port number

    If this parameter is omitted, information about all port numbers will be obtained. If you specify this parameter, be sure to specify logins or loginHostNqn for the detailInfoType parameter. Note that the portType parameter and the portAttributes parameter cannot be specified at the same time.

    When collecting 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.

    • logins: Information about logins to a port corresponding to the WWN of an HBA or iSCSI name

      You can get this information if the port type is FIBRE, or ISCSI.

      This value cannot be specified at the same time as loginHostNqn.

    • portMode: Operating mode of the port
    • loginHostNqn: Information about login to the host NQN port

      Information can be obtained if the port type is FIBRE.

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

      This value cannot be specified at the same time as logins.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when information obtained about all ports:

    {
      "data": [
        {
          "portId": "CL1-A",
          "portType": "FIBRE",
          "portAttributes": [
            "TAR",
            "MCU",
            "RCU",
            "ELUN"
          ],
          "portSpeed": "AUT",
          "loopId": "EF",
          "fabricMode": true,
          "portConnection": "PtoP",
          "lunSecuritySetting": true,
          "wwn": "50060e80124e3b00"
        },
        {
          "portId": "CL1-B",
          "portType": "ISCSI",
          "portAttributes": [
            "TAR",
            "MCU",
            "RCU",
            "ELUN"
          ],
          "portSpeed": "10G",
          "loopId": "00",
          "fabricMode": false,
          "lunSecuritySetting": true
        }
      ]
    }

    The following is an example of the output when information is obtained about ports by specifying the port type:

    {
      "data": [
        {
          "portId": "CL1-B",
          "portType": "ISCSI",
          "portAttributes": [
            "TAR",
            "MCU",
            "RCU",
            "ELUN"
          ],
          "portSpeed": "10G",
          "loopId": "00",
          "fabricMode": false,
          "lunSecuritySetting": true
        }
      ]
    }

    Attribute

    Type

    Description

    portId

    string

    Port number

    portType

    string

    Port type

    One of the following values is output:

    FIBRE, SCSI, ISCSI, ENAS, ESCON, FICON

    portAttributes

    string[]

    The value set for the port attribute

    • TAR: Target port (Fibre Target port)
    • MCU: Initiator port (MCU Initiator port)
    • RCU: RCU target port (RCU Target port)
    • ELUN: External port (External Initiator port)

    For a bidirectional port, all four attributes are output.

    portSpeed

    string

    The value set for the transfer speed

    • AUT (AUTO)
    • nG (where n is a number)

    loopId

    string

    The value set for the port loop ID (AL_PA)

    fabricMode

    boolean

    Fabric mode of the port

    • true: Set.
    • false: Not set.

    portConnection

    string

    Topology setting for the port

    • FCAL
    • PtoP

    If the portType attribute is ISCSI, this information is not output.

    lunSecuritySetting

    boolean

    LUN security setting for the port

    • true: Set.
    • false: Not set.

    wwn

    string

    External WWN

    If the portType attribute is ISCSI, this information is not output.

    The following is an example of the output when requesting additional detailed information:

    {
      "data" : [ 
        {
          "portId" : "CL1-A",
          "portType" : "FIBRE",
          "portAttributes" : [ "TAR" ],
          "portSpeed" : "AUT",
          "loopId" : "EF",
          "fabricMode" : true,
          "portConnection" : "PtoP",
          "lunSecuritySetting" : true,
          "wwn" : "50060e8007274300",
          "logins" : [
            {
              "loginWwn" : "C0507603BFAA002C",
              "wwnNickName" : "-",
              "isLoggedIn" : false
            }, 
            {
              "loginWwn" : "C05076087D5A0012",
              "wwnNickName" : "ep22_10_0",
              "hostGroupId" : "CL1-A,9",
              "isLoggedIn" : true
            }
          ]
        },
        {
          "portId" : "CL1-B",
          "portType" : "ISCSI",
          "portAttributes" : [ "TAR" ],
          "portSpeed" : "10G",
          "loopId" : "00",
          "fabricMode" : false,
          "lunSecuritySetting" : true,
          "logins" : [
            {
              "loginIscsiName" : "iqn.1991-05.com.microsoft:hy0295",
              "iscsiNickName" : "hypoi0295",
              "hostGroupId" : "CL1-B,0",
              "iscsiTargetName" : "iqn.1994-04.jp.co.hitachi:rsd.h8h.t.10011.1d000",
              "isLoggedIn" : false
            },
            {
              "loginIscsiName" : "iqn.1991-05.com.microsoft:hy0295",
              "iscsiNickName" : "hypoi0295",
              "hostGroupId" : "CL1-B,94",
              "iscsiTargetName" : "iqn.1994-04.jp.co.hitachi:rsd.h8h.t.10011.1d05e",
              "isLoggedIn" : true
            }
          ]
        }
      ]
    }

    You can also get the following information by executing the request with logins specified for detailInfoType in the query parameters.

    Attribute

    Type

    Description

    logins

    object[]

    Information about logins to a storage system port corresponding to the WWN of an HBA or iSCSI name

    For the WWN:

    • loginWwn (string)

      WWN of the HBA

    • wwnNickName (string)#

      WWN nickname

    • hostGroupId (string)#

      Object ID of the host group

    • isLoggedIn (boolean)

      Login status of the host

      • true: Logged in
      • false: Not logged in

    For iSCSI name:

    • loginIscsiName (string)

      iSCSI name of iSCSI initiator

    • iscsiNickName (string)#

      iSCSI nickname

    • hostGroupId (string)#

      Object ID of iSCSI target

    • iscsiTargetName (string)

      iSCSI name of iSCSI target

    • isLoggedIn (boolean)

      Login status of the host

      • true: Logged in
      • false: Not logged in

    #: For a VSP 5000 series storage system, it might take some time (from about 30 seconds to a few minutes) after the values for these attributes are updated before you can obtain the updated information by using the REST API. Wait a while and then execute the request again.

    You can also get the following information by executing the request with portMode specified for detailInfoType in the query parameters.

    Attribute

    Type

    Description

    portMode

    string

    Operating mode of the port

    • FC-NVMe: NVMe mode
    • FCP-SCSI: SCSI mode
    • NOT SUPPORTED: This value is output if the storage system is not a VSP 5000 series, VSP E1090, VSP E1090H storage system or if the port does not support FC-NVMe.

    You can also get the following information by executing the request with loginHostNqn specified for detailInfoType in the query parameters.

    Attribute

    Type

    Description

    hostNqnLogins

    object[]

    Information related to host NQN logins

    • hostNqn (string)

      Host NQN

    • isLoggedIn (boolean)

      Host NQN login information

      • true: Logged in
      • false: Not logged in
Status codes

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

Coding example

To obtain information about all ports:

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/ports

To obtain information about ports by specifying the port type:

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/ports?portType=ISCSI

To obtain information about ports by requesting additional detailed information:

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/ports?detailInfoType=logins

Getting information about a specific port

The following request gets information about a specific port by specifying the port number. You can use this API to get information about Fibre Channel port, or iSCSI port.
Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/ports/object-ID
Request message
  • Object ID

    Specify the portId value obtained by getting information about the port.

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

  • Query parameters

    Parameter

    Type

    Description

    detailInfoType

    string

    (Optional) Type of detailed information to be obtained

    • 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".

    • portMode: Operating mode of the port
  • Body

    None.

Response message
  • Body

    The following is an example of the output generated when getting Fibre Channel port information:

    {
      "portId": "CL1-A",
      "portType": "FIBRE",
      "portAttributes": [
        "TAR",
        "MCU",
        "RCU",
        "ELUN"
      ],
      "portSpeed": "AUT",
      "loopId": "EF",
      "fabricMode": true,
      "portConnection": "PtoP",
      "lunSecuritySetting": true,
      "wwn": "50060e80124e3b00"
    }

    For a Fibre Channel port:

    Attribute

    Type

    Description

    portId

    string

    Port number

    portType

    string

    Port type

    One of the following values is output:

    FIBRE, SCSI, ISCSI, ENAS, ESCON, FICON

    portAttributes

    string[]

    The value set for the port attribute

    • TAR: Target port (Fibre Target port)
    • MCU: Initiator port (MCU Initiator port)
    • RCU: RCU target port (RCU Target port)
    • ELUN: External port (External Initiator port)

    For a bidirectional port, all four attributes are output.

    portSpeed

    string

    The value set for the transfer speed

    • AUT (AUTO)
    • nG (where n is a number)

    loopId

    string

    The value set for the port loop ID (AL_PA)

    fabricMode

    boolean

    Fabric mode of the port

    • true: Set.
    • false: Not set.

    portConnection

    string

    Topology setting for the port

    • FCAL
    • PtoP

    lunSecuritySetting

    boolean

    LUN security setting for the port

    • true: Set.
    • false: Not set.

    wwn

    string

    External WWN

    logins

    object[]

    If there is a currently-connected WWN, the following attributes are output:

    • loginWwn (string)

      WWN of the host adapter that is logged in to the port

    • wwnNickName (string)

      Reserved attribute

      The version of this API is always displayed as a hyphen (-).

    The following is an example of the output generated when getting iSCSI port information.

    {
      "portId" : "CL1-A",
      "portType" : "ISCSI",
      "portAttributes" : [ "TAR", "MCU", "RCU", "ELUN" ],
      "portSpeed" : "10G",
      "loopId" : "00",
      "fabricMode" : false,
      "lunSecuritySetting" : true,
      "tcpOption" : {
        "ipv6Mode" : false,
        "selectiveAckMode" : true,
        "delayedAckMode" : true,
        "isnsService" : false,
        "tagVLan" : false
      },
      "tcpMtu" : 1500,
      "iscsiWindowSize" : "64KB",
      "keepAliveTimer" : 60,
      "tcpPort" : "3260",
      "macAddress" : "00:1f:67:1f:14:1d",
      "ipv4Address" : "192.168.0.100",
      "ipv4Subnetmask" : "255.255.255.0",
      "ipv4GatewayAddress" : "0.0.0.0",
      "ipv6LinkLocalAddress" : {
        "status" : "INV",
        "addressingMode" : "AM",
        "address" : "fe80::"
      },
      "ipv6GlobalAddress" : {
        "status" : "INV",
        "addressingMode" : "AM",
        "address" : "::"
      },
      "ipv6GatewayGlobalAddress" : {
        "status" : "INV",
        "address" : "::",
        "currentAddress" : "::"
      }
    }

    For an iSCSI port:

    Attribute

    Type

    Description

    portId

    string

    Port number

    portType

    string

    Port type

    One of the following values is output:

    FIBRE, SCSI, ISCSI, ENAS, ESCON, FICON

    portAttributes

    string[]

    The value set for the port attribute

    • TAR: Target port (Fibre Target port)
    • MCU: Initiator port (MCU Initiator port)
    • RCU: RCU target port (RCU Target port)
    • ELUN: External port (External Initiator port)

    For a bidirectional port, all four attributes are output.

    portSpeed

    string

    The value set for the transfer speed

    • AUT (AUTO)
    • nG (where n is a number)

    loopId

    string

    The value set for the port loop ID (AL_PA)

    fabricMode

    boolean

    Fabric mode of the port

    • true: Set.
    • false: Not set.

    lunSecuritySetting

    boolean

    LUN security setting for the port

    • true: Set.
    • false: Not set.

    logins

    object[]

    If there is a currently-connected iSCSI name, the following attributes are output:

    • loginIscsiName (string)

      iSCSI name of the host adapter that is logged in to the port

    vLanId

    string

    VLAN ID (in decimal number format)

    tcpOption

    object

    The following attributes are output:

    • ipv6Mode (boolean)

      IPv6 mode

    • selectiveAckMode (boolean)

      Selective Ack mode

    • delayedAckMode (boolean)

      Delayed Ack mode

    • isnsService (boolean)

      iSNS service

    • tagVLan (boolean)

      Tag VLAN

    tcpMtu

    int

    Value of MTU for iSCSI communication

    iscsiWindowSize

    string

    Value of Window Size for iSCSI communication

    keepAliveTimer

    int

    Value of Keep Alive Timer for iSCSI communication

    tcpPort

    string

    TCP port number for iSCSI communication

    macAddress

    string

    MAC address of the port

    ipv4Address

    string

    IPv4 address

    ipv4Subnetmask

    string

    IPv4 subnet mask

    ipv4GatewayAddress

    string

    IPv4 address of the gateway to be used for iSCSI communication

    ipv6LinkLocalAddress

    object

    The following attributes are output:

    • status (string)

      One of the following values that indicate the status of the IPv6 link local address is output:

      • INV: Invalid
      • VAL: Valid
      • ACQ: Acquiring
      • DUP: Duplicated
      • Unknown: Undefined value
    • addressingMode (string)

      One of the following values that indicate the mode of the IPv6 link local address is output:

      • AM: Auto mode
      • MM: Manual mode
      • Unknown: Undefined value
    • address (string)

      IPv6 link local address value

    ipv6GlobalAddress

    object

    The following attributes are output:

    • status (string)

      One of the following values that indicate the status of the IPv6 global address is output:

      • INV: Invalid
      • VAL: Valid
      • ACQ: Acquiring
      • DUP: Duplicated
      • Unknown: Undefined value
    • addressingMode (string)

      One of the following values that indicate the mode of the IPv6 global address is output:

      • AM: Auto mode
      • MM: Manual mode
      • Unknown: Undefined value
    • address (string)

      IPv6 global address value

    ipv6GatewayGlobalAddress

    object

    The following attributes are output:

    • status (string)

      One of the following values that indicate the status of the IPv6 global address of the gateway to be used for iSCSI communication is output:

      • INV: Invalid
      • VAL: Valid
      • ACQ: Acquiring
      • DUP: Duplicated
      • Unknown: Undefined value
    • address (string)

      IPv6 global address value of the gateway to be used for iSCSI communication

    • currentAddress (string)

      IPv6 global current address value of the gateway to be used for iSCSI communication

    isnsPort

    string

    TCP port number of the iSNS server

    isnsAddress

    string

    Address of the iSNS server

    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

    channelBoardId

    int

    ID of the channel board

    ipv6GlobalAddress2

    object

    Attributes related to IPv6 Global address2

    This information is output for iSCSI ports.

    • address (string)

      Address value for IPv6 Global address2

    • status (string)

      Status of IPv6 Global address2

      • INV: Invalid
      • VAL: Valid
      • ACQ: Acquiring
      • DUP: Duplicated
      • Unknown: Undefined value

    This information is not output if iscsiVirtualPortMode is true.

    ipv6SubnetPrefixLength

    int

    Length of the IPv6 subnet prefix

    This information is output for iSCSI ports.

    If the setting for IPv6 is invalid, -1 is output.

    This information is not output if iscsiVirtualPortMode is true.

    iscsiInitiatorName

    string

    iSCSI name of the storage system port

    This information is output for iSCSI ports.

    t10piMode

    string

    Status of the T10 PI mode of the port

    • Enable: Enabled
    • Disable: Disabled
    • Unknown: Status unknown (unsupported)

    iscsiVirtualPortMode

    boolean

    Whether iSCSI virtual port mode is enabled

    This information is output for iSCSI ports.

    • true: Enabled
    • false: Disabled

    You can also get the following information by executing the request with portMode specified for detailInfoType in the query parameters.

    Attribute

    Type

    Description

    portMode

    string

    Operating mode of the port

    • FC-NVMe: NVMe mode
    • FCP-SCSI: SCSI mode
    • NOT SUPPORTED: This value is output if the storage system is not a VSP 5000 series, VSP E1090, VSP E1090H storage system or if the port does not support FC-NVMe.
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 GET https://192.0.2.100/ConfigurationManager/v1/objects/ports/CL1-A

Changing the port attribute

The request below changes the value of the port attribute.
Note

This API request can be used when the storage system is VSP 5000 series.

Execution permission

Storage Administrator (Provisioning)

Request line
PATCH base-URL/v1/objects/ports/object-ID
Request message
  • Object ID

    Specify the value of portId that was obtained by the processing to get information about ports.

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

  • Query parameters

    None.

  • Body

    {
      "portAttribute": "TAR"
    }

    Attribute

    Type

    Description

    portAttribute

    string

    (Required) Port attribute

    You can specify the following values:

    • TAR: Target port (Fibre Target port)
    • ALL: Bidirectional port

    If the port is operating in NVMe mode and the storage system is a VSP 5000 series storage system, you must specify TAR.

    This item is not case sensitive.

Response message
  • Body

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

    Attribute

    Description

    affectedResources

    URL of the changed port

Action template

None.

Status codes

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

Coding example
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/ports/CL1-A

Getting information about host groups or iSCSI targets

The following request gets information about host groups or iSCSI targets of the port.
Important

If the storage system model is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, and if portId is not specified as a query parameter, pay attention to the number of concurrent executions of this API request. For details, see "Implementing retry processing".

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-groups
Request message
  • Object ID

    None.

  • Query parameters

    You can specify conditions to filter the execution results and get information about host groups at high speeds.

    • To filter the execution results

      Parameter

      Type

      Filter Condition

      portId

      string

      (Optional) Port number

      Only when this parameter is specified, the following attributes are also obtained:

      • iscsiName
      • authenticationMode
      • iscsiTargetDirection
      • hostModeOptions

      If this parameter is omitted, information about all ports is obtained.

      isUndefined

      boolean

      (Optional) Specify whether to get information even about host group numbers for which no host group or iSCSI target has been created.

      • true:

        Gets information about host group numbers for which no host group or iSCSI target has been created.

      • false:

        Does not get information about host group numbers for which no host group or iSCSI target has been created.

      You cannot specify this parameter at the same time as the hostGroupNumberList parameter.

      If this parameter is omitted, false is assumed to be specified.

    • When collecting additional detailed information

      Parameter

      Type

      Description

      detailInfoType

      string

      (Optional) Type of detailed information to be obtained

      • resourceGroup

        Gets information about resource groups of host groups or iSCSI targets.

        If you specify this parameter, also specify the portId parameter.

        The following parameter settings cannot be specified together with the detailInfoType parameter: storageCache specified for the accessMode parameter, or true specified for the isSimpleMode parameter.

    • To get information about host groups at high speeds

      Parameter

      Type

      Description

      accessMode

      string

      (Optional) To get information about host groups at high speeds, specify the following value:

      • storageCache

      You can specify this value if the storage system model is VSP 5000 series.

      If you specify this parameter, information about host groups is obtained from the cache. For this reason, you can get information more quickly by specifying this parameter than without specifying this parameter. After you use the REST API or CCI to create a host group, it usually takes anywhere from a few minutes to an hour before the latest information is applied to the cache.

      If you specify portId, you cannot specify this parameter.

      If you specify this parameter for VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, the parameter is ignored.

    • To obtain only the attributes that fall under basic information

      You can obtain information more quickly than if you were to obtain all attributes.

      Parameter

      Type

      Description

      isSimpleMode

      boolean

      (Optional) Specify whether to obtain only the attributes that fall under basic information.

      • true: Obtain only the attributes that fall under basic information.
      • false: Obtain all attributes.

      If you specify the value true for this parameter, be sure to also specify the portId parameter.

      If this parameter is omitted, the value false is assumed.

      hostGroupNumberList

      string

      (Optional) Target IDs of iSCSI targets

      Specify this parameter to get basic information about the specified iSCSI targets.

      If you specify this parameter, be sure to specify true for the isSimpleMode parameter.

      You cannot specify this parameter at the same time as the isUndefined parameter.

      To specify multiple IDs, delimit each ID by using a comma.

  • Body

    None.

Response message
  • Body

    The following coding example obtains only the attributes that fall under basic information:

    {
      "data": [
        {
          "hostGroupId": "CL1-A,0",
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "hostA"
        },
        {
          "hostGroupId": "CL1-B,0",
          "portId": "CL1-B",
          "hostGroupNumber": 0,
          "hostGroupName": "hostB"
        }
      ]
    }

    The following table describes the attributes that are obtained by a request that gets only attributes that fall under basic information:

    Attribute

    Type

    Description

    hostGroupId

    string

    Object ID for the host group or iSCSI target

    portId

    string

    Port number

    hostGroupNumber

    int

    Host group number of the port (for the iSCSI target, target ID)

    hostGroupName

    string

    Host group name (for the iSCSI target, target ID)

    If you do not specify the hostGroupNumberList parameter, only the first 16 characters are obtained.

    iscsiName

    string

    iSCSI name of the iSCSI target of the port

    This attribute is obtained only if you specify the hostGroupNumberList parameter.

    authenticationMode

    string

    Authentication mode for the iSCSI target

    This attribute is obtained only if you specify the hostGroupNumberList parameter.

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

    iscsiTargetDirection

    string

    Direction of CHAP authentication for the iSCSI target

    This attribute is obtained only if you specify the hostGroupNumberList parameter.

    • S: One-way (The iSCSI target authenticates the iSCSI initiator.)
    • D: Mutual (The iSCSI target and the iSCSI initiator authenticate each other.)

    The following coding example obtains all attributes:

    The following is an example of the output generated from the processing to get information about host groups or iSCSI targets of all ports:

    {
      "data": [
        {
          "hostGroupId": "CL1-A,0",
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "hostA",
          "hostMode": "WIN",
          "hostModeOptions": [
            1,
            2
          ]
        },
        {
          "hostGroupId": "CL1-B,0",
          "portId": "CL1-B",
          "hostGroupNumber": 0,
          "hostGroupName": "hostB",
          "hostMode": "LINUX/IRIX"
        }
      ]
    }

    The following is an output example when information about the host group or the iSCSI target created for the specified port number is obtained:

    {
      "data": [
        {
          "hostGroupId": "CL1-A,0",
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "hostA",
          "hostMode": "WIN",
          "hostModeOptions": [
            1,
            2
          ]
        },
        {
          "hostGroupId": "CL1-A,1",
          "portId": "CL1-A",
          "hostGroupNumber": 1,
          "hostGroupName": "hostB",
          "hostMode": "LINUX/IRIX"
        }
      ]
    }

    The following is an example of the output generated when information about resource groups is obtained:

    In this example, information is also obtained about host group numbers for which no host group or iSCSI target has been created.

    {
      "data": [
        {
          "hostGroupId": "CL1-A,0",
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "hostA",
          "hostMode": "WIN",
          "hostModeOptions": [
            1,
            2
          ],
          "resourceGroupId": 1,
          "isDefined": true
        },
        {
          "hostGroupId": "CL1-A,1",
          "portId": "CL1-A",
          "hostGroupNumber": 1,
          "hostGroupName": "-",
          "resourceGroupId": 2,
          "isDefined": false
        }
      ]
    }

    The following table describes the attributes that are obtained by a request that gets all attributes:

    Attribute

    Type

    Description

    hostGroupId

    string

    Object ID for the host group or iSCSI target

    portId

    string

    Port number

    hostGroupNumber

    int

    Host group number of the port (for the iSCSI target, target ID)

    hostGroupName

    string

    Host group name (for the iSCSI target, target ID)

    iscsiName

    string

    iSCSI name of the iSCSI target of the port

    This information is obtained only when the portId parameter is specified.

    authenticationMode

    string

    Authentication mode for the iSCSI target

    This information is obtained only when the portId parameter is specified.

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

    iscsiTargetDirection

    string

    Direction of CHAP authentication for the iSCSI target

    This information is obtained only when the portId parameter is specified.

    • S: One-way (The iSCSI target authenticates the iSCSI initiator.)
    • D: Mutual (The iSCSI target and the iSCSI initiator authenticate each other.)

    hostMode

    string

    Host mode for setting the host adapter of the host group

    This attribute is obtained if the host group name is defined.

    For details on the values to be obtained, see the description of the API function for changing the host group or iSCSI target settings.

    hostModeOptions

    int[]

    Number of the host mode option set for the host group

    This is not output if a host mode option is not set.

    This information is obtained only when the portId parameter is specified.

    This attribute is obtained if the host group name is defined.

    For details on the number to be obtained, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

    resourceGroupId

    int

    ID of the resource group to which the host group or iSCSI target belongs

    This information is obtained only when detailInfoType=resourceGroup is specified for the query.

    isDefined

    boolean

    Whether the host group or iSCSI target has been created

    This information is obtained only when detailInfoType=resourceGroup is specified for the query.

    • true: The host group or iSCSI target has been created.
    • false: The host group or iSCSI target has not been created.
Status codes

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

Coding example

When getting information about host groups or iSCSI targets of all ports:

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/host-groups

When information about the host group or the iSCSI target created for the specified port number is obtained:

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/host-groups?portId=CL1-A

When obtaining information about resource groups:

In this example, information is also obtained about host group numbers for which no host group or iSCSI target has been created.

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/host-groups?portId=CL1-A&isUndefined=true&detailInfoType=resourceGroup

Getting information about a specific host group or iSCSI target

The following request gets information by specifying the host group number of the port or the target ID of the iSCSI target.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-groups/object-ID
Request message
  • Object ID

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

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output generated when getting information by specifying the port number and the host group number:

    {
      "hostGroupId": "CL1-A,0",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "hostA",
      "hostMode": "WIN",
      "hostModeOptions": [
        1,
        2
      ]
    }

    For an iSCSI target, the following is an example of the output generated when getting information by specifying the port number and the target ID:

    {
      "hostGroupId": "CL1-A,0",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "hostA",
      "iscsiName": "iqn.rest.example.of.iqn.host",
      "authenticationMode": "CHAP",
      "iscsiTargetDirection": "S",
      "hostMode": "WIN",
      "hostModeOptions": [
        1,
        2
      ]
    }

    Attribute

    Type

    Description

    hostGroupId

    string

    Object ID for the host group or iSCSI target

    portId

    string

    Port number

    hostGroupNumber

    int

    Host group number of the port (for the iSCSI target, target ID)

    hostGroupName

    string

    Host group name (for the iSCSI target, target ID)

    iscsiName

    string

    iSCSI name of the iSCSI target of the port

    This information is obtained in the case of an iSCSI port.

    authenticationMode

    string

    Authentication mode for the iSCSI target

    This information is obtained in the case of an iSCSI port.

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

    iscsiTargetDirection

    string

    Direction of CHAP authentication for the iSCSI target

    This information is obtained in the case of an iSCSI port.

    • S: One-way (The iSCSI target authenticates the iSCSI initiator.)
    • D: Mutual (The iSCSI target and the iSCSI initiator authenticate each other.)

    hostMode

    string

    Host mode for setting the host adapter of the host group

    For details on the values to be obtained, see the description of the API function for changing the host group or iSCSI target settings.

    hostModeOptions

    int[]

    Number of the host mode option set for the host group

    This is not output if a host mode option is not set.

    For details on the number to be obtained, see the Provisioning Guide for Open Systems , or the Provisioning Guide .

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 GET https://192.0.2.100/ConfigurationManager/v1/objects/host-groups/CL1-A,0

Getting a list of host modes and host mode options

The following request acquires a list of host modes and host mode options used for the storage system.
Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/supported-host-modes/instance
Request message
  • Object ID

    Specify instance.

    If an object has only one instance, instance is the fixed value that specifies the object ID.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "hostModes": [
        {
          "hostModeId": 0,
          "hostModeName": "Standard",
          "hostModeDisplay": "LINUX/IRIX"
        },
        {
          "hostModeId": 1,
          "hostModeName": "(Deprecated) VMware",
          "hostModeDisplay": "VMWARE"
        }
      ],
      "hostModeOptions": [
        {
          "hostModeOptionId": 2,
          "hostModeOptionDescription": "VERITAS Database Edition/Advanced Cluster"
        },
        {
          "hostModeOptionId": 6,
          "hostModeOptionDescription": "TPRLO"
        }
      ]
    }

    Attribute

    Type

    Description

    hostModes

    object[]

    The following attributes related to the host mode are output:

    • hostModeId (int)

      Host mode number

    • hostModeName (string)

      Identification name of the host mode

    • hostModeDisplay (string)

      Host mode value

      Value to be used to specify the host mode

    hostModeOptions

    object[]

    The following attributes related to the host mode option are output:

    • hostModeOptionId (int)

      Host mode option number

    • hostModeOptionDescription (string)

      Description of the host mode option

Status codes

For details on the status codes of the request for this operation, see the description of 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/supported-host-modes/instance

Creating a host group or an iSCSI target

The following request creates a host group for the port. For an iSCSI port, this request creates the iSCSI target and the iSCSI name. The host mode and the host mode option can also be specified at the same time when the host group and the iSCSI target are created.
Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/host-groups
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    The following coding example creates a host group:

    {
      "portId": "CL1-A",
      "hostGroupName": "My_REST_API_HOST",
      "hostModeOptions": [12,33],
      "hostMode": "AIX"
    }

    The following coding example creates an iSCSI target:

    {
      "portId": "CL1-A",
      "hostGroupName": "My_REST_API_HOST",
      "iscsiName": "iqn.20150908iscsi"
    }

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Optional) Host group number

    Specify a decimal (base 10) number in the range from 0 to 254. If this attribute is omitted, a value is automatically set.

    For iSCSI ports, this number is called target ID.

    hostGroupName

    string

    (Required) Host group name or iSCSI target name

    • To create a host group

      Specify a host group name consisting of 1 to 64 characters.

    • To create an iSCSI target

      Specify the iSCSI target name consisting of 1 to 32 characters. For the iSCSI target, you cannot specify the default name of the iSCSI target whose ID is 0.

    You can use the following characters.

    • Alphanumeric characters
    • The following symbols:

      . @ _ : -

      The label cannot start with a hyphen (-).

    You cannot create host groups or iSCSI targets that have the same name for a single port.

    iscsiName

    string

    (Optional) iSCSI name

    Specify this item when creating an iSCSI target. If this attribute is omitted, a value is automatically set.

    Specify this item in the iqn or eui format.

    • iqn format

      Specify a value in the range from 5 to 223. You can use the following characters:

      alphanumeric characters (lowercase), periods (.), hyphens (-), and colons (:)

      Specification example: iqn.rest.example.of.iqn.form

    • eui format

      After "eui.", specify a hexadecimal number. Specify a value consisting of 20 characters.

      Specification example: eui.0900ABDC32598D26

    hostMode

    string

    (Optional) Host mode

    The specifiable values are as follows:

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

    If this attribute is omitted, LINUX/IRIX is set.

    hostModeOptions

    int[]

    (Optional) Number of options for setting host mode options

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

    When specifying more than one attribute, use a comma to separate the values.

    When specifying this attribute, make sure to also specify the hostMode attribute.

    isQuickCreating

    boolean

    (Optional) When creating a host group by specifying hostGroupNumber, if you want to omit the process of checking whether the host group is created, specify true. If you specify true and a host group or iSCSI target already exists for the specified hostGroupNumber, the setting is overwritten.

    • true: Does not check whether the host group has been created.
    • false: Checks whether the host group has been created.

    If this attribute is omitted, false is assumed.

    If hostGroupNumber is not specified, this attribute is ignored.

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

Status codes

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

Status code

Message

Description

409

Conflict

A host group already exists for the specified host group number.

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/host-groups

Changing the host group or iSCSI target settings

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

Deleting a host group or the iSCSI target

The following request deletes the WWN and LUN settings of a host group or of a host registered in a host group. Alternatively, the request deletes the LUN setting and iSCSI name of an iSCSI target or of a host (iSCSI initiator) registered for the iSCSI target. If the host group number of the host group to be deleted (target ID for the iSCSI port) is 0, the settings for the host group or iSCSI target are returned to their default values.
Execution permission

Storage Administrator (Provisioning)

Request line

DELETE 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

    None.

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

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/host-groups/CL1-A,0

Getting WWN information

Specifying a port and host group, the following request gets the information about the WWN registered for the host group.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-wwns
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Filter Condition

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Optional) The host group number

    You must specify one of the following parameters: this parameter, the hostGroupName parameter, or the hostGroupNumberList parameter.

    hostGroupName

    string

    (Optional) The host group name

    You must specify one of the following parameters: this parameter, the hostGroupNumber parameter, or the hostGroupNumberList parameter.

    hostGroupNumberList

    string

    (Optional) The host group number

    You can obtain information quickly by specifying this parameter.

    To specify multiple IDs, delimit each ID by using a comma.

    You must specify one of the following parameters: this parameter, the hostGroupNumber parameter, or the hostGroupName parameter.

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
          "hostWwnId": "CL1-A,0,000000102cceccc9",
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "my@host999",
          "hostWwn": "000000102cceccc9",
          "wwnNickname": "Myhostwwnsecret"
        },
        {
          "hostWwnId": "CL1-A,0,1111111111111111",
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "my@host999",
          "hostWwn": "1111111111111111",
          "wwnNickname": "formyhost"
        }
      ]
    }

    Attribute

    Type

    Description

    hostWwnId

    string

    Object ID for the WWN

    portId

    string

    Port number

    hostGroupNumber

    int

    Host group number of the port

    hostGroupName

    string

    Host group name of the port

    hostWwn

    string

    WWN of the host bus adapter registered for the host group

    wwnNickname

    string

    WWN nickname

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/host-wwns?portId=CL1-A&hostGroupNumber=0"

Getting information about a specific WWN

The following request gets information about the specified WWN.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-wwns/object-ID
Request message
  • Object ID

    Specify the hostWwnId value obtained by getting information about the WWN. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,hostWwn

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) The host group number

    hostWwn

    string

    (Required) The WWN of the host bus adapter

    Specify the attribute without using colons (:).

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "hostWwnId": "CL1-A,0,000000102cceccc9",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "my@host999",
      "hostWwn": "000000102cceccc9",
      "wwnNickname": "Myhostwwnsecret"
    }

    Attribute

    Type

    Description

    hostWwnId

    string

    Object ID for the WWN

    portId

    string

    Port number

    hostGroupNumber

    int

    Host group number of the port

    hostGroupName

    string

    Host group name of the port

    hostWwn

    string

    WWN of the host bus adapter registered for the host group

    wwnNickname

    string

    WWN nickname

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 GET https://192.0.2.100/ConfigurationManager/v1/objects/host-wwns/CL1-A,0,000000102cceccc9

Registering a WWN for the host group

The following request registers the host bus adapter WWN for the host group of the specified port.
Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/host-wwns
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    {
      "hostWwn": "210003e08b0256f9",
      "portId": "CL1-A",
      "hostGroupNumber": 5
    }

    Attribute

    Type

    Description

    hostWwn

    string

    (Required) The WWN of the host bus adapter

    Specify a hexadecimal number consisting of 16 characters. You can specify the number by using colons (:) as separators.

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) The host group number

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 registered WWN

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/host-wwns

Setting the nickname for a WWN

The following request sets the nickname for a WWN registered in the host group. You can also delete the nickname that is already set.
Execution permission

Storage Administrator (Provisioning)

Request line
PATCH base-URL/v1/objects/host-wwns/object-ID
Request message
  • Object ID

    Specify the value of hostWwnId that was obtained by the processing to get information about the WWN. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,hostWwn

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Host group number of the port

    hostWwn

    string

    (Required) WWN of the host bus adapter registered in the host group

  • Query parameters

    None.

  • Body

    When setting the nickname for the WWN:

    {
      "wwnNickname": "REST_API_Created"
    }

    When deleting the nickname from the WWN:

    {
      "wwnNickname": ""
    }

    Attribute

    Type

    Description

    wwnNickname

    string

    (Required) Specify a WWN nickname consisting of 1 to 64 characters.

    You can use the following characters.

    • Alphanumeric characters
    • The following symbols:

      . @ _ : , -

      The label cannot start with a hyphen (-).

    You cannot specify the nickname that is used for other WWN of the same port.

    To delete the nickname from the WWN, specify a null character string.

Response message
  • Body

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

    Attribute

    Description

    affectedResources

    URL of the WWN whose settings were changed

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-wwns/CL1-A,0,1212121212121212

Deleting the WWN from a host group

The following request deletes the WWN information registered for the host group of the specified port.
Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/v1/objects/host-wwns/object-ID
Request message
  • Object ID

    Specify the hostWwnId value obtained by getting information about the WWN. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,hostWwn

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) The host group number

    hostWwn

    string

    (Required) The WWN of the host bus adapter

    Specify the attribute without using colons (:).

  • Query parameters

    None.

  • Body

    None.

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 deleted WWN

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/host-wwns/CL1-A,5,210003e08b0256f9

Getting iSCSI names

Specifying a port and iSCSI target, the following request gets the iSCSI name information registered for the iSCSI target.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-iscsis
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Filter Condition

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Optional) Target ID of the iSCSI target

    You must specify one of the following parameters: this parameter, the hostGroupName parameter, or the hostGroupNumberList parameter.

    hostGroupName

    string

    (Optional) Name of the iSCSI target

    You must specify one of the following parameters: this parameter, the hostGroupNumber parameter, or the hostGroupNumberList parameter.

    hostGroupNumberList

    string

    (Optional) Target IDs of iSCSI targets

    You can obtain information quickly by specifying this parameter.

    To specify multiple IDs, delimit each ID by using a comma.

    You must specify one of the following parameters: this parameter, the hostGroupNumber parameter, or the hostGroupName parameter.

    displayHostGroupName

    boolean

    (Optional) If you specify the hostGroupNumberList parameter, specify whether to get the names of the iSCSI targets (the values of the hostGroupName attribute).

    If you specify false, the processing will take shorter than if you were to specify true.

    • true: Obtain the names of the iSCSI targets.
    • false: Do not obtain the names of the iSCSI targets.

    If you specify this parameter but do not specify the hostGroupNumberList parameter, this parameter will be ignored.

    If this parameter is omitted, the value true is assumed.

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
          "hostIscsiId": "CL1-D,1,iqn.1994-05.com.redhat%3A496799ba93",
          "portId": "CL1-D",
          "hostGroupNumber": 1,
          "hostGroupName": "1D-G00",
          "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
          "iscsiNickname": "a_a"
        },
        {
          "hostIscsiId": "CL1-D,1,iqn.1994-05.com.redhat%3Aa7526e46aac.target",
          "portId": "CL1-D",
          "hostGroupNumber": 1,
          "hostGroupName": "1D-G00",
          "iscsiName": "iqn.1994-05.com.redhat:a7526e46aac.target",
          "iscsiNickname": "a_a"
        }
      ]
    }

    Attribute

    Type

    Description

    hostIscsiId

    string

    Object ID for the iSCSI name

    portId

    string

    Port number

    hostGroupNumber

    int

    Target ID of the iSCSI target

    hostGroupName

    string

    Name of the iSCSI target

    This attribute will not be obtained if the hostGroupNumberList parameter is specified as a query parameter and false is specified for the displayHostGroupName parameter.

    iscsiName

    string

    iSCSI name of the host bus adapter (iSCSI initiator) registered for the iSCSI target

    iscsiNickname

    string

    iSCSI nickname

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/host-iscsis?portId=CL1-D&hostGroupNumber=1"

Getting information about a specific iSCSI name

If you specify a port, iSCSI target, and iSCSI name, the following request gets information about that specific iSCSI name.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-iscsis/object-ID
Request message
  • Object ID

    Specify the hostIscsiId value obtained by getting the iSCSI name. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,iscsiName

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Target ID of the iSCSI target

    iscsiName

    string

    (Required) iSCSI name of the host bus adapter (iSCSI initiator)

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "hostIscsiId": "CL1-D,1,iqn.1994-05.com.redhat%3A496799ba93",
      "portId": "CL1-D",
      "hostGroupNumber": 1,
      "hostGroupName": "1D-G00",
      "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
      "iscsiNickname": "a_a"
    }

    Attribute

    Type

    Description

    hostIscsiId

    string

    Object ID for the iSCSI name

    portId

    string

    Port number

    hostGroupNumber

    int

    Target ID of the iSCSI target

    hostGroupName

    string

    Name of the iSCSI target

    iscsiName

    string

    iSCSI name of the host bus adapter (iSCSI initiator) registered for the iSCSI target

    iscsiNickname

    string

    iSCSI nickname

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 GET https://192.0.2.100/ConfigurationManager/v1/objects/host-iscsis/CL1-D,1,iqn.1994-05.com.redhat%3A496799ba93

Registering the iSCSI name for the iSCSI target

For the iSCSI target of the specified port, the following request registers the iSCSI name of the host on the initiator side.
Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/host-iscsis
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    {
      "portId": "CL1-D",
      "hostGroupNumber": 1,
      "iscsiName": "iqn.myrestapiiscsi20150907"
    }

Attribute

Type

Description

iscsiName

string

(Required) iSCSI name of the host bus adapter (iSCSI initiator)

Specify this item in the iqn or eui format.

  • iqn format

    Specify a value in the range from 5 to 223. You can use the following characters:

    Alphanumeric characters (lowercase), periods (.), hyphens (-), and colons (:)

    Specification example: iqn.2014-04.jp.co.hitachi:xxx.h70.i.62510.1a.ff

  • eui format

    After "eui.", specify a hexadecimal number. Specify a value consisting of 20 characters.

    Specification example: eui.ABCDEF1234567890

portId

string

(Required) Port number

hostGroupNumber

int

(Required) Target ID of the iSCSI target

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 registered iSCSI name

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/host-iscsis

Setting the nickname for an iSCSI name

The following request sets the nickname for an iSCSI name registered for the iSCSI target. You can also delete the nickname that is already set.
Execution permission

Storage Administrator (Provisioning)

Request line
PATCH base-URL/v1/objects/host-iscsis/object-ID
Request message
  • Object ID

    Specify the value of hostIscsiId that was obtained by the processing to get information about the iSCSI name. You can also specify the attributes and connect them with commas as follows:

    portId,hostGroupNumber,iscsiName

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Target ID of the iSCSI target

    iscsiName

    string

    (Required) iSCSI name of the host bus adapter (iSCSI initiator) registered for the iSCSI target

  • Query parameters

    None.

  • Body

    When setting the nickname for the iSCSI name

    {
      "iscsiNickname": "REST_API_Testing"
    }

    When deleting the nickname from the iSCSI name:

    {
      "iscsiNickname": ""
    }

    Attribute

    Type

    Description

    iscsiNickname

    string

    (Required) Specify a nickname consisting of 1 to 32 characters for the iSCSI name of the host bus adapter.

    You can use the following characters.

    • Alphanumeric characters
    • The following symbols:

      . @ _ -

      The label cannot start with a hyphen (-).

    To delete the nickname from the iSCSI name, specify a null character string.

Response message
  • Body

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

    Attribute

    Description

    affectedResources

    URL of the iSCSI name whose settings were changed

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-iscsis/CL1-B,0,iqn.20150907

Deleting the iSCSI name from the iSCSI target

The following request deletes the iSCSI name of the host bus adapter (iSCSI initiator) from the iSCSI target of the specified port.
Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/v1/objects/host-iscsis/object-ID
Request message
  • Object ID

    Specify the hostIscsiId value obtained by getting the iSCSI name. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,iscsiName

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Target ID of the iSCSI target

    iscsiName

    string

    (Required) iSCSI name of the host bus adapter (iSCSI initiator)

  • Query parameters

    None.

  • Body

    None.

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 deleted iSCSI name

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/host-iscsis/CL1-D,1,iqn.myrestapiiscsi20150907

Getting information about CHAP users

Using the specified port and iSCSI target, the following request gets the CHAP user information that is specified for the iSCSI target. Note that if the iSCSI target name or CHAP user name contains a single-byte space, the CHAP user name cannot be obtained.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/chap-users
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Filter Condition

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Target ID of the iSCSI target

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
          "chapUserId": "CL1-D,0,INI,TESTing",
          "portId": "CL1-D",
          "hostGroupNumber": 0,
          "hostGroupName": "1D-G00",
          "chapUserName": "TESTing",
          "wayOfChapUser": "INI"
        },
        {
          "chapUserId": "CL1-D,0,TAR,mychap",
          "portId": "CL1-D",
          "hostGroupNumber": 0,
          "hostGroupName": "1D-G00",
          "chapUserName": "mychap",
          "wayOfChapUser": "TAR"
        }
      ]
    }

    Attribute

    Type

    Description

    chapUserId

    string

    Object ID for the CHAP user

    portId

    string

    Port number

    hostGroupNumber

    int

    Target ID of the iSCSI target

    hostGroupName

    string

    Name of the iSCSI target

    chapUserName

    string

    CHAP user name

    wayOfChapUser

    string

    Type of the CHAP user name

    • TAR: The CHAP user name of the iSCSI target side
    • INI: The CHAP user name of the host bus adapter (iSCSI initiator) side
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 GET "https://192.0.2.100/ConfigurationManager/v1/objects/chap-users?portId=CL1-D&hostGroupNumber=0"

Getting information about a specific CHAP user

The following request gets information about the specified CHAP user. Note that if the iSCSI target name or CHAP user name contains a space, the CHAP user name cannot be obtained.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/chap-users/object-ID
Request message
  • Object ID

    Specify the chapUserId value obtained by getting information about the CHAP user. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,wayOfChapUser,chapUserName 

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Target ID of the iSCSI target

    wayOfChapUser

    string

    (Required) Type of the CHAP user name

    • TAR: The CHAP user name of the iSCSI target side
    • INI: The CHAP user name of the host bus adapter (iSCSI initiator) side

    chapUserName

    string

    (Required) The CHAP user name

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "chapUserId": "CL1-D,0,INI,mychap",
      "portId": "CL1-D",
      "hostGroupNumber": 0,
      "hostGroupName": "1D-G00",
      "chapUserName": "mychap",
      "wayOfChapUser": "INI"
    }

    Attribute

    Type

    Description

    chapUserId

    string

    Object ID for the CHAP user

    portId

    string

    Port number

    hostGroupNumber

    int

    Target ID of the iSCSI target

    hostGroupName

    string

    Name of the iSCSI target

    chapUserName

    string

    CHAP user name

    wayOfChapUser

    string

    Type of the CHAP user name

    • TAR: The CHAP user name of the iSCSI target side
    • INI: The CHAP user name of the host bus adapter (iSCSI initiator) side
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 GET https://192.0.2.100/ConfigurationManager/v1/objects/chap-users/CL1-D,0,INI,mychap

Setting the CHAP user name for the iSCSI target

The following request sets the CHAP user name for the iSCSI target. Two types of CHAP user names can be set: the CHAP user name of the iSCSI target side and the CHAP user name of the host (iSCSI initiator) that connects to the iSCSI target.
Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/chap-users
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    The following coding example sets the CHAP user name for the iSCSI target side:

    {
      "chapUserName": "MyRESTChapUser",
      "portId": "CL1-D",
      "hostGroupNumber": 1,
      "wayOfChapUser": "TAR"
    }

    Attribute

    Type

    Description

    chapUserName

    string

    (Required) Specify a CHAP user name consisting of 1 to 223 characters.

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Target ID of the iSCSI target

    wayOfChapUser

    string

    (Required) Type of the CHAP user name

    • TAR: The CHAP user name of the iSCSI target side
    • INI: The CHAP user name of the host bus adapter (iSCSI initiator) side
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 created CHAP user name

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/chap-users

Setting a secret for the CHAP user

The following request sets a secret for the specified CHAP user. If a secret is already set for the specified CHAP user, the current secret is overwritten.
Execution permission

Storage Administrator (Provisioning)

Request line
PATCH base-URL/v1/objects/chap-users/object-ID
Request message
  • Object ID

    Specify the chapUserId value obtained by getting information about the CHAP user. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,wayOfChapUser,chapUserName 

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Target ID of the iSCSI target

    wayOfChapUser

    string

    (Required) Type of the CHAP user name

    • TAR: The CHAP user name of the iSCSI target side
    • INI: The CHAP user name of the host bus adapter (iSCSI initiator) side

    chapUserName

    string

    (Required) The CHAP user name

  • Query parameters

    None.

  • Body

    When setting the secret password for the CHAP user:

    {
      "chapPassword": "TopSecretForMyChap"
    }

    When resetting the secret password of the CHAP user:

    {
      "chapPassword": ""
    }

    Attribute

    Type

    Description

    chapPassword

    string

    Specify a secret consisting of 12 to 32 characters for the specified CHAP user.

    If you specify a null character, the password is reset.

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 CHAP user name for which the secret was set

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/chap-users/CL1-D,1,TAR,MyRESTChapUser

Deleting the CHAP user from the iSCSI target

The following request deletes the CHAP user name specified for the iSCSI target.
Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/v1/objects/chap-users/object-ID
Request message
  • Object ID

    Specify the chapUserId value obtained by getting information about the CHAP user. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,wayOfChapUser,chapUserName 

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Target ID of the iSCSI target

    wayOfChapUser

    string

    (Required) Type of the CHAP user name

    • TAR: The CHAP user name of the iSCSI target side
    • INI: The CHAP user name of the host bus adapter (iSCSI initiator) side

    chapUserName

    string

    (Required) The CHAP user name

  • Query parameters

    None.

  • Body

    None.

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 deleted CHAP user name

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/chap-users/CL1-D,1,TAR,MyRESTChapUser

Getting information about LU paths

The following request gets information about LU paths defined for the iSCSI target or the host group for the port.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/luns
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Filter Condition

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Host group number (for an iSCSI target, this is the target ID)

    You must specify either this parameter or the hostGroupNumberList parameter.

    isBasicLunInformation

    boolean

    (Optional) Specify whether to get only basic information.

    • true: Gets only basic information. (Does not get the host reservation status.)
    • false: Gets all the items.

    If this parameter is omitted, false is assumed.

    lunOption

    string

    (Optional) Specify the type of information you want to get.

    • ALUA: Gets information about ALUA settings.

    If you specify both this parameter and the hostGroupNumberList parameter, this parameter will be ignored.

    hostGroupNumberList

    string

    (Optional) Host group number (for an iSCSI target, this is the target ID)

    You can obtain information quickly by specifying this parameter. If you specify this parameter, the value of the hostModeOptions attribute is not obtained.

    To specify multiple IDs, delimit each ID by using a comma.

    You must specify either this parameter or the hostGroupNumber parameter.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when only basic information is obtained:

    {
      "data": [
        {
          "lunId": "CL1-A,1,1",
          "portId": "CL1-A",
          "hostGroupNumber": 1,
          "hostMode": "LINUX/IRIX",
          "lun": 1,
          "ldevId": 1,
          "isCommandDevice": false
        },
        {
          "lunId": "CL1-A,1,2",
          "portId": "CL1-A",
          "hostGroupNumber": 1,
          "hostMode": "LINUX/IRIX",
          "lun": 2,
          "ldevId": 2,
          "isCommandDevice": false
        }
      ]
    }

    The following is an example of the output generated when getting information about all items:

    {
      "data": [
        {
          "lunId": "CL1-A,1,1",
          "portId": "CL1-A",
          "hostGroupNumber": 1,
          "hostMode": "LINUX/IRIX",
          "lun": 1,
          "ldevId": 1,
          "isCommandDevice": false,
          "luHostReserve": {
            "openSystem": false,
            "persistent": false,
            "pgrKey": false,
            "mainframe": false,
            "acaReserve": false
          }
        }
      ]
    }

    Attribute

    Type

    Description

    lunId

    string

    Object ID for the LUN

    portId

    string

    Port number

    hostGroupNumber

    int

    Host group number of the port (for an iSCSI target, this is the target ID)

    hostMode

    string

    Host mode for setting the host adapter of the host group

    For details on the values to be obtained, see the description of the API function for changing the host group or iSCSI target settings.

    lun

    int

    LUN between the host group and the mapped LDEV

    ldevId

    int

    LDEV number

    isCommandDevice

    boolean

    Gets information about whether the device is a command device.

    luHostReserve

    object

    Host reservation status of the LU

    When false is specified for isBasicLunInformation and the LU is in the reserved status, the following attributes are output:

    • openSystem (boolean)

      Indicates whether the LU is reserved for open systems.

    • persistent (boolean)

      Indicates whether the LU is in the persistent reservation status.

    • pgrKey (boolean)

      Indicates whether the LU is reserved by a PGR key.

    • mainframe (boolean)

      Indicates whether the LU is reserved for mainframes.

    • acaReserve (boolean)

      Indicates whether the LU is in the ACA reservation status.

    hostModeOptions

    int[]

    Number of the host mode option set for the host group

    This is not output if a host mode option is not set.

    This attribute is not output if hostGroupNumberList is specified as a query parameter.

    For details on the number to be obtained, see the Provisioning Guide for Open Systems , or the Provisioning Guide .

    isAluaEnabled

    boolean

    Whether the ALUA attribute is enabled:

    This attribute is displayed only if you specified ALUA for lunOption in the query parameters.

    • true: The ALUA attribute is enabled.
    • false: The ALUA attribute is disabled.

    asymmetricAccessState

    string

    Priority level of the ALUA path

    This attribute is displayed only if you specified ALUA for lunOption in the query parameters.

    • Active/Optimized: Higher priority
    • Active/Non-Optimized: Lower priority
    • Not Supported: Not supported
Status codes

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

Coding example

When getting only basic information:

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/luns?portId=CL1-A&hostGroupNumber=1&isBasicLunInformation=true"

When getting information about all items:

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/luns?portId=CL1-A&hostGroupNumber=1"

Getting information about a specific LU path

The following request gets information about the specified LU path.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/luns/object-ID
Request message
  • Object ID

    Specify the lunId value obtained by getting information about the LU path. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,lun

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Host group number (target ID for an iSCSI port)

    lun

    int

    (Required) LUN

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "lunId": "CL1-A,1,1",
      "portId": "CL1-A",
      "hostGroupNumber": 1,
      "hostMode": "LINUX/IRIX",
      "lun": 1,
      "ldevId": 1,
      "isCommandDevice": false,
      "luHostReserve": {
        "openSystem": false,
        "persistent": false,
        "pgrKey": false,
        "mainframe": false,
        "acaReserve": false
      },
      "hostModeOptions": [
        2,
        6
      ]
    }

    Attribute

    Type

    Description

    lunId

    string

    Object ID for the LUN

    portId

    string

    Port number

    hostGroupNumber

    int

    Host group number of the port (for an iSCSI target, this is the target ID)

    hostMode

    string

    Host mode for setting the host adapter of the host group

    For details on the values to be obtained, see Changing the host group or iSCSI target settings.

    lun

    int

    LUN between the host group and the mapped LDEV

    ldevId

    int

    LDEV number

    isCommandDevice

    boolean

    Information about whether the device is a command device is output.

    luHostReserve

    object

    Host reservation status of the LU

    • openSystem (boolean)

      Indicates whether the LU is reserved for open systems.

    • persistent (boolean)

      Indicates whether the LU is in the persistent reservation status.

    • pgrKey (boolean)

      Indicates whether the LU is reserved by a PGR key.

    • mainframe (boolean)

      Indicates whether the LU is reserved for mainframes.

    • acaReserve (boolean)

      Indicates whether the LU is in the ACA reservation status.

    hostModeOptions

    int[]

    Number of the host mode option set for the host group

    This is not output if a host mode option is not set.

    For details on the number to be obtained, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

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 GET https://192.0.2.100/ConfigurationManager/v1/objects/luns/CL1-A,1,1

Sending the ping command to a specified host

The request below checks the connection status of a storage system and a host by sending the ping command from a specified iSCSI port on the storage system to the host.
Execution permission

Storage Administrator (View Only)

Request line
POST base-URL/v1/objects/ports/object-ID/actions/ping/invoke
Request message
  • Object ID

    Specify the portId value obtained by getting information about the port.

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

  • Query parameters

    None.

  • Body

    {
      "parameters" : {
        "ipAddress" : "192.168.0.100"
      }
    }
    

    Attribute

    Type

    Description

    ipAddress

    string

    (Required) IP address of the target host

    You can specify an IPv4 address or IPv6 address.

Response message
  • Body

    {
        "transmittedPackets": 5,
        "receivedPackets": 5
    }
    

    Attribute

    Type

    Description

    transmittedPackets

    int

    Number of sent packets

    receivedPackets

    int

    Number of received packets

Action template

None.

Status codes

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.

Status code

Message

Description

503

Service unavailable

The port on the storage system is busy.

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/ports/CL1-A/actions/ping/invoke

Setting the LU path

The following request sets the LU path by mapping the LDEV with the LUN in the host group or in the iSCSI target of the specified port.
Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/luns
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    The following coding example sets an LU path by specifying the LUN:

    {
      "portIds": ["CL1-A","CL2-A"],
      "hostGroupNumber": 1,
      "ldevId": 64,
      "lun": 12
    }

    The following coding example sets an LU path without specifying the LUN:

    {
      "portId": "CL1-A",
      "hostGroupNumber": 1,
      "ldevId": 64
    }

    Attribute

    Type

    Description

    portId

    string

    (Optional) Port number

    Specify this attribute when setting the LU path for one port.

    This attribute cannot be specified at the same time as the portIds attribute. You must specify either the portId attribute or the portIds attribute.

    portIds

    string[]

    (Optional) Port number

    Specify this attribute when setting the LU paths for multiple ports at the same time. You can specify up to 6 port numbers.

    This attribute cannot be specified at the same time as the portId attribute. You must specify either the portId attribute or the portIds attribute.

    hostGroupNumber

    int

    (Required) Host group number (target ID for an iSCSI port)

    lun

    int

    (Optional) LUN

    If this attribute is omitted, a value is automatically set.

    You cannot specify the same LUN for multiple LDEVs.

    ldevId

    int

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

    An LDEV cannot be mapped to another LUN in the same host group.

    For host groups for which host mode option 60 is enabled, if you specify portId but omit lun, automatic configuration of LUNs might fail. If this happens, try the operation again, but specify portIds instead of portId.

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 created LU path

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/luns

Setting the priority levels of ALUA paths

For a global-active device in a cross-path configuration (using a Fibre Channel connection), by enabling the ALUA attribute, you can set the priority levels of paths between a host and a storage system.
Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/services/lun-service/actions/change-asymmetric-access-state/invoke
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    {
      "parameters": {
        "portId" : "CL1-A",
        "hostGroupNumber" : 1,
        "asymmetricAccessState" : "Active/Optimized"
      }
    }

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Host group number

    asymmetricAccessState

    string

    (Required) Priority level of the ALUA path

    • Active/Optimized: Higher priority
    • Active/Non-Optimized: Lower priority
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 for getting information about LU paths

    You can get information about the priority level of an ALUA path by specifying lunOption=ALUA in the query parameters of the API function for getting information about LU paths.

Action template

None.

Status codes

For details on the status codes of the request for this operation, see the description of 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/services/lun-service/actions/change-asymmetric-access-state/invoke

Deleting a LU path

The following request deletes the LU path defined for the host group or iSCSI target of the specified port.
Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/v1/objects/luns/object-ID
Request message
  • Object ID

    Specify the lunId value obtained by getting information about the LU path. You can also specify the following attributes and connect them with commas:

    portId,hostGroupNumber,lun

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Host group number (target ID for an iSCSI port)

    lun

    int

    (Required) LUN

  • Query parameters

    None.

  • Body

    None.

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 deleted LU path

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/luns/CL1-A,1,64

Getting NVM subsystem information

The following request gets NVM subsystem information.
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/nvm-subsystems
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Description

    nvmSubsystemInfo

    string

    (Optional) Type of information to be obtained

    The specifiable values are as follows:

    • basic

      Gets basic information about the NVM subsystem.

    • nqn

      Gets information about the subsystem NQN of the NVM subsystem.

    • namespace

      Gets information about the namespace created in the NVM subsystem.

    • port

      Gets information about the port registered in the NVM subsystem.

    Gets only information about the implemented NVM subsystem.

    If this parameter is omitted, the value basic is assumed.

    You cannot specify this parameter at the same time as the nvmSubsystemOption parameter.

    nvmSubsystemOption

    string

    (Optional) Condition of the NVM subsystem for which information is to be obtained

    The following value can be input as a condition.

    • undefined

      Gets the NVM subsystem IDs of unimplemented NVM subsystems.

    You cannot specify this parameter at the same time as the nvmSubsystemInfo parameter.

  • Body

    None.

Response message
  • Body

    The following is an example of output when basic information is obtained by specifying basic in the query parameter nvmSubsystemInfo, or if the query parameter is not specified.

    {
       "data": [
           {
              "nvmSubsystemId":1,
              "nvmSubsystemName":"rest_subsystem",
              "resourceGroupId":0,
              "namespaceSecuritySetting":"Enable",
              "t10piMode":"Disable",
              "hostMode":"LINUX/IRIX",
              "hostModeOptions":[132,133]
           },
           ...
       ]
    }

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    NVM subsystem ID

    nvmSubsystemName

    string

    NVM subsystem name

    resourceGroupId

    int

    Resource group ID of the resource group to which the NVM subsystem belongs

    namespaceSecuritySetting

    string

    Namespace security settings

    • Enable: Enabled
    • Disable: Disabled
    • Unknown: Status unknown (unsupported)

    t10piMode

    string

    Status of the T10 PI mode of the port

    • Enable: Enabled
    • Disable: Disabled
    • Unknown: Status unknown (unsupported)

    hostMode

    string

    Host mode of the NVM subsystem

    This is not output if a host mode is not set.

    hostModeOptions

    int[]

    Number of the host mode option set for the NVM subsystem

    This is not output if a host mode option is not set.

    For details on the number to be obtained, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

    The following is an example of output when subsystem NQN information is obtained by specifying nqn in the query parameter nvmSubsystemInfo.

    {
       "data": [
           {
              "nvmSubsystemId":1,
              "nvmSubsystemName":"rest_subsystem",
              "nvmSubsystemNqn":"nqn.2015-04.com.example:nvme:storage-subsystem-sn.5-10088-nvmssid.00001"
           },
           ...
       ]
    }

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    NVM subsystem ID

    nvmSubsystemName

    string

    NVM subsystem name

    nvmSubsystemNqn

    string

    subsystem NQN

    The following is an example of output when namespace information is obtained by specifying namespace in the query parameter nvmSubsystemInfo.

    {
       "data": [
           {
               "nvmSubsystemId":1,
               "nvmSubsystemName":"rest_subsystem",
               "namespaces":[
                   {
                    "namespaceId":1,
                    "ldevId:2000
                   },
                   {
                    "namespaceId":2,
                    "ldevId:2001
                   },
                   {
                    "namespaceId":3,
                    "ldevId:2002
                   }
                ]
           },
           ...
       ]
    }

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    NVM subsystem ID

    nvmSubsystemName

    string

    NVM subsystem name

    namespaces

    object[]

    Outputs the following attributes related to a namespace created in the NVM subsystem.

    • namespaceId (int)

      Namespace ID

    • ldevId (int)

      LDEV number

    The following is an example of output when port information is obtained by specifying port in the query parameter nvmSubsystemInfo.

    {
       "data": [
           {
             "nvmSubsystemId":1,
             "nvmSubsystemName":"rest_subsystem",
             "portIds":["CL1-A","CL1-B"]
           },
           ...
       ]
    }

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    NVM subsystem ID

    nvmSubsystemName

    string

    NVM subsystem name

    portIds

    string[]

    Port number

    The following is an example of output when the NVM subsystem IDs of unimplemented NVM subsystems by specifying undefined in the query parameter nvmSubsystemOption.

    {
       "data": [
           {
             "nvmSubsystemId":3
           },
           {
             "nvmSubsystemId":4
           },
           ...
       ]
    }

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    NVM subsystem ID

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/nvm-subsystems?nvmSubsystemInfo=basic

Getting information about a specific NVM subsystem

The following request gets information about a specific NVM subsystem.
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/nvm-subsystems/object-ID
Request message
  • Object ID

    Specify the nvmSubsystemId value obtained by getting NVM subsystem information.

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    (Required) NVM subsystem ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
          "nvmSubsystemId" : 1,
          "nvmSubsystemName" : "rest_subsystem",
          "resourceGroupId" : 0,
          "namespaceSecuritySetting" : "Enable",
          "t10piMode" : "Disable",
          "hostMode" : "LINUX/IRIX",
          "hostModeOptions":[132,133],
          "nvmSubsystemNqn" : "nqn.2015-04.com.example:nvme:storage-subsystem-sn.5-10088-nvmssid.00001",
          "namespaces" : [
                {
                  "namespaceId" : 1,
                  "ldevId" : 2000
                },
                {
                  "namespaceId" : 2,
                  "ldevId" : 2001
                },
                {
                  "namespaceId" : 3,
                  "ldevId" : 2002
                }
            ],
          "portIds" : [ "CL1-A", "CL1-B" ]
    }

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    NVM subsystem ID

    nvmSubsystemName

    string

    NVM subsystem name

    resourceGroupId

    int

    Resource group ID of the resource group to which the NVM subsystem belongs

    namespaceSecuritySetting

    string

    Namespace security settings

    • Enable: Enabled
    • Disable: Disabled
    • Unknown: Status unknown (unsupported)

    t10piMode

    string

    Status of the T10 PI mode of the port

    • Enable: Enabled
    • Disable: Disabled
    • Unknown: Status unknown (unsupported)

    hostMode

    string

    Host mode of the NVM subsystem

    This is not output if a host mode is not set.

    hostModeOptions

    int[]

    Number of the host mode option set for the NVM subsystem

    This is not output if a host mode option is not set.

    For details on the number to be obtained, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

    nvmSubsystemNqn

    string

    subsystem NQN

    namespaces

    object[]

    Outputs the following attributes related to a namespace created in an NVM subsystem.

    • namespaceId (int)

      Namespace ID

    • ldevId (int)

      LDEV number

    This is not output if no namespace is created.

    portIds

    string[]

    Port number

    This is not output if no port is registered.

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/nvm-subsystems/1

Getting NVM subsystem port information

The following request gets NVM subsystem port information.
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/nvm-subsystem-ports
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Description

    nvmSubsystemId

    int

    (Optional) NVM subsystem ID

    Specify a value from 0 to 2047.

    You cannot specify this parameter and the portId parameter at the same time. You must specify either this parameter or the portId parameter.

    portId

    string

    (Optional) Port number

    You cannot specify this parameter and the nvmSubsystemId parameter at the same time. You must specify either this parameter or the nvmSubsystemId parameter.

  • Body

    None.

Response message
  • Body

    {
      "data": [
          {
              "nvmSubsystemPortId":"1,CL1-A",
              "nvmSubsystemId":1,
              "portId":"CL1-A"
          },
          {
              "nvmSubsystemPortId":"1,CL1-B",
              "nvmSubsystemId":1,
              "portId":"CL1-B"
          }
      ]
    }

    Attribute

    Type

    Description

    nvmSubsystemPortId

    string

    Object ID of the NVM subsystem port

    The following attributes are output, separated by commas:

    • nvmSubsystemId
    • portId

    nvmSubsystemId

    int

    NVM subsystem ID

    portId

    string

    Port number

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/nvm-subsystem-ports?nvmSubsystemId=1

Getting information about a specific NVM subsystem port

The following request gets information about a specific NVM subsystem port.
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/nvm-subsystem-ports/object-ID
Request message
  • Object ID

    Specify the nvmSubsystemPortId value obtained by getting NVM subsystem port information. You can also specify the following attributes and connect them with commas:

    nvmSubsystemId,portId

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    (Required) NVM subsystem ID

    portId

    string

    (Required) Port number

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
        "nvmSubsystemPortId":"1,CL1-A",
        "nvmSubsystemId":1,
        "portId":"CL1-A"
    }

    Attribute

    Type

    Description

    nvmSubsystemPortId

    string

    Object ID of the NVM subsystem port

    The following attributes are output, separated by commas:

    • nvmSubsystemId
    • portId

    nvmSubsystemId

    int

    NVM subsystem ID

    portId

    string

    Port number

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/nvm-subsystem-ports/1,CL1-A

Getting host NQN information

The following request gets host NQN information.
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/host-nqns
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Description

    nvmSubsystemId

    int

    (Required) NVM subsystem ID

    Specify a value from 0 to 2047.

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
            "hostNqnId":
    "1,nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa39",
            "hostNqn":
    "nqn.2014-08.org.example:uuid:4b73e622-ddc1-449a-99f7-412c0d3baa39",
            "nvmSubsystemId":1,
            "hostNqnNickname":"myhost1"
        },
        {
            "hostNqnId":
    "1,nqn.2014-08.org.example:uuid:f4d3488e-6986-4342-b693-9ecf5257e55d",
            "hostNqn":
    "nqn.2014-08.org.example:uuid:f4d3488e-6986-4342-b693-9ecf5257e55d",
            "nvmSubsystemId":1,
            "hostNqnNickname":"myhost2"
        }
      ]
    }

    Attribute

    Type

    Description

    hostNqnId

    string

    Object ID of the host NQN

    The following attributes are output, separated by commas:

    • nvmSubsystemId
    • hostNqn

    hostNqn

    string

    Host NQN

    nvmSubsystemId

    int

    NVM subsystem ID

    hostNqnNickname

    string

    Host NQN nickname

    If the host NQN nickname is not set, a hyphen (-) is output.

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/host-nqns?nvmSubsystemId=1

Getting information about a specific host NQN

The following request gets information about a specific host NQN.
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/host-nqns/object-ID
Request message
  • Object ID

    Specify the hostNqnId value obtained by getting host NQN information. You can also specify the following attributes and connect them with commas:

    nvmSubsystemId,hostNqn

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    (Required) NVM subsystem ID

    hostNqn

    string

    (Required) Host NQN

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
          "hostNqnId":
    "1,nqn.2014-08.org.example:uuid:ff533865-1d0b-4043-8345-a90afbb80d8b",
          "hostNqn":
    "nqn.2014-08.org.example:uuid:ff533865-1d0b-4043-8345-a90afbb80d8b",
          "nvmSubsystemId":1,
          "hostNqnNickname":"myhost1"
    }

    Attribute

    Type

    Description

    hostNqnId

    string

    Object ID of the host NQN

    The following attributes are output, separated by commas:

    • nvmSubsystemId
    • hostNqn

    hostNqn

    string

    Host NQN

    nvmSubsystemId

    int

    NVM subsystem ID

    hostNqnNickname

    string

    Host NQN nickname

    If the host NQN nickname is not set, a hyphen (-) is output.

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/host-nqns/1,nqn.2014-08.org.example:uuid:ff533865-1d0b-4043-8345-a90afbb80d8b

Getting namespace information

The following request gets namespace information.
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/namespaces
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Description

    nvmSubsystemId

    int

    (Required) NVM subsystem ID

  • Body

    None.

Response message
  • Body

    {
        "data":[
                 {
                   "namespaceObjectId":"1,1",
                   "namespaceId":1,
                   "namespaceNickname":"restns11",
                   "nvmSubsystemId":1,
                   "nvmSubsystemName":"rest_subsystem",
                   "ldevId":2000,
                   "byteFormatCapacity":"1.00 G",
                   "blockCapacity":2097152
                 },
                 {
                   "namespaceObjectId":"1,2",
                   "namespaceId":2,
                   "namespaceNickname":"restns12",
                   "nvmSubsystemId":1,
                   "nvmSubsystemName":"rest_subsystem",
                   "ldevId":2001,
                   "byteFormatCapacity":"1.00 G",
                   "blockCapacity":2097152
                 }
         ]
    }

    Attribute

    Type

    Description

    namespaceObjectId

    string

    Object ID of the namespace

    The following attributes are output, separated by commas:

    • nvmSubsystemId
    • namespaceId

    namespaceId

    int

    Namespace ID

    namespaceNickname

    string

    Namespace nickname

    If the namespace nickname is not set, a hyphen (-) is output.

    nvmSubsystemId

    int

    NVM subsystem ID

    nvmSubsystemName

    string

    NVM subsystem name

    ldevId

    int

    LDEV number

    LDEV number of the volume where the namespace is set

    byteFormatCapacity

    string

    Capacity of the namespace

    blockCapacity

    long

    Number of blocks of the namespace

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/namespaces?nvmSubsystemId=1

Getting information about a specific namespace

The following request gets information about a specific namespace.
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/namespaces/object-ID
Request message
  • Object ID

    Specify the namespaceObjectId value obtained by getting namespace information. You can also specify the following attributes and connect them with commas:

    nvmSubsystemId,namespaceId

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    (Required) NVM subsystem ID

    namespaceId

    int

    (Required) Namespace ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
             "namespaceObjectId":"1,1",
             "namespaceId":1,
             "namespaceNickname":"restns11",
             "nvmSubsystemId":1,
             "nvmSubsystemName":"rest_subsystem",
             "ldevId":2000,
             "byteFormatCapacity":"1.00 G",
             "blockCapacity":2097152
        }

    Attribute

    Type

    Description

    namespaceObjectId

    string

    Object ID of the namespace

    The following attributes are output, separated by commas:

    • nvmSubsystemId
    • namespaceId

    namespaceId

    int

    Namespace ID

    namespaceNickname

    string

    Namespace nickname

    If the namespace nickname is not set, a hyphen (-) is output.

    nvmSubsystemId

    int

    NVM subsystem ID

    nvmSubsystemName

    string

    NVM subsystem name

    ldevId

    int

    LDEV number

    LDEV number of the volume where the namespace is set

    byteFormatCapacity

    string

    Capacity of the namespace

    blockCapacity

    long

    Number of blocks of the namespace

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/namespaces/1,1

Getting Host-namespace path information

The following request gets Host-namespace path information (information related to the namespace and host NQN) by specifying the NVM subsystem.

Depending on the number of resources for which you are getting information, one API request might not be able to get all the information. To get the remaining information, see the explanations of the hasNext attribute and the NextId attribute.

Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/namespace-paths
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Description

    nvmSubsystemId

    int

    (Required) NVM subsystem ID

    Specify a value from 0 to 2047.

    namespaceId

    int

    (Optional) Namespace ID

    For the VSP 5000 series, specify a value from 1 to 4096. For VSP E1090 and VSP E1090H, specify a value from 1 to 2048.

    You cannot specify this parameter at the same time as the headId parameter.

    headId

    string

    (Optional) Namespace object ID

    Specify the object ID of the Host-namespace path where the getting of the information starts.

    You cannot specify this parameter at the same time as the namespaceId parameter.

    If both this parameter and namespaceId parameter are omitted, the request gets information from the beginning of the information.

  • Body

    None.

Response message
  • Body

    {
        "data": [
            {
                "namespacePathId":"1,nqn.2014-08.org.example:uuid:
    ff533865-1d0b-4043-8345-a90afbb80d8b,2",
                "nvmSubsystemId":1,
                "hostNqn":"nqn.2014-08.org.example:uuid:
    ff533865-1d0b-4043-8345-a90afbb80d8b",
                "namespaceId":2,
                "ldevId":10
            },
            {
                "namespacePathId":"1,nqn.2014-08.org.example:uuid:
    ff533865-1d0b-4043-8345-a90afbb80d8b,3",
                "nvmSubsystemId":1,
                "hostNqn":"nqn.2014-08.org.example:uuid:
    ff533865-1d0b-4043-8345-a90afbb80d8b",
                "namespaceId":3,
                "ldevId":11
            },
            ...
        ],
        "hasNext":true
        "nextId":"1,nqn.2014-08.org.example:uuid:
    ff533865-1d0b-4043-8345-a90afbb80d8b,42"
    }

    Attribute

    Type

    Description

    namespacePathId

    string

    Object ID of the Host-namespace path

    The following attributes are output, separated by commas:

    • nvmSubsystemId
    • hostNqn
    • namespaceId

    nvmSubsystemId

    int

    NVM subsystem ID

    hostNqn

    string

    Host NQN

    namespaceId

    int

    Namespace ID

    ldevId

    int

    LDEV number

    LDEV number of the volume where the namespace is set

    This API request outputs the following attributes, in accordance with the data object.

    Attribute

    Type

    Description

    hasNext

    boolean

    Whether or not there is information that this API request could not get.

    • true: There is information that this API request could not get.
    • false: The request could get all the information.

    For the VSP 5000 series, false is always output.

    nextId

    string

    ID for getting continued information if there is information this API request could not get yet.

    If the API request could not get all the information at one time, by specifying this value in the query parameter headId and rerunning the API request, you can get the next information.

    This information is not output if the hasNext attribute is false.

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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/namespace-paths?nvmSubsystemId=1

Getting information about a Host-namespace path

The following request gets specific Host-namespace path information (information related to the namespace and host NQN).
Note

This API request can be used when the storage system is VSP 5000 series, VSP E1090, VSP E1090H.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/namespace-paths/object-ID
Request message
  • Object ID

    Specify the namespacePathId value obtained by getting Host-namespace path information. You can also specify the following attributes and connect them with commas:

    nvmSubsystemId,hostNqn,namespaceId

    Attribute

    Type

    Description

    nvmSubsystemId

    int

    (Required) NVM subsystem ID

    hostNqn

    string

    (Required) Host NQN

    namespaceId

    int

    (Required) Namespace ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
              "namespacePathId":"1,nqn.2014-08.org.example:uuid:
    ff533865-1d0b-4043-8345-a90afbb80d8b,2",
              "nvmSubsystemId":1,
              "hostNqn":"nqn.2014-08.org.example:uuid:
    ff533865-1d0b-4043-8345-a90afbb80d8b",
              "namespaceId":2,
              "ldevId":10
    }

    Attribute

    Type

    Description

    namespacePathId

    string

    Object ID of the Host-namespace path

    The following attributes are output, separated by commas:

    • nvmSubsystemId
    • hostNqn
    • namespaceId

    nvmSubsystemId

    int

    NVM subsystem ID

    hostNqn

    string

    Host NQN

    namespaceId

    int

    Namespace ID

    ldevId

    int

    LDEV number

    LDEV number of the volume where the namespace is 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 b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/namespace-paths/1,nqn.2014-08.org.example:uuid:ff533865-1d0b-4043-8345-a90afbb80d8b,2

Setting the command device

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

Getting a list of MP information

The request below obtains a list of MP location information.
Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/mps
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
        "data": [
            {
                "mpId": 0,
                "mpLocationId": "MP10-00",
                "mpUnitId": "MPU-10",
                "ctl": "ctl1"
            },
            {
                "mpId": 1,
                "mpLocationId": "MP10-01",
                "mpUnitId": "MPU-10",
                "ctl": "ctl1"
            },
            {
                "mpId": 4,
                "mpLocationId": "MP20-00",
                "mpUnitId": "MPU-20",
                "ctl": "ctl2"
            },
            {
                "mpId": 5,
                "mpLocationId": "MP20-01",
                "mpUnitId": "MPU-20",
                "ctl": "ctl2"
            }
        ]
    }
    

    Attribute

    Type

    Description

    mpId

    int

    MP ID

    mpLocationId

    string

    MP location number

    mpUnitId

    string

    MP unit ID

    ctl

    string

    Controller location information

    cbx

    int

    CBX number

    For the following storage system models, -1 is output to indicate an invalid value: VSP E series, VSP G350, G370, G700, G900 and VSP F350, F370, F700, F900.

Status codes

For details on the status codes of the request for this operation, see the description of 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/mps

Releasing the host reservation status by specifying the LU path

The following request releases the host reservation status of the LU mapped to a specified LU path. Use this API in situations when the host reservation status on the LU could not be released when there is a failure due to a problem on the host side.
Execution permission

Storage Administrator (System Resource Management)

Request line
POST base-URL/v1/objects/luns/object-ID/actions/release-lu-host-reserve/invoke
Request message
  • Object ID

    Specify the lunId value from the LU path information. You can also specify a combination of attribute values in the following format:

    portId, hostGroupNumber, lun

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Host group number (target ID for an iSCSI port)

    lun

    int

    (Required) LUN

  • Query parameters

    None.

  • Body

    None.

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 path of the LU whose host reservation status is to be released

Action template

None.

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 "Content-type:application/json" -H "Accept:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/luns/CL1-A,1,0/actions/release-lu-host-reserve/invoke -d ""

Releasing the host reservation status by specifying a host group

The following request releases the host reservation status for all LUs mapped to the specified host group or iSCSI target. Use this API in situations such as when the host reservation status on LUs could not be released because of some reason, such as a failure.
Execution permission

Storage Administrator (System Resource Management)

Request line
POST base-URL/v1/objects/host-groups/object-ID/actions/release-lu-host-reserves/invoke
Request message
  • Object ID

    Specify the hostGroupId value obtained by the processing to obtain information about host groups or about iSCSI targets. You can also specify a combination of attribute values in the following format:

    portId,hostGroupNumber

    Attribute

    Type

    Description

    portId

    string

    (Required) Port number

    hostGroupNumber

    int

    (Required) Host group number for the port (For an iSCSI target, this is the target ID.)

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    A job object is returned. See the description for the job object. affectedResources is not displayed for this API. To check whether the host reservation status has been released, use the following URL. For port-number and host-group-number, specify the port number and the host group number (or the target ID) specified for the object ID.

    GET base-URL/v1/objects/luns?portId=port-number&hostGroupNumber=host-group-number
Action template

None.

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 "Content-type:application/json" -H "Accept:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/host-groups/CL1-A,1/actions/release-lu-host-reserves/invoke -d ""