Skip to main content

We've Moved!

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

Parity group management

You can create, change, delete, format, and get information about parity groups. In FMC parity groups, you can enable or disable accelerated compression.

Overview of a parity group

A parity group is a set of physical drives that configure a RAID in a storage system.

A logical storage area extracted from a parity group is used as an LDEV (basic volume). To create an LDEV to be used for operations such as volume allocation or pool creation, you need to create a parity group in advance.

GUID-012433AA-B7D1-4228-82F2-9BE6AE6A7EAD-low.gif

Parity group operations performed by the REST API are following:

  • Creating a parity group

    You can create a parity group when installing a new storage system or adding drives. You can configure a distributed parity group, or specify settings to encrypt a parity group or specify copy-back mode.

  • Changing the drive settings

    You can assign a specified drive as a spare drive, or release the assignment. The spare drive is used when a failure occurs in a drive that configures a parity group.

  • Changing the accelerated compression setting of a parity group

    You can enable or disable the accelerated compression setting for a parity group for which the accelerated compression function is supported.

  • Formatting a parity group

    You can format all volumes created from a parity group. When you create multiple volumes at the time a new storage system is installed or drives are added, you can collectively format the volumes.

  • Deleting a parity group

    You can delete a parity group. If the specified parity group is a parity group making up a distributed parity group, all concatenated parity groups are deleted.

For details on parity groups, see the Provisioning Guide.

Getting information about parity groups

The following request obtains information about all parity groups.

Execution permission

Storage Administrator (View Only)

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

    None.

  • Query parameters

    You can filter execution results by the specified condition and also collect additional detailed information about parity groups.

    • When filtering execution results

      Parameter

      Type

      Filtering condition

      clprId

      int

      (Optional) CLPR number

      driveTypeName

      string

      (Optional) Drive type

      You can specify the following values:

      • SAS
      • SSD(MLC)
      • SSD(FMC)

      driveSpeed

      int

      (Optional) Drive rotation speed (rpm)

    • When collecting additional detailed information

      Parameter

      Type

      Description

      detailInfoType

      string

      (Optional) Type of information to be collected

      • FMC

        For the parity groups whose drive type is SSD(FMC), add detailed information about accelerated compression.

      This parameter can be used together with the parameter for filtering execution results.

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
          "parityGroupId": "1-1",
          "numOfLdevs": 357,
          "usedCapacityRate": 13,
          "availableVolumeCapacity": 9410,
          "raidLevel": "RAID5",
          "raidType": "3D+1P",
          "clprId": 0,
          "driveType": "DKR2E-H4R0SS",
          "driveTypeName": "SAS",
          "driveSpeed": 7200,
          "totalCapacity": 10941,
          "physicalCapacity": 10941,
          "isAcceleratedCompressionEnabled": false
        },
        {
          "parityGroupId": "1-2",
          "numOfLdevs": 157,
          "usedCapacityRate": 36,
          "availableVolumeCapacity": 509,
          "raidLevel": "RAID5",
          "raidType": "3D+1P",
          "clprId": 0,
          "driveType": "DKR5C-K300SS",
          "driveTypeName": "SAS",
          "driveSpeed": 7200,
          "totalCapacity": 10941,
          "physicalCapacity": 10941,
          "isAcceleratedCompressionEnabled": false
        }
      ]
    }

    Attribute

    Type

    Description

    parityGroupId

    string

    Parity group number

    numOfLdevs

    int

    Number of assigned LDEVs

    usedCapacityRate

    int

    Usage rate of the parity group

    availableVolumeCapacity

    long

    Available capacity (GB)

    The amount of free space is output.

    If the capacity is below 1 GB, the value is truncated and 0 is output.

    raidLevel

    string

    RAID level

    raidType

    string

    RAID type

    clprId

    int

    CLPR number

    driveType

    string

    Code indicating the drive type of the drive belonging to the parity group

    driveTypeName

    string

    Drive type of the drive belonging to the parity group

    driveSpeed

    int

    Rotation speed (rpm) of the drive belonging to the parity group

    totalCapacity

    long

    Logical capacity of the parity group (GB)

    If the accelerated compression setting is enabled, the expanded capacity is output.

    physicalCapacity

    long

    Physical capacity of the parity group (GB)

    For this attribute, 1 GB is equal to 1,0243 bytes.

    If the value of this attribute is less than 1 GB, 0 is displayed.

    isAcceleratedCompressionEnabled

    boolean

    Value of the accelerated compression of the parity group

    • true: Accelerated compression for the parity group is enabled.
    • false: Accelerated compression for the parity group is disabled.

    If you obtained detailed information about accelerated compression

    When the drive type of the parity group is SSD(FMC), if you specify FMC for the detailInfoType query parameter and then run the request, the following additional information is obtained.

    Attribute

    Type

    Description

    totalPhysicalCapacity

    long

    An invalid value is displayed.

    isExpandedSpaceUsed

    boolean

    Whether LDEVs in parity groups use the expanded area

    • true: LDEVs use the expanded area
    • false: LDEVs use the physical area or are not implemented
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/parity-groups

Getting information about a specific parity group

The following request gets information about a specific parity group by specifying the parity group number. You can get detailed information about individual parity groups.

Execution permission

Storage Administrator (View Only)

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

    Specify the parityGroupId value obtained by getting information about the parity group.

    Attribute

    Type

    Description

    parityGroupId

    string

    (Required) Parity group number

    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" 
  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "parityGroupId": "1-1",
      "numOfLdevs": 111,
      "usedCapacityRate": 35,
      "availableVolumeCapacity": 1551,
      "raidLevel": "RAID5",
      "raidType": "3D+1P",
      "clprId": 0,
      "driveType": "DKR5D-J900SS",
      "driveTypeName": "SAS",
      "driveSpeed": 10000,
      "isEncryptionEnabled": false,
      "totalCapacity": 2415,
      "physicalCapacity": 2415,
      "isAcceleratedCompressionEnabled": false,
      "spaces": [
        {
          "partitionNumber": 0,
          "ldevId": 3840,
          "status": "NML",
          "lbaLocation": "0x000000000000",
          "lbaSize": "0x000000200000"
        },
        {
          "partitionNumber": 1,
          "ldevId": 3841,
          "status": "NML",
          "lbaLocation": "0x000000200400",
          "lbaSize": "0x000000200000"
        },...
    }

    Attribute

    Type

    Description

    parityGroupId

    string

    Parity group number

    numOfLdevs

    int

    Number of LDEVs in the parity group

    usedCapacityRate

    int

    Usage rate of the parity group

    availableVolumeCapacity

    long

    Available capacity (GB)

    The amount of free space is output.

    If the capacity is below 1 GB, the value is truncated and 0 is output.

    raidLevel

    string

    RAID level

    raidType

    string

    RAID type

    clprId

    int

    CLPR number

    driveType

    string

    Code indicating the drive type of the drive belonging to the parity group is output.

    driveTypeName

    string

    Drive type of the drive that belongs to the parity group

    driveSpeed

    int

    Rotation speed (rpm) of the drive belonging to the parity group

    isCopyBackModeEnabled

    boolean

    Value of the copy back mode setting of the parity group

    • true: Copy back mode is enabled.
    • false: Copy back mode is disabled.

    isEncryptionEnabled

    boolean

    Value of the encryption setting of the parity group

    • true: Encryption is enabled.
    • false: Encryption is disabled.

    totalCapacity

    long

    Logical capacity of the parity group (GB)

    physicalCapacity

    long

    Physical capacity of the parity group (GB)

    For this attribute, 1 GB is equal to 1,0243 bytes.

    If the value of this attribute is less than 1 GB, 0 is displayed.

    isAcceleratedCompressionEnabled

    boolean

    Value of the accelerated compression setting of the parity group

    • true: Accelerated compression for the parity group is enabled.
    • false: Accelerated compression for the parity group is disabled.

    spaces

    object[]

    The following attributes related to free space and the LDEV defined in the parity group are output:

    • partitionNumber (long)

      Partition number of the partition created by partitioning the parity group

    • ldevId (int)

      LDEV number

    • status (string)

      LDEV status

      • NML: The LDEV is implemented, or the free space is determined.
      • REG: An LDEV is being created.
      • DEL: An LDEV is being deleted.
    • lbaLocation (string)

      Starting location of the LBA of the partition in the parity group (in a multiple of 512 bytes)

    • lbaSize (string)

      Size of the partition in the parity group (in a multiple of 512 bytes)

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

Getting a list of drive information

The request below gets a list of drive information.

Execution permission

Storage Administrator (View Only)

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

    None.

  • Query parameters

    You can filter the execution results by specifying conditions and obtain additional detailed information about the drive.

    • To filter the execution results:

      Parameter

      Type

      Filter condition

      parityGroupId

      string

      (Optional) The parity group number of the parity group to which the drive belongs

      usageType

      string

      (Optional) Purpose for which the drive is used

      You can specify the following values as filter conditions:

      • DATA: Data drive
      • SPARE: Spare drive
      • FREE: Unused drive

      driveTypeName

      string

      (Optional) Drive type

      You can specify the following values as filter conditions:

      • SAS
      • SSD(MLC)
      • SSD(FMC)

      driveSpeed

      int

      (Optional) Drive rotation speed (rpm)

      totalCapacity

      long

      (Optional) Drive capacity (GB)

      If the drive type is SSD(FMD) or SSD(FMC), do not specify this parameter.

    • To obtain additional detailed information:

      Attribute

      Type

      Filter Condition

      detailInfoType

      string

      (Optional) Type of information to be collected

      • usedEnduranceIndicator

        If the drive type is SSD(MLC) or SSD(FMC), additional detailed information about the drive's life expectancy is collected.

      • usageType

        Additional detailed information about the usage of the drive is collected.

      To specify multiple drive types, delimit them by using commas.

      You can use this parameter in combination with the query parameters that are used to filter the execution results.

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
          "driveLocationId": "0-0",
          "driveTypeName": "SAS",
          "driveSpeed": 10000,
          "totalCapacity": 600,
          "driveType": "DKR5D-J600SS",
          "usageType": "DATA",
          "status": "NML",
          "parityGroupId": "1-6",
          "serialNumber": "123456789012345678901"
        },
        {
          "driveLocationId": "0-1",
          "driveTypeName": "SAS",
          "driveSpeed": 10000,
          "totalCapacity": 600,
          "driveType": "DKR5D-J600SS",
          "usageType": "DATA",
          "status": "NML",
          "parityGroupId": "1-6",
          "serialNumber": "123456789012345678902"
        },
        {
          "driveLocationId": "0-2",
          "driveTypeName": "SAS",
          "driveSpeed": 10000,
          "totalCapacity": 600,
          "driveType": "DKR5D-J600SS",
          "usageType": "DATA",
          "status": "NML",
          "parityGroupId": "1-6",
          "serialNumber": "123456789012345678903"
        },
        {
          "driveLocationId": "0-3",
          "driveTypeName": "SAS",
          "driveSpeed": 10000,
          "totalCapacity": 600,
          "driveType": "DKR5D-J600SS",
          "usageType": "DATA",
          "status": "NML",
          "parityGroupId": "1-6",
          "serialNumber": "123456789012345678904"
        }
      ]
    }

    Attribute

    Type

    Description

    driveLocationId

    string

    Drive location (location of the drive box)

    driveTypeName

    string

    Drive type

    driveSpeed

    int

    Drive rotation speed (rpm)

    totalCapacity

    long

    Drive capacity (GB)

    If the drive type is SSD(FMD) or SSD(FMC), any value displayed for this attribute will be invalid.

    driveType

    string

    Drive type code

    usageType

    string

    Purpose for which the drive is used

    • DATA: Data drive
    • SPARE: Spare drive
    • FREE: Unused drive

    status

    string

    Status of the drive

    • NML: Normal
    • WAR: Part of the drive is blocked
    • CPY: Copying is in progress
    • CPI: Copying is incomplete
    • RSV: The spare drive cannot be used
    • FAI: The drive is blocked because of a failure
    • BLK: The drive is blocked because maintenance is being performed
    • Unknown: The status is unknown

    parityGroupId

    string

    Parity group number

    This item is hidden when the drive does not belong to any parity group.

    serialNumber

    string

    Serial number of the drive

    The following is an example of the detailed information that can be output about the drive's life expectancy.

    {
        "data": [
            {
                "driveLocationId": "4-0",
                "driveTypeName": "SSD(FMC)",
                "totalCapacity": 1600,
                "driveType": "NFHAE-Q1R6SS",
                "usageType": "DATA",
                "status": "NML",
                "parityGroupId": "3-1",
                "serialNumber": "12345670",
                "usedEnduranceIndicator": 0,
                "usedEnduranceIndicatorThreshold": 99,
                "usedEnduranceIndicatorWarningSIM": 95
            },
            {
                "driveLocationId": "4-1",
                "driveTypeName": "SSD(FMC)",
                "totalCapacity": 1600,
                "driveType": "NFHAE-Q1R6SS",
                "usageType": "DATA",
                "status": "NML",
                "parityGroupId": "3-1",
                "serialNumber": "12345671",
                "usedEnduranceIndicator": 0,
                "usedEnduranceIndicatorThreshold": 99,
                "usedEnduranceIndicatorWarningSIM": 95
            },
            {
                "driveLocationId": "4-2",
                "driveTypeName": "SSD(FMC)",
                "totalCapacity": 1600,
                "driveType": "NFHAE-Q1R6SS",
                "usageType": "DATA",
                "status": "NML",
                "parityGroupId": "3-1",
                "serialNumber": "12345672",
                "usedEnduranceIndicator": 0,
                "usedEnduranceIndicatorThreshold": 99,
                "usedEnduranceIndicatorWarningSIM": 95
            }
        ]
    }
    

    To obtain detailed information about the drive's life expectancy:

    If the drive type is SSD(MLC) or SSD(FMC), you can obtain the following information by executing the request with usedEnduranceIndicator specified for the detailInfoType query parameter.

    Attribute

    Type

    Description

    usedEnduranceIndicator

    int

    Life expectancy of the drive (%)

    A value in the range from 0 to 100 is displayed.

    A large value indicates that the drive is near the end of its life expectancy.

    usedEnduranceIndicatorThreshold

    int

    Threshold value of the drive's life expectancy (%)

    If the value of the drive's life expectancy exceeds this value, data on the drive will be automatically copied to a spare drive.

    usedEnduranceIndicatorWarningSIM

    int

    Threshold value of the warning SIM (%)

    If the value of the drive's life expectancy exceeds this value, error information (SIM) will be output.

    The following is an example of the detailed information that can be output about the drive usage.

    {
        "data": [
            {
                "driveLocationId": "0-0",
                "driveTypeName": "SAS",
                "driveSpeed": 10000,
                "totalCapacity": 600,
                "driveType": "DKS5H-J600SS",
                "usageType": "DATA",
                "detailUsageType": "DATA",
                "status": "NML",
                "parityGroupId": "1-1",
                "serialNumber": "12345670"
            },
            {
                "driveLocationId": "0-1",
                "driveTypeName": "SAS",
                "driveSpeed": 10000,
                "totalCapacity": 600,
                "driveType": "DKS5H-J600SS",
                "usageType": "DATA",
                "detailUsageType": "DATA",
                "status": "NML",
                "parityGroupId": "1-1",
                "serialNumber": "12345671"
            },
            {
                "driveLocationId": "0-2",
                "driveTypeName": "SAS",
                "driveSpeed": 10000,
                "totalCapacity": 600,
                "driveType": "DKS5H-J600SS",
                "usageType": "DATA",
                "detailUsageType": "DATA",
                "status": "NML",
                "parityGroupId": "1-1",
                "serialNumber": "12345671"
            },
            {
                "driveLocationId": "0-3",
                "driveTypeName": "SAS",
                "driveSpeed": 10000,
                "totalCapacity": 600,
                "driveType": "DKS5H-J600SS",
                "usageType": "DATA",
                "detailUsageType": "DATA",
                "status": "NML",
                "parityGroupId": "1-1",
                "serialNumber": "12345671"
            }
        ]
    }
    

    To obtain detailed information about the drive usage:

    You can obtain the following information by specifying usageType for the detailInfoType query parameter.

    Attribute

    Type

    Description

    detailUsageType

    string

    Details about the usage of the drive

    • DATA: Data drive

    • SPARE: Spare drive

    • FREE: Unused drive

    • SWAP: the drive that is swapped a spare drive for a data drive

    • RESERVE: the unused drive that is swapped a data drive for a spare drive

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

Getting information about a specific drive

The request below allows you to get information about a specific drive by specifying the drive location (the location of the drive box).

Execution permission

Storage Administrator (View Only)

Request line

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

    Specify the driveLocationId value obtained by getting information about the drive list.

    Attribute

    Type

    Description

    driveLocationId

    string

    (Required) Drive location (location of the drive box)

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "driveLocationId": "0-0",
      "driveTypeName": "SAS",
      "driveSpeed": 10000,
      "totalCapacity": 600,
      "driveType": "DKR5D-J600SS",
      "usageType": "DATA",
      "status": "NML",
      "parityGroupId": "1-6",
      "serialNumber": "123456789012345678901"
    }

    Attribute

    Type

    Description

    driveLocationId

    string

    Drive location

    driveTypeName

    string

    Drive type

    driveSpeed

    int

    Drive rotation speed (rpm)

    totalCapacity

    long

    Drive capacity (GB)

    If the drive type is SSD(FMD) or SSD(FMC), any value displayed for this attribute will be invalid.

    driveType

    string

    Drive type code

    usageType

    string

    Purpose for which the drive is used

    • DATA: Data drive
    • SPARE: Spare drive
    • FREE: Unused drive

    status

    string

    Status of the drive

    • NML: Normal
    • WAR: Part of the drive is blocked
    • CPY: Copying is in progress
    • CPI: Copying is incomplete
    • RSV: The spare drive cannot be used
    • FAI: The drive is blocked because of a failure
    • BLK: The drive is blocked because maintenance is being performed
    • Unknown: The status is unknown

    parityGroupId

    string

    The parity group number of the parity group to which the drive belongs

    This item is hidden when the drive does not belong to any parity group.

    serialNumber

    string

    Serial number of the drive

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/drives/0-0

Creating a parity group

The request below creates a parity group.

Execution permission

Storage Administrator (Provisioning)

Request line

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

    None.

  • Query parameters

    None.

  • Body

    The following coding example creates a parity group:

    {
      "parityGroupId": "2-10",
      "driveLocationIds": ["1-1","1-2","1-3","1-4"],
      "raidType": "3D+1P",
      "isEncryptionEnabled": false,
      "isCopyBackModeEnabled": true,
      "isAcceleratedCompressionEnabled": true,
      "clprId": 1
    }

    The following coding example creates a distributed parity group by concatenating two parity groups:

    {
      "concatenatedParityGroupIds": ["2-9","2-10"],
      "driveLocationIds": ["1-1","1-2","1-3","1-4","1-5","1-6","1-7","1-8"],
      "raidType": "2D+2D",
      "isEncryptionEnabled": false,
      "isCopyBackModeEnabled": true,
      "isAcceleratedCompressionEnabled": true,
      "clprId": 1
    }

    Attribute

    Type

    Description

    parityGroupId

    string

    (Optional) Parity group number

    Specify the number in gno-sgno format.

    Be sure to specify the parityGroupId attribute or the concatenatedParityGroupIds attribute.

    concatenatedParityGroupIds

    string[]

    (Optional) To configure a distributed parity group, specify the parity group numbers of concatenated parity groups.

    The concatenated parity groups will be created in the order in which the driveLocationIds attribute is specified.

    Be sure to specify the parityGroupId attribute or the concatenatedParityGroupIds attribute.

    driveLocationIds

    string[]

    (Required) Drive location

    Specify the locations of the drives to be used to create to the parity group.

    raidType

    string

    (Required) RAID type

    Specify one of the following values:

    • 2D+2D
    • 3D+1P
    • 4D+1P
    • 6D+1P
    • 7D+1P
    • 6D+2P
    • 12D+2P
    • 14D+2P

    isEncryptionEnabled

    boolean

    (Optional) Specify whether to enable the encryption function for the parity group.

    • true: Enable the encryption function.
    • false: Disable the encryption function.

    You cannot specify true if you specify true for the isAcceleratedCompressionEnabled attribute.

    If you omit this item, false will be set.

    isCopyBackModeEnabled

    boolean

    (Optional) Specify whether to enable copy back mode for the parity group.

    • true: Enable copy back mode.
    • false: Disable copy back mode.

    If you omit this item, true will be set.

    isAcceleratedCompressionEnabled

    boolean

    (Optional) Specify whether to enable accelerated compression for the parity group.

    • true: Enable accelerated compression.
    • false: Disable accelerated compression.

    You cannot specify true if you specify true for the isEncryptionEnabled attribute.

    If you omit this item, false will be set.

    clprId

    int

    (Optional) CLPR number

    Specify a CLPR number in the range from 0 to 31.

    If you omit this item, 0 will be set.

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 created parity group

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 codes

Message

Description

409

Conflict

The parity group is already created with the specified parity group number or the concatenated parity 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/parity-groups

Changing the drive settings

The request below configures a drive. You can use this request to assign a specified drive as a spare drive and to release the assignment of a specified drive.

Execution permission

Storage Administrator (Provisioning)

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

    Specify the driveLocationId value obtained by getting information about the drive list.

    Attribute

    Type

    Description

    driveLocationId

    string

    (Required) Drive location (location of the drive box)

  • Query parameters

    None.

  • Body

    {
      "isSpareEnabled": false
    }

    Attribute

    Type

    Description

    isSpareEnabled

    boolean

    (Required) Spare drive setting

    • true: Assigns the specified drive as a spare drive.
    • false: Releases the assignment as a spare drive.
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 drive whose setting was changed

Status codes

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

Action template

None.

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/drives/0-0

Changing the accelerated compression setting of a parity group

The request below enables or disables accelerated compression for a parity group. You can use this API request for parity groups for which accelerated compression is supported.

Execution permission

Storage Administrator (Provisioning)

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

    Specify the parityGroupId value obtained by getting information about the parity group.

    Attribute

    Type

    Description

    parityGroupId

    string

    (Required) Parity group number

    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" 
  • Query information

    None.

  • Body

    {
      "isAcceleratedCompressionEnabled": true
    }

    Attribute

    Type

    Description

    isAcceleratedCompressionEnabled

    boolean

    (Required) Specify whether to enable accelerated compression for the parity group.

    • true: Enable accelerated compression.
    • false: Disable accelerated compression.
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 parity group whose setting was changed

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 PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/parity-groups/1-7

Formatting a parity group

The request below formats all volumes created from a parity group.

Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/parity-groups/object-ID/actions/format/invoke
Request message
  • Object ID

    Specify the parityGroupId value obtained by getting information about the parity group.

    Attribute

    Type

    Description

    parityGroupId

    string

    (Required) Parity group number

    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" 
  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    A job object is returned. For details, see the section explaining job objects. This API function does not display the affectedResources attribute. Formatting is performed when the state attribute of the job object is Succeeded. To check whether the formatting of each volume is complete, use the following URL. For parity-group-number, specify the parity group number that was specified for the object ID.

    GET base-URL/v1/objects/ldevs?parityGroupId=parity-group-number
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 https://192.0.2.100/ConfigurationManager/v1/objects/parity-groups/1-7/actions/format/invoke -d ""

Deleting a parity group

The request below deletes a parity group. If the specified parity group is concatenated with other parity groups, all of the concatenated parity groups are deleted.

Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/v1/objects/parity-groups/object-ID
Request message
  • Object ID

    Specify the parityGroupId value obtained by getting information about the parity group.

    Attribute

    Type

    Description

    parityGroupId

    string

    (Required) Parity group number

    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" 
  • Query parameters

    None.

  • Body

    None.

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 deleted parity group

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/parity-groups/1-1