Skip to main content

We've Moved!

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

Configuring a global-active device environment

When configuring an environment for using global-active device use Storage Advisor Embedded to configure remote paths and quorum disks.

Workflow for configuring a global-active device environment

With global-active device, you can achieve data redundancy for volumes between two storage systems, and provide a high availability environment.

Data written to a volume of one storage system is automatically synchronized to a volume of the other storage system. The user can then use global-active device without having to be aware of the configuration of the volumes accessed by the server.

You can use Storage Advisor Embedded to configure the remote paths and the quorum disk required for using global-active device. These settings must be configured on both storage systems in the global-active device environment.

Caution

If you use a port for external connections as the endpoint of an I/O path from an external storage system to a local storage system, the I/O path might become disconnected. Use a route that can be used as an external path. For details about external paths, see the Hitachi Universal Volume Manager User Guide.

Note

You cannot use Storage Advisor Embedded to perform operations that use a port for which the virtual port setting is enabled as a port for external connections for the quorum disk.

GUID-ECBB0793-68A6-4B17-A872-27E862233110-low.gif
  • When using the REST API:

    The following REST APIs can be executed to automate the operations:

    • Configuring remote paths

      The request line is as follows:

      POST base-URL/v1/objects/remotepath-groups
    • Configuring external iSCSI targets

      For details about how to use the API request for registering an iSCSI name of an external storage system to a port on the local storage system, see the REST API Reference Guide.

      The request line is as follows:

      POST base-URL/v1/objects/iscsi-ports/object-ID/actions/register/invoke
    • Creating an external volume
    • Registering information about a quorum disk

Configuring remote paths

You can configure remote paths between the two storage systems that make up a global-active device environment. Because a remote path is required to send data to the connection-destination storage system, you need to configure remote paths for both storage systems so they can send data to each other.

Before you begin

  • Connect physical paths between the two storage systems that make up the global-active device environment.
  • Identify the following items:
    • The model and serial number of the connection-destination storage system
    • The ID of the path group
    • The port to be used on the connection-source storage system and the port of the connection-destination storage system
    • The IP address and TCP port number of the connection-destination storage system (when using iSCSI for the protocol)

Procedure

  1. In the navigation bar, click Others Remote Path Groups.

  2. Click the plus sign (+).

    GUID-4BFB9EB7-4F1E-488C-926F-224897DCC09C-low.gif

  3. Specify the required items, and then configure the remote path.

  4. Click the ID of the path group to open the details page. Make sure that the status of the remote path you configured is Normal.

    Note

    If the status of the remote path is not Normal, see the Global-Active Device User Guide.

Configuring a quorum disk

You can use Storage Advisor Embedded to create an external volume to configure a quorum disk, or to configure a quorum disk by using an external volume that has already been created. If a path or a storage system fails, the quorum disk determines the storage system in which I/O operations from the server will continue.

To temporarily configure a global-active device environment for such purposes as system migration, you can also configure a quorum disk without using an external volume. In this configuration, I/O operations from the server might be unable to continue if a storage system fails.

Configuring a quorum disk by creating an external volume

Create an external volume in the two storage systems that make up the global-active device environment, and specify settings to use the external volume as a quorum disk.

Before you begin

  • Ensure that the two storage systems that make up the global-active device environment and the external storage system in which the volume used as the quorum disk is configured are connected by physical paths.
  • Ensure that the volume used as the quorum disk is assigned a port on each of the two storage systems that make up the global-active device environment.
  • If you want to use iSCSI to connect with the external storage system, make sure that external iSCSI targets have already been registered.
  • Identify the following items required to configure the external volume:
    • The port to be used for external connection
    • The model and serial number of the external storage system
    • The port information for the external storage system that is connected with a port for external connections:
      • When using Fibre Channel for the protocol you can specify WWN
      • When using iSCSI for the protocol you can specify iSCSI target name and IP address
    • The LUN of the volume used as the quorum disk

      If you use a volume whose size exceeds 4 TiB, the size of the external volume that is created will be 4 TiB.

    • The name of the external volume
    • The ID of the external parity group
    • The ID of the external path group
  • Identify the following information required to configure the quorum disk:
    • The ID of the quorum disk
    • The models and serial numbers of the paired storage system that shares the quorum disk

Procedure

  1. In the navigation bar, click Others External Volumes.

  2. Click the plus sign (+).

    GUID-B71F0549-7EE2-4A5F-90E1-241EBEFA0505-low.gif

  3. Select the port for external connection, and then click Next.

  4. Select the external path to be used, and then click Next.

  5. Select the LUN of the volume used as the quorum disk, and specify the name of the external volume, the ID of the external parity group, and the ID of the external path group. Click Submit.

    Information about the newly configured external volume is displayed in the list of external volumes.

  6. Click GUID-CBEAE1FC-A2E0-43DE-B8BB-CA069527915E-low.gif (Configure Quorum Disk Setting) for the external volume for which the quorum disk is to be configured.

    GUID-F64992F3-CDB9-47A6-AFB2-7CD190E38121-low.png
  7. Specify the required items, and then click Submit.

Configuring a quorum disk by selecting an external volume

Configure a quorum disk by using an existing external volume.

Before you begin

  • Identify the following information required to configure the quorum disk:
    • The ID of the quorum disk
    • The models and serial numbers of the paired storage system that shares the quorum disk
    • The external volume name

Procedure

  1. In the navigation bar, click Others Quorum Disks.

  2. Click the plus sign (+).

    GUID-BA9B9D61-4993-42ED-A2C6-B2D283C549E8-low.gif
  3. Specify the required items.

    To specify the external volume to be used, select With External Volume, and then click Next.

  4. Select the external volume to be used, and then click Submit.

Configuring a quorum disk without using an external volume

If you want to temporarily configure a global-active device environment for such purposes as system migration, you can configure a quorum disk without using an external volume.

Before you begin

  • Identify the following information required to configure the quorum disk:
    • The ID of the quorum disk
    • The models and serial numbers of the paired storage system that shares the quorum disk

Procedure

  1. In the navigation bar, click Others Quorum Disks.

  2. Click the plus sign (+).

    GUID-22207300-124A-47AF-8C4E-3249ABCA2907-low.gif
  3. Specify the required items.

    To configure a quorum disk without using an external volume, select Without External Volume, and then click Submit.

Configuring a quorum disk by creating an external volume

Create an external volume in the two storage systems that make up the global-active device environment, and specify settings to use the external volume as a quorum disk.

Before you begin

  • Ensure that the two storage systems that make up the global-active device environment and the external storage system in which the volume used as the quorum disk is configured are connected by physical paths.
  • Ensure that the volume used as the quorum disk is assigned a port on each of the two storage systems that make up the global-active device environment.
  • If you want to use iSCSI to connect with the external storage system, make sure that external iSCSI targets have already been registered.
  • Identify the following items required to configure the external volume:
    • The port to be used for external connection
    • The model and serial number of the external storage system
    • The port information for the external storage system that is connected with a port for external connections:
      • When using Fibre Channel for the protocol you can specify WWN
      • When using iSCSI for the protocol you can specify iSCSI target name and IP address
    • The LUN of the volume used as the quorum disk

      If you use a volume whose size exceeds 4 TiB, the size of the external volume that is created will be 4 TiB.

    • The name of the external volume
    • The ID of the external parity group
    • The ID of the external path group
  • Identify the following information required to configure the quorum disk:
    • The ID of the quorum disk
    • The models and serial numbers of the paired storage system that shares the quorum disk

Procedure

  1. In the navigation bar, click Others External Volumes.

  2. Click the plus sign (+).

    GUID-B71F0549-7EE2-4A5F-90E1-241EBEFA0505-low.gif

  3. Select the port for external connection, and then click Next.

  4. Select the external path to be used, and then click Next.

  5. Select the LUN of the volume used as the quorum disk, and specify the name of the external volume, the ID of the external parity group, and the ID of the external path group. Click Submit.

    Information about the newly configured external volume is displayed in the list of external volumes.

  6. Click GUID-CBEAE1FC-A2E0-43DE-B8BB-CA069527915E-low.gif (Configure Quorum Disk Setting) for the external volume for which the quorum disk is to be configured.

    GUID-F64992F3-CDB9-47A6-AFB2-7CD190E38121-low.png
  7. Specify the required items, and then click Submit.

Managing remote paths

You can add remote paths to, and remove remote paths from, a remote path group.

Adding remote paths

Add remote paths to an already-configured remote path group to configure redundant remote paths between the two storage systems that make up a global-active device environment.

Before you begin

Identify the following items:

  • The ID of the path group
  • The port to be used on the connection-source storage system and the port of the connection-destination storage system
  • For iSCSI, the IP address and TCP port number of the connection-destination storage system

Procedure

  1. In the navigation bar, click Others Remote Path Groups.

  2. Click the path group ID of the remote path group to which you want to add the remote path.

  3. Click GUID-370780CA-4063-47ED-BF48-19366C4F82A0-low.gif (Add Remote Paths).

    GUID-CBCBDE01-0855-48C6-8A31-DABEC8A2DEE7-low.gif
  4. Specify the required items, and then add the remote path.

    Make sure that the status of the remote path you added is Normal.

    Note

    If the status of the remote path is not Normal, see the Global-Active Device User Guide.

Removing remote paths

When you change the configuration of a port or when the actual amount of data is less than the amount of data assumed at the time of design, remove remote paths from the remote path group. You cannot remove all of the remote paths from a remote path group. To remove all of the remote paths in a remote path group, remove the remote path group itself.

Before you begin

Identify the ID of the path group.

Procedure

  1. In the navigation bar, click Others Remote Path Groups.

  2. Click the path group ID of the remote path group from which the remote path is to be removed.

  3. From the list of remote paths, select one or more remote paths, and then click GUID-944A90E7-BE83-404D-B484-BEC863CD430F-low.gif (Remove Remote Paths).

Removing remote path groups

When you no longer need to use a global-active device, remove the paths configured between the two storage systems for which global-active device is used.

Before you begin

Identify the ID of the path group of the remote path groups to be removed.

Procedure

  1. In the navigation bar, click Others Remote Path Groups.

  2. Select one or more remote path groups and click GUID-F074FA1A-3F5C-4AD5-A29C-48E36520F7C7-low.gif (Delete Remote Path Groups).

Managing quorum disks

You can add or remove external paths set for quorum disks, and change information about quorum disks.

Changing the name of the external volume of a quorum disk

You can change the external volume name set for a quorum disk.

  1. In the navigation bar, click Others External Volumes.

  2. Click GUID-AD1968EB-1936-404B-BECF-E261384BB0BD-low.gif for the external volume.

  3. Enter a different external volume name.

Adding external paths to a quorum disk

To configure redundant paths to a quorum disk, add external paths to the quorum disk.

Before you begin

  • Ensure that an external volume has been created, and that a quorum disk has been configured.
  • Ensure that the two storage systems that make up the global-active device environment and the external storage system in which the quorum disk is configured are connected by physical paths.
  • Ensure that the quorum disk is assigned a port on each of the two storage systems that make up the global-active device environment.
  • If you want to use iSCSI to connect with the external storage system, make sure that external iSCSI targets have already been registered.
  • Identify the following items:
    • The port to be used for external connection
    • The port information for the external storage system that is connected with a port for external connections:
      • When using Fibre Channel for the protocol you can specify WWN
      • When using iSCSI for the protocol you can specify iSCSI target name and IP address

Procedure

  1. In the navigation bar, click Others External Volumes.

  2. Click GUID-CD0C6D9E-1508-418B-A169-0229FE65A7E9-low.gif (Add External Paths) for the external volume to which you want to add a path.

    GUID-E1ED3E62-E3FA-4FA3-B9F0-C8B15ED2C66C-low.gif
  3. Select the port for external connection, and then click Next.

  4. Select the external path to be used, and then click Submit.

  5. Click the volume name of the quorum disk to which you added an external path. On the volume details page, verify the external path you added.

    If other external volumes are included in the same path group, external paths are also added to those volumes. To check information about volumes other than those for which you performed the operation, refresh the list of external volumes.

Removing external paths to a quorum disk

Remove external paths set to a quorum disk.

Before you begin

Identify the following items:

  • ID of the external volume
  • Information about the external path to be removed

Procedure

  1. In the navigation bar, click Others External Volumes.

  2. Click the volume name of the quorum disk whose external path you want to delete.

  3. Select one or more external paths, and then click GUID-6DF84600-0143-4AF9-9153-8283CB227584-low.gif (Remove External Paths).

    If other external volumes are included in the same path group, external paths to those volumes are also removed. To check information about volumes other than those for which you performed the operation, refresh the list of external volumes.

Disabling the quorum disk settings and deleting the corresponding external volume

If you decide against using the global-active device environment, disable the settings of the quorum disk that is no longer required for the two storage systems for which global-active device is used. Delete the external volume used as the quorum disk if it is no longer required.

Before you begin

Identify the external volume name of the quorum disk for which settings are to be disabled.

Procedure

  1. In the navigation bar, click Others External Volumes.

  2. Select one or more volumes used as the quorum disk whose settings you want to disable, and then click GUID-A08A0846-EC89-41B3-B6A0-18A98F401E86-low.gif (Remove Quorum Disk Setting).

  3. Make sure that the target volumes are correct, and then click Submit.

  4. To delete external volumes, select one or more external volumes, and click GUID-F074FA1A-3F5C-4AD5-A29C-48E36520F7C7-low.gif (Delete External Volume).

  5. Make sure that the target external volume is correct, select either Delete with Destaging or Delete without Destaging, and then click Submit.

    If you select Delete with Destaging, the processing to write data stored in cache memory to the external volume (destage processing) is performed, and after the connection is disabled, the external volume is deleted. If you select Delete without Destaging, the destage processing is not performed, and the external volume is forcibly deleted.

Disabling the quorum disk settings

If the global-active device environment is no longer used, disable the quorum disk settings that are no longer required.

To delete an external volume that is configured as a quorum disk, click Others in the navigation bar and select External Volumes.

Procedure

  1. In the navigation bar, click Others Quorum Disks.

  2. Select one or more quorum disks, and then click GUID-A08A0846-EC89-41B3-B6A0-18A98F401E86-low.gif (Remove Quorum Disk Setting).

Disabling the quorum disk settings and deleting the corresponding external volume

If you decide against using the global-active device environment, disable the settings of the quorum disk that is no longer required for the two storage systems for which global-active device is used. Delete the external volume used as the quorum disk if it is no longer required.

Before you begin

Identify the external volume name of the quorum disk for which settings are to be disabled.

Procedure

  1. In the navigation bar, click Others External Volumes.

  2. Select one or more volumes used as the quorum disk whose settings you want to disable, and then click GUID-A08A0846-EC89-41B3-B6A0-18A98F401E86-low.gif (Remove Quorum Disk Setting).

  3. Make sure that the target volumes are correct, and then click Submit.

  4. To delete external volumes, select one or more external volumes, and click GUID-F074FA1A-3F5C-4AD5-A29C-48E36520F7C7-low.gif (Delete External Volume).

  5. Make sure that the target external volume is correct, select either Delete with Destaging or Delete without Destaging, and then click Submit.

    If you select Delete with Destaging, the processing to write data stored in cache memory to the external volume (destage processing) is performed, and after the connection is disabled, the external volume is deleted. If you select Delete without Destaging, the destage processing is not performed, and the external volume is forcibly deleted.

Creating a remote connection

The following request creates a remote connection, and then adds a remote path. By using this request, you can create a CU Free remote connection. You can specify the serial number and the series name of the remote storage system to create a remote connection. Alternatively, you can specify the storage device ID of the remote storage system to create a remote connection.

Request line

POST base-URL/v1/objects/remotepath-groups

For details about how to use the API request to create a remote connection, see the REST API Reference Guide.

Creating an external volume

The following request creates an external parity group in a storage system, and then creates (maps) volumes for the storage system that is externally connected to the newly created external parity group. An external path group and external paths are also created at the same time. Volumes created by using this request are called external volumes.

Note
  • If the capacity of an external volume exceeds 4,194,304 MiB (4 TiB), an external volume with a capacity of 4,194,304 MiB (4 TiB) is created.
  • Before using iSCSI for the connection, you must register the information about the external iSCSI targets to the local port for the external connection.
Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/simple/v1/objects/external-volumes
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    The following are examples of creating an external volume:

    • When an FC:
      {
        "externalParityGroupId": "8-501",
        "externalPathGroupId": 501,
        "portId": "CL5-A",
        "externalPortWwn": "50060e8012000c60",
        "lun": 501
      }
    • When an iSCSI:
      {
        "externalParityGroupId": "9-1025",
        "externalPathGroupId": 1025,
        "portId": "CL1-B",
        "externalPortIpAddress": "10.1.2.122",
        "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d00b",
        "lun": 1025
      }

    Attribute

    Type

    Description

    externalParityGroupId

    string

    (Required) ID of the external parity group

    Specify a unique (unused) ID that is not being used for the external parity group.

    Specify the ID in the format X-Y.

    For X, you can specify an integer in the range from 1 through 16384.

    For Y, you can specify an integer in the range from 1 through 4096.

    Example: 1-1

    externalPathGroupId

    int

    (Required) ID of the external path group

    Specify a unique (unused) ID for the external path group.

    You can specify an integer in the range from 0 to 63231.

    portId

    string

    (Required) Port ID for connecting with the external storage system

    externalPortWwn

    string

    (Optional) WWN of the port of the externally connected storage system

    If you specify an FC port, you must specify this attribute.

    If you specify an iSCSI port, any value specified for this attribute will be ignored.

    externalPortIpAddress

    string

    (Optional) IP address of the port of the externally connected storage system

    You can specify an IPv4 or IPv6 address.

    If you specify an iSCSI port, you must specify this attribute.

    If you specify an FC port, any value specified for this attribute will be ignored.

    externalPortIscsiName

    string

    (Optional) Name of the iSCSI target for the port of the externally connected storage system

    If you specify an iSCSI port, you must specify this attribute.

    If you specify an FC port, any value specified for this attribute will be ignored.

    lun

    int

    (Required) LUN assigned to the port of the externally connected storage system

Response message
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-volumes

Registering information about a quorum disk

In the storage system, you can register information about the quorum disk to be used for global-active device.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/simple/v1/objects/quorum-disks
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    The following is an example of using an external volume to register information about a quorum disk by specifying the following settings:

    • Quorum disk ID: 7
    • External volume ID: 6400
    • Model of the paired storage system: M8
    • Serial number of the paired storage system: 401026
    {
      "quorumId": 7,
      "externalVolumeId": 6400,
      "pairedStorageModel": "M8",
      "pairedStorageSerial": "401026"
    }

    Attribute

    Type

    Description

    quorumId

    int

    (Required) Quorum disk ID

    Specify an integer in the range from 0 through 31 as the ID of the quorum disk to be registered.

    Specify an unused quorum disk ID.

    externalVolumeId

    int

    (Optional) External volume ID

    Specify an integer in the range from 0 through 65279 as the ID of the external volume to be registered.

    If you use an external volume to register information about a quorum disk, you must specify this attribute.

    pairedStorageModel

    string

    (Required) Model of the paired storage system that are to share the quorum disk

    You can specify any of the following values:

    • R8: VSP F1500, VSP G1000, or VSP G1500
    • R9: VSP 5000 series
    • M8: VSP Fx00 models or VSP Gx00 models

    pairedStorageSerial

    string

    (Required) Serial number of the paired storage system that are to share the quorum disk

Response message
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/quorum-disks

Getting external volume information

The following request obtains information about external volumes. You can also specify filter conditions.

Note
  • External parity group: A parity group created by mapping volumes of an externally connected storage system. External parity groups are used to manage external volumes.
  • External volume: A volume created from an external parity group
  • External path group: A group consisting of multiple external volumes that use the same external path, which is a route that connects an external connection port to the port of an external storage system.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-volumes
Request message
  • Object ID

    None.

  • Query parameters

    With each request, you can obtain information about a maximum of 200 external volumes. To obtain information about additional external volumes, execute the API request multiple times by using a combination of the count and startVolumeId parameters. By specifying the count parameter, you can also filter the external volume information you require.

    Parameter

    Type

    Filter Condition

    nickname

    string

    (Optional) Nickname of an external volume

    External volume information will also be obtained if part of the specified value matches the nickname of an external volume.

    minTotalCapacity

    long

    (Optional) Minimum capacity of the external volumes (MiB)

    Specify the minimum capacity of the external volumes for which you want to obtain information as an integer in the range from 47 through 268435456.

    maxTotalCapacity

    long

    (Optional) Maximum capacity of the external volumes (MiB)

    Specify the maximum capacity of the external volumes for which you want to obtain information as an integer in the range from 47 through 268435456.

    status

    string

    (Optional) Specify one of the following values to obtain information about volumes in a particular state.

    • Normal: Volumes in a normal state
    • Blockade: Volumes that are blocked

    volumeType

    string

    (Optional) Specify Quorum Disk (the quorum disk used on the global-active device) as the volume type of the external volume about which information is to be obtained.

    externalParityGroupId

    string

    (Optional) ID of the external parity group

    Specify the ID in the format X-Y.

    For X, you can specify an integer in the range from 1 through 16384.

    For Y, you can specify an integer in the range from 1 through 4096.

    externalPathGroupId

    int

    (Optional) Specify the ID of the external path group by using an integer in the range from 0 through 63231.

    startVolumeId

    int

    (Optional) Specify the ID of the external volume for which you want to start acquiring information, by using a value in the range from 0 through 65279.

    count

    int

    (Optional) Specify the number of external volumes for which information is to be obtained, by using a value in the range from 1 through 200.

    If this parameter is omitted, 200 is assumed.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when information is obtained about an external volume whose external volume type is quorum disk (if Quorum Disk is specified for the query parameter volumeType):

    {
      "data": [
        {
          "id": 1655,
          "nickname": "externalVolumeFc",
          "totalCapacity": 16384,
          "Status": "Normal",
          "externalParityGroupId": "42-3",
          "externalPathGroupId": 91,
          "externalPathOfVolume": [
            {
              "portId": "CL5-A",
              "portProtocol": "FC",
              "externalPortWwn": "50060e8012000c60",
              "lun": 1463
            }
          ],
          "volumeTypes": [
              "Quorum Disk"
          ],
          "externalStorage": {
            "model": "VSP Gx00",
            "serial": "400012",
            "vendor": "HITACHI"
          },
          "quorumSetting": {
            "quorumId": 31,
            "pairedStorageModel": "M8",
            "pairedStorageSerial": "401026"
          }
      },
      {
        "id": 1656,
        "nickname": "externalVolumeIscsi",
        "totalCapacity": 16384,
        "status": "Normal",
        "externalParityGroupId": "9-1025",
        "externalPathGroupId": 1025,
        "externalPathOfVolume": [
          {
            "portId": "CL1-B",
            "portProtocol": "iSCSI",
            "externalPortIpAddress": "10.1.2.122",
            "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d00b",
            "externalTcpPortNumber": 3260,
            "lun": 1025,
            "virtualPortNumber": 1
           }
          ],
          "volumeTypes": [
            "Quorum Disk"
          ],
          "externalStorage": {
            "model": "VSP Gx00",
            "serial": "400012",
            "vendor": "HITACHI"
          },
          "quorumSetting": {
            "quorumId": 12,
            "pairedStorageModel": "M8",
            "pairedStorageSerial": "401206"
          }
        }
      ],
      "count": 2,
      "totalCount": 2,
      "hasNext": false
    }

    Attribute

    Type

    Description

    id

    int

    External volume ID

    nickname

    string

    Nickname of the external volume

    This information appears if a nickname is defined.

    totalCapacity

    long

    Total capacity of the external volume (MiB)

    status

    string

    Status of the external volume

    • Normal: Indicates that the volume is in a normal state
    • Busy: Indicates that the volume's status is in transition
    • Blockade: Indicates that the volume is blocked

    externalParityGroupId

    string

    ID of the external parity group

    externalPathGroupId

    int

    ID of the external path group

    externalPathOfVolume

    object[]

    Information about each external path of the external volume appears.

    • portId (string)

      ID of the external connection port

    • portProtocol (string)

      Protocol of the port

      • FC
      • iSCSI
    • externalPortWwn (string)

      WWN of the port of the externally connected storage system

      If an iSCSI port is specified, this attribute will not appear.

    • externalPortIpAddress (string)

      IP address of the port of the externally connected storage system

      This attribute is output in IPv4 or IPv6 format.

      If an FC port is specified, this attribute will not appear.

    • externalPortIscsiName (string)

      Name of the iSCSI target for the port of the externally connected storage system

      If an FC port is specified, this attribute will not appear.

    • externalTcpPortNumber (int)

      TCP port number of the port of the externally connected storage system

      If an FC port is specified, this attribute will not appear.

    • virtualPortNumber (int)

      Virtual port number of the external connection port

      This attribute will not appear in the following cases:

      • If an FC port is specified
      • If an iSCSI port is specified and the use of virtual ports is disabled
    • lun (int)

      LUN assigned to the port of the externally connected storage system

    volumeTypes

    object[]

    Volume type of an external volume

    • Quorum Disk: The volume that is the quorum disk used by global-active device

    externalStorage

    object

    Information about the externally connected storage system appears.

    • model (string)

      Model of the externally connected storage system

      If a valid value cannot be obtained, this attribute does not appear.

    • serial (string)

      Serial number of the externally connected storage system

      If a valid value cannot be obtained, this attribute does not appear.

    • vendor (string)

      Vendor Identifier of the externally connected storage system

      If a valid value cannot be obtained, this attribute does not appear.

    quorumSetting

    object

    If information about a quorum disk is set, the information will appear.

    • quorumId (int)

      Quorum disk ID

    • pairedStorageModel (string)

      Model of the paired storage systems that share the quorum disk

      • R8: VSP F1500, VSP G1000, or VSP G1500
      • R9: VSP 5000 series
      • M8: VSP Fx00 models or VSP Gx00 models

      If information about the model cannot be obtained, Unknown will appear.

    • pairedStorageSerial (string)

      Serial number of the paired storage system that shares the quorum disk

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-volumes?volumeType="Quorum Disk"

Getting information about a specific external volume

The following request gets information about the external volume corresponding to the specified external volume ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-volumes/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about external volumes.

    Attribute

    Type

    Description

    id

    int

    (Required) External volume ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of getting information about an external volume with a volume ID of 3:

    {
        "id": 3,
        "nickname": "externalVolumeForQuorum",
        "totalCapacity": 20480,
        "status": "Normal",
        "volumeIdentifier": "HITACHI 5040000C1965",
        "externalParityGroupId": "8-501",
        "externalPathGroupId": 501,
        "externalPathOfVolume": [
            {
                "portId": "CL5-A",
                "portProtocol": "FC",
                "externalPortWwn": "50060e8012000c60",
                "lun": 501
            }
        ],
        "volumeTypes": [],
        "externalStorage": {
            "model": "VSP Gx00",
            "serial": "400012",
            "vendor": "HITACHI"
        }
    }

    The obtained attributes include the following attributes, in addition to the attributes obtained when external volume information is obtained:

    Attribute

    Type

    Description

    volumeIdentifier

    string

    An identifier that is used to identify an external volume

    Example: HITACHI 5040000C1965

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-volumes/3

Changing the nickname of an external volume

You can specify the ID of an external volume and then change the nickname of the external volume.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/simple/v1/objects/external-volumes/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about external volumes.

    Attribute

    Type

    Description

    id

    int

    (Required) External volume ID

  • Query parameters

    None.

  • Body

    {
      "nickname": "externalVolumeForQuorum2"
    }

    Attribute

    Type

    Description

    nickname

    string

    (Optional) Specify a new nickname consisting of 1 through 32 characters.

    You can use alphanumeric characters (0 through 9, A through Z, a through z), space characters, and the following symbols:

    Exclamation mark (!), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), single quotation mark ('), left parenthesis ((), right parenthesis ()), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), equal sign (=), at sign (@), left square bracket ([), back slash (\), right square bracket (]), caret (^), underscore (_), grave accent mark (`), left curly bracket ({), right curly bracket (}), tilde (~)

    This attribute is case-sensitive.

    You can use a space character between usable characters, but cannot use it at the beginning or end of the nickname.

Response message
  • Body

    Attribute

    Type

    Type

    affectedResources

    string[]

    List of URLs for referencing information about the changed external volume

    operationDetails

    object[]

    Details about the changed External volume

    For details, see the description of the operationDetails attribute of the commandStatus object.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-volumes/3

Getting information about external parity groups

You can obtain information about external parity groups.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-parity-groups
Request message
  • Object ID

    None.

  • Query parameters

    With each request, you can obtain information about a maximum of 200 external parity groups. To obtain information about additional external parity groups, execute the API request multiple times by using a combination of the count and startIndex parameters. By specifying the count parameter, you can also filter the external parity group information you require.

    Parameter

    Type

    Filter Condition

    startIndex

    int

    (Optional) Specify the index number of the external parity group from which to start obtaining information. Use a value in the range from 0 through 65535.

    count

    int

    (Optional) Specify the number of external parity groups for which information is to be obtained. Use a value in the range from 1 through 200.

    If this parameter is omitted, 200 is assumed.

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
          "id": "1-500",
          "status": "Normal",
          "externalPathGroupId": 500,
          "externalPath": [
            {
              "portId": "CL5-A",
              "portProtocol": "FC",
              "externalPortWwn": "50060e8012000c60",
              "lun": 1754,
              "status": "Normal"
            }
          ],
          "index": 2073
        },
        {
          "id": "9-1200",
          "status": "Normal",
          "externalPathGroupId": 1200,
          "externalPath": [
            {
              "portId": "CL1-B",
              "portProtocol": "iSCSI",
              "externalPortIpAddress": "10.1.2.122",
              "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d011",
              "externalTcpPortNumber": 3260,
              "lun": 1200,
              "virtualPortNumber": 1,
              "status": "Normal"
            }
          ],
          "index": 2274
        }
      ],
      "count": 2,
      "totalCount": 2,
      "hasNext": false
    }
    

    Attribute

    Type

    Description

    id

    string

    External parity group ID

    status

    string

    Status of the external parity group

    • Normal: Normal
    • Checking: Currently checking the status of the external path
    • Cache Destaging: Currently writing data from the cache to the volume
    • Disconnect: External paths are not connected
    • Blockade: External paths are blocked
    • Warning: A problem has occurred related to one or more external paths
    • Unknown: Unknown

    externalPathGroupId

    int

    External path group ID

    externalPath

    object[]

    Information about each external path in the external parity group appears.

    • portId (string)

      ID of the external connection port

    • portProtocol (string)

      Protocol of the port

      • FC
      • iSCSI
    • externalPortWwn (string)

      WWN of the port of the externally connected storage system

      If an iSCSI port is specified, this attribute will not appear.

    • externalPortIpAddress (string)

      IP address of the port of the externally connected storage system

      This attribute is output in IPv4 or IPv6 format.

      If an FC port is specified, this attribute will not appear.

    • externalPortIscsiName (string)

      Name of the iSCSI target for the port of the externally connected storage system

      If an FC port is specified, this attribute will not appear.

    • externalTcpPortNumber (int)

      TCP port number of the port of the externally connected storage system

      If an FC port is specified, this attribute will not appear.

    • virtualPortNumber (int)

      Virtual port number of the external connection port

      This attribute will not appear in the following cases:

      • If an FC port is specified
      • If an iSCSI port is specified and the use of virtual ports is disabled
    • lun (int)

      LUN assigned to the port of the externally connected storage system

      If Unknown is displayed for the status of the external path, this attribute will not appear.

    • status (string)

      Status of the external path

      • Normal: Normal
      • Disconnect: Not connected
      • Temporary Blockade: The port is blocked (temporarily blocked)
      • Blockade: Blocked
      • Unknown: Unknown

    index

    int

    Index number of the external parity group

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-parity-groups

Getting information about a specific external parity group

You can specify the ID of an external parity group and obtain information about the external parity group.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-parity-groups/object-ID
Request message
  • Object ID

    Specify the value of id that was obtained by using the API function for getting information about external parity groups.

    Attribute

    Type

    Description

    id

    string

    (Required) External parity group ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of output when information is obtained about the external parity group whose ID is 9-500.

    {
        "id": "9-500",
        "status": "Normal",
        "externalPathGroupId": 500,
        "externalPath": [
            {
                "portId": "CL5-A",
                "portProtocol": "FC",
                "externalPortWwn": "50060e8012000c60",
                "lun": 3,
                "status": "Normal"
            }
        ],
        "index": 2051
    }

    For details on attributes to be obtained, see the description of the API function for getting information about external parity groups.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-parity-groups/9-500

Getting information about external path groups

You can obtain a list of information about external path groups and about related external paths.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-path-groups
Request message
  • Object ID

    None.

  • Query parameters

    With each request, you can obtain information about a maximum of 200 external path groups. To obtain information about additional external path groups, execute the API request multiple times by using a combination of the count and startId parameters. By specifying the count parameter, you can also filter the external path group information you require.

    Parameter

    Type

    Filter Condition

    startId

    int

    (Optional) Specify the ID of the external path group from which to start obtaining information, by using a value in the range from 0 through 63231.

    count

    int

    (Optional) Specify the number of external path groups for which information is to be obtained, by using a value in the range from 1 through 200.

    If this parameter is omitted, 200 is assumed.

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
          "id": 1235,
          "externalPaths": [
            {
              "portId": "CL5-A",
              "portProtocol": "FC",
              "externalPortWwn": "50060e8012000c60"
            }
          ]
        },
        {
          "id": 1200,
          "externalPaths": [
            {
              "portId": "CL1-B",
              "portProtocol": "iSCSI",
              "externalPortIpAddress": "10.1.9.122",
              "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d011",
              "externalTcpPortNumber": 3260,
              "virtualPortNumber": 1
            }
          ]
        }
      ],
      "count": 2,
      "totalCount": 2,
      "hasNext": false
    }

    Attribute

    Type

    Description

    id

    int

    External path group ID

    externalPaths

    object[]

    Information about each external path related to the external path group appears.

    • portId (string)

      ID of the external connection port

    • portProtocol (string)

      Protocol of the port

      • FC
      • iSCSI

      If port information cannot be obtained, this attribute will not appear.

    • externalPortWwn (string)

      WWN of the port of the externally connected storage system

      If an iSCSI port is specified, this attribute will not appear.

    • externalPortIpAddress (string)

      IP address of the port of the externally connected storage system

      This attribute is output in IPv4 or IPv6 format.

      If an FC port is specified, this attribute will not appear.

    • externalPortIscsiName (string)

      Name of the iSCSI target for the port of the externally connected storage system

      If an FC port is specified, this attribute will not appear.

    • externalTcpPortNumber (int)

      TCP port number of the port of the externally connected storage system

      If an FC port is specified, this attribute will not appear.

    • virtualPortNumber (int)

      Virtual port number of the external connection port

      In the following cases, this attribute will not appear.

      • If an FC port is specified
      • If an iSCSI port is specified and the use of virtual ports is disabled
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-path-groups

Getting information about a specific external path group

You can specify the ID of an external path group and obtain information about the specific external path group.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-path-groups/object-ID
Request message
  • Object ID

    Specify the value of id that was obtained by using the API function for getting information about external path groups.

    Attribute

    Type

    Description

    id

    int

    (Required) External path group ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of output when information is obtained about the external path group whose ID is 600.

    {
        "id": 600,
        "externalPaths": [
            {
                "portId": "CL5-A",
                "portProtocol": "FC",
                "externalPortWwn": "50060e8012000c60"
            },
            {
                "portId": "CL6-A",
                "portProtocol": "FC",
                "externalPortWwn": "50060e8012000c70"
            }
        ]
    }

    For details on attributes to be obtained, see the description of the API function for getting information about external path groups.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-path-groups/600

Getting information about a specific quorum disk

The following request gets information about a quorum disk by using the specified quorum disk ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/quorum-disks/object-ID
Request message
  • Object ID

    Specify the quorumId value obtained by using the API request for getting information about quorum disks.

    Attribute

    Type

    Description

    quorumId

    int

    (Required) Quorum disk ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of obtaining information about the quorum disk whose quorum disk ID is 4:

    This response message includes information about attributes related to external volumes (externalVolumeId, externalVolumeNickname, and externalVolumeStatus). This indicates that information about the quorum disk was registered by using an external volume.

    {
        "quorumId": 4,
        "externalVolumeId": 84,
        "externalVolumeNickname": "quorum_R800_10",
        "externalVolumeStatus": "Normal",
        "pairedStorageModel": "R8",
        "pairedStorageSerial": "51305"
    }

    The following is an example of obtaining information about the quorum disk whose quorum disk ID is 30:

    This response message does not include information about attributes related to external volumes (externalVolumeId, externalVolumeNickname, and externalVolumeStatus). This indicates that information about the quorum disk was registered without using an external volume.

    {
        "quorumId": 30,
        "pairedStorageModel": "M8",
        "pairedStorageSerial": "410011"
    }

    For details on the attributes that can be obtained, see the description of the API request for getting information about quorum disks.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/quorum-disks/7

Deleting information about a quorum disk

You can delete information about a quorum disk from the storage system by specifying the Quorum disk ID.

Note

To also delete external volumes, you must execute the API request that unmapping an external volume before you delete those volumes. For details about how to perform this operation, see the REST API Reference Guide.

Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/simple/v1/objects/quorum-disks/object-ID
Request message
  • Object ID

    Specify the quorumId value obtained by getting information about quorum disks.

    Attribute

    Type

    Description

    quorumId

    int

    (Required) Quorum disk ID

  • Query parameters

    None.

  • Body

    None.

Response message
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X DELETE https://192.0.2.100/ConfigurationManager/simple/v1/objects/quorum-disks/7