Managing volumes

Creating volumes (CLI or REST API)

In the command used to create volumes, set "capacity" to a value smaller than the value calculated by the following expression:

logicalLimit [MiB] - ((168 [MiB] × n) + 42 [MiB])

n = Logical capacity of a volume to be created [MiB] / 3,145,548 [MiB] (A decimal is rounded up to the nearest integer.)
To verify the value of logicalLimit, run either of the following commands.

REST API: GET /v1/objects/storage-controllers

CLI: storage_controller_list

A volume requires control information in addition to the logical capacity. For how to calculate the maximum capacity of the storage pool consumed by a volume, see Maximum storage pool capacity consumed by a volume.

Note

The data reduction function is not supported.

Before you begin

Required role: Storage
When creating volumes in a VPS: Scope of the VPS

Procedure

When you are not using the multi-tenancy function or when you are using the multi-tenancy function and you create volumes in volumes within a system scope, verify the ID of the storage pool in which you want to create volumes.

If you want to specify the storage pool by its name in the CLI, verify the name of the intended storage pool.

REST API: GET /v1/objects/pools

CLI: pool_list
When you create volumes in a VPS, verify the creation-destination VPS ID and conditions set for the VPS (upper limit for the number of volumes, upper limit for volume capacity, upper limit for a single volume capacity, or QoS settings) instead of a storage pool ID.

If you want to specify a VPS by its name in the CLI, verify the VPS name.

REST API: GET /v1/objects/virtual-private-storages

CLI: vps_list

Note
A system administrator is not limited to the QoS settings of the VPS, and can configure QoS settings for individual volumes. If QoS parameters are not specified, volumes are created with the QoS parameters set to a VPS.
Create volumes.

Run either of the following commands with the parameters for creating volumes specified.

REST API: POST /v1/objects/volumes

CLI: volume_create

Verify the job ID which is displayed after the command is run.
Tip
- You can set the name and nickname for a volume. The name must be unique in the storage cluster. The nickname does not have to be unique (can also be used for other volumes). For this reason, a name can be used for identifying each individual volume, and a nickname can be used for create a group of volumes.
- By setting the storageControllerId (CLI: --storage_controller_id) parameter, you can create a volume by specifying the storage controller that manages the volume.
Verify the state of the job.

Run either of the following commands with the job ID specified.

REST API: GET /v1/objects/jobs/<jobId>

CLI: job_show

If the job state is "Succeeded", the job is completed.
Obtain a list of volumes and verify that the volumes are created.

REST API: GET /v1/objects/volumes

CLI: volume_list
Back up the configuration information.

Perform this step by referring to Backing up the configuration information.

If you continue operations with other procedures, you must back up the configuration information after you have completed all operations.

Note

In the following cases, use the function for creating a volume by specifying the storage controller that manages the volume.

Create a volume by avoiding storage controllers on storage nodes with high I/O loads.
Create a volume preferentially on the storage controller running on an added storage node.

Also note the following points when creating a volume by specifying the storage controller that will manage the volume.

When the usage rate of a storage controller becomes high, the capacity balancing process might move the volume to a different storage controller.
If you want to prevent a volume from being moved from the current controller by Capacity balance, confirm the status of the volumes that are already created on that storage controller, and design the capacity of the storage controller so that its capacity usage is kept less than 70%. If the capacity usage of the storage controller might exceed 70%, consider disabling Capacity balance of the storage node on which the storage controller runs.

However, if the capacity balancing setting is disabled, even if the usage rate of the storage controller becomes high, the capacity will not be balanced and the storage controller capacity might be exhausted. Monitor the usage rate of storage controllers to ensure that they have the necessary free space.
If you create a maximum number of volumes for a storage controller when total capacity of the volumes managed by the storage controller is smaller than the storage controller capacity, storage pool capacity cannot be fully utilized.

Deleting volumes (CLI or REST API)

Delete unnecessary volumes as follows.

Volumes cannot be deleted in the following cases.

If a path is set between a compute node and a volume, the volume cannot be deleted.

Before you delete a volume, cancel the connection between the volume to be deleted and the associated compute node.
Volumes with "P-VOL", "P/S-VOL", or "S-VOL" snapshotAttribute cannot be deleted using the procedure described in this section. For details about how to delete these volumes, see Deleting snapshots.
A volume whose status is "ExpansionFailed" cannot be deleted. If you want to delete a volume whose status is "ExpansionFailed", expand the volume, verify that the status becomes "Normal", and then run the volume deletion command again.

Before you begin

Required role: Storage
When deleting volumes in a VPS: Scope of the VPS

Procedure

When deleting volumes in a VPS, verify the VPS ID.

If you want to specify a VPS by its name in the CLI, verify the VPS name.

REST API: GET /v1/objects/virtual-private-storages

CLI: vps_list
Verify the ID of the intended volume.

If you use the CLI to specify a volume by name, check the name of the volume.

REST API: GET /v1/objects/volumes

CLI: volume_list
Delete the intended volume.

Run either of the following commands with the volume ID specified.

If you use the CLI, you can specify a name instead of the ID of the volume.

REST API: DELETE /v1/objects/volumes/<id>

CLI: volume_delete

Verify the job ID which is displayed after the command is run.
Verify the state of the job.

Run either of the following commands with the job ID specified.

REST API: GET /v1/objects/jobs/<jobId>

CLI: job_show

If the job state is "Succeeded", the job is completed.
Obtain a list of volumes and verify that the volumes are deleted.

REST API: GET /v1/objects/volumes

CLI: volume_list
Back up the configuration information.

Perform this step by referring to Backing up the configuration information.

If you continue operations with other procedures, you must back up the configuration information after you have completed all operations.

Expanding volumes (CLI or REST API)

You can only expand a volume whose status is "Normal" or "ExpansionFailed", and "volumeType" is "Normal".

If you expand a volume whose "status" is "Normal", the volume is expanded by the capacity specified in the parameter "additionalCapacity".
If you expand a volume whose status is "ExpansionFailed", the volume expansion is performed again.

In a command used to expand volumes, set "additionalCapacity" to a value smaller than the value calculated by the following expression:

logicalLimit [MiB] - ((168 [MiB] × n) + 42 [MiB])

n = Logical capacity of a volume to be added to the expanded volume [MiB] / 3,145,548 [MiB] (A decimal is rounded up to the nearest integer.)

Tip

To verify the value of logicalLimit, run either of the following commands.

REST API: GET /v1/objects/storage-controllers

CLI: storage_controller_list

Caution

If the event log KARS06170-C is issued and no actions are taken, make sure to take actions for KARS06170-C before the operations on the volume.

Before you begin

Required role: Storage
When expanding volumes in a VPS: Scope of the VPS

Procedure

When expanding volumes in a VPS, verify the VPS ID and conditions set for the VPS (upper limit for volume capacity and upper limit for a single volume capacity).

If you want to specify a VPS by its name in the CLI, verify the VPS name.

REST API: GET /v1/objects/virtual-private-storages

CLI: vps_list
Check the ID of the volume you want to extend.

If you use the CLI to specify a volume by name, check the name of the volume.

It also checks the status and volumeType of the volume to expand the capacity of the volume.

REST API: GET /v1/objects/volumes

CLI: volume_list

When "status" of the volume to be expanded is "Normal" or "ExpansionFailed", and "volumeType" is "Normal", go to the next step.
Expand the volume capacity.

Run one of the following commands with the capacity to be added to the volume specified for additionalCapacity. Run the command with a value specified if the status of the volume is "Normal", or with no value specified if the status is "ExpansionFailed".

Run either of the following commands with the volume ID specified.

If you use the CLI, you can specify a name instead of the ID of the volume.

REST API: POST /v1/objects/volumes/<id>/actions/expand/invoke

CLI: volume_expand

Verify the job ID which is displayed after the command is run.
Verify the state of the job.

Run either of the following commands with the job ID specified.

REST API: GET /v1/objects/jobs/<jobId>

CLI: job_show

If the job state is "Succeeded", the job is completed.
Obtain volume information to verify that the volume capacity is expanded.

Run either of the following commands with the volume ID specified.

If you use the CLI, you can specify the name of the volume instead of its ID.

REST API: GET /v1/objects/volumes/<id>

CLI: volume_show
Back up the configuration information.

Perform this step by referring to Backing up the configuration information.

If you continue operations with other procedures, you must back up the configuration information after you have completed all operations.

Obtaining a list of volumes (CLI or REST API)

The following information can be obtained.

Note

The data reduction function is not supported.

savingEffects: Effect of the data reduction function
id: IDs (uuid) of volumes
name: Names of volumes
nickname: Nicknames of volumes
volumeNumber: Numbers of volumes
poolId: IDs (uuid) of storage pools
poolName: Names of storage pools
totalCapacity: Total logical capacity
usedCapacity: Consumed logical capacity
numberOfConnectingServers: Number of connected compute nodes
numberOfSnapshots: Number of snapshots
protectionDomainId: IDs (uuid) of protection domains containing volumes
fullAllocated: Whether all the area where user data is written is allocated in advance
volumeType: List of volume types (attributes)
statusSummary: Summary of statuses of volumes
status: Status of each volume
storageControllerId: IDs (uuid) of storage controllers managing volumes
snapshotAttribute: Attributes of snapshots
snapshotStatus: Statuses of snapshots
savingSetting: Setting of the data reduction function
savingMode: Processing mode of the data reduction function
dataReductionStatus: Status of the data reduction function
dataReductionProgressRate: Progress rate of the data reduction function
vpsId: ID of the VPS to which volumes belong
vpsName: Name of the VPS to which volumes belong
qosParam: QoS-related parameter
- upperLimitForIops: Upper limit for volume performance (IOPS)
- upperLimitForTransferRate: Upper limit for volume performance (MiB/s)
- upperAlertAllowableTime: Alert threshold value for the upper limit of volume performance (second)
- upperAlertTime: The last time the upper limit of volume performance was continuously exceeded and the conditions for the alert threshold of the performance upper limit were met (UTC)
naaId: NAA ID of the VPS to which volumes belong

Before you begin

Required role: Security, Storage, Monitor, Service, or Resource

Procedure

Obtain a list of volumes.

REST API: GET /v1/objects/volumes

CLI: volume_list

Obtaining information about individual volumes (CLI or REST API)

The following information can be obtained for the volume with the ID specified.

Note

The data reduction function is not supported.

reservedCapacity: Reserved logical capacity
freeCapacity: Free logical capacity
luns: List of volume LUNs
snapshotProgressRate: Progress rate of preparation for, deleting, and restoring snapshot volumes
snapshotTimestamp: For S-VOL or P/S-VOL, time when recording of difference data started for the P-VOL at the time of snapshot creation
snapshotType: Snapshot type ("Snapshot" for S-VOL or P/S-VOL, null for others)
savingEffects: Effect of the data reduction function
snapshotConcordanceRate: Match rate between the target volume and one newer generation of S-VOL or copy-source volume
isWrittenInSvol: Whether the volume can be written from the controller node
id: ID (uuid) of the intended volume
name: Name of the intended volume
nickname: Nickname of the intended volume
volumeNumber: Number of the intended volume
poolId: ID (uuid) of the storage pool
poolName: Name of the storage pool
totalCapacity: Total logical capacity
usedCapacity: Consumed logical capacity
numberOfConnectingServers: Number of connected compute nodes
numberOfSnapshots: Number of snapshots
protectionDomainId: ID (uuid) of the protection domain containing the intended volume
fullAllocated: Whether all the area where user data is written is allocated in advance
volumeType: List of volume types (attributes)
statusSummary: Summary of statuses of volumes
status: Status of each volume
storageControllerId: ID (uuid) of the storage controller that manages this volume.
snapshotAttribute: Attributes of snapshots
snapshotStatus: Statuses of snapshots
savingSetting: Setting of the data reduction function
savingMode: Processing mode of the data reduction function
dataReductionStatus: Status of the data reduction function
dataReductionProgressRate: Progress rate of the data reduction function
vpsId: ID of the VPS to which the intended volume belongs
vpsName: Name of the VPS to which the intended volume belongs
qosParam: QoS-related parameter
- upperLimitForIops: Upper limit for volume performance (IOPS)
- upperLimitForTransferRate: Upper limit for volume performance (MiB/s)
- upperAlertAllowableTime: Alert threshold value for the upper limit of volume performance (second)
- upperAlertTime: The last time the upper limit of volume performance was continuously exceeded and the conditions for the alert threshold of the performance upper limit were met (UTC)
naaId: NAA ID of the VPS to which the intended volume belongs

Before you begin

Required role: Security, Storage, Monitor, Service, or Resource

Procedure

Verify the ID of the intended volume.

If you use the CLI to specify a volume by name, check the name of the volume.

REST API: GET /v1/objects/volumes

CLI: volume_list
Obtain information about the intended volume.

Run either of the following commands with the volume ID specified.

If you use the CLI, you can specify a name instead of the ID of the volume.

REST API: GET /v1/objects/volumes/<id>

CLI: volume_show

Modifying settings of individual volumes (CLI or REST API)

You can edit volume names, nicknames, and QoS-related parameters (upperLimitForIops, upperLimitForTransferRate, and upperAlertAllowableTime).

You can only edit settings of volumes whose status is "Normal" or "UpdateFailed". For the volumes with the "UpdateFailed" status, re-edit volume settings without specifying parameters corresponding to the editing target.

It is possible to use the GUI for editing names or nicknames only of normal volumes.

When you perform editing, note the following points:

Name can only be set to a unique value in the storage cluster.
Nickname can have duplicate values between volumes.
If you specify multiple parameters in step 3, you can specify them only in the following combinations: If you want to make a configuration change that cannot be combined, run the command again.
- Combination of name and nickname
- Combination of upperLimitForIops, upperLimitForTransferRate, and upperAlertAllowableTime
You can edit settings of snapshot volumes similarly.

Caution

If the event log KARS06170-C is issued and no actions are taken, make sure to take actions for KARS06170-C before the operations on the volume.

Before you begin

Required role: Storage
When editing volumes in a VPS: Scope of the VPS

Procedure

When editing settings of volumes in a VPS, verify the VPS ID and conditions set for the VPS (QoS settings).

If you want to specify a VPS by its name in the CLI, verify the VPS name.

REST API: GET /v1/objects/virtual-private-storages

CLI: vps_list

Note
A system administrator can make QoS settings for individual volumes without limitation for the QoS settings of volumes.
Verify the ID of the intended volume.

If you use the CLI to specify a volume by name, check the name of the volume.

REST API: GET /v1/objects/volumes

CLI: volume_list
Change the settings of the intended volume.

Run either of the following commands with the volume ID and parameters for setting volumes specified.

If you use the CLI, you can specify a name instead of the ID of the volume.

REST API: PATCH /v1/objects/volumes/<id>

CLI: volume_set

Verify the job ID which is displayed after the command is run.
Verify the state of the job.

Run either of the following commands with the job ID specified.

REST API: GET /v1/objects/jobs/<jobId>

CLI: job_show

If the job state is "Succeeded", the job is completed.
Obtain information about the intended volume and verify that the settings of the volume are modified.

Run either of the following commands with the volume ID specified.

If you use the CLI, you can specify a name instead of the ID of the volume.

REST API: GET /v1/objects/volumes/<id>

CLI: volume_show
Back up the configuration information.

Perform this step by referring to Backing up the configuration information.

If you continue operations with other procedures, you must back up the configuration information after you have completed all operations.