Managing your license
License management overview
To use Virtual Storage Software block, you need a license. After Virtual Storage Software block is set up, it is installed with a trial license (valid for 60 days). You need to register a license for continued use after the trial license expires.
To request and register a license, contact your sales account representative to purchase a license key. To purchase a license key, you must provide the storage cluster ID and type of license you require. Depending on the type of the license, you also must notify the licensed capacity and period.
You can obtain the ID of the storage cluster by running the command described in Obtaining information about storage clusters or clicking the Storage Cluster Information in the GUI.
After reconfiguring a storage cluster, the license key issued before configuring a storage cluster cannot be used for a new storage cluster. In this case, contact your sales account representative to re-issue a license key that corresponds to the new storage cluster ID.
The following license types are available for different capacities and periods.
|
Type |
Expiration time |
Capacity limit |
Description |
|
Perpetual * |
No |
Yes |
The specified capacity (registrable storage pool capacity) can be used indefinitely. If the type of the existing license is "Perpetual", the type of license you can register newly is "Perpetual" or "Subscription". If you register a "Subscription" license later, your license returns to a "Perpetual" license when the "Subscription" license expires or when you delete the "Subscription" license. |
|
Subscription |
Yes |
Yes |
Determine the period during which the specified capacity (registrable storage pool capacity) can be used. If the type of the existing license is "Subscription", the type of license you can register newly is "Perpetual" or "Subscription". |
|
* Not currently sold | |||
There are two types of licenses: the base license, which enables the basic functions of Virtual Storage Software block, and the program product licenses, which enable the corresponding value-added functions.
|
Program product name |
Type |
Description |
|
Hitachi SDS Core Base |
Base license |
This license manages the validity period for using Virtual Storage Software block and the size of available space in the storage pool. When this product is installed, the trial license, which enables unlimited capacity use for 60 days, is applied. |
The valid period of a license starts when Virtual Storage Software block is set up or a license is registered. The period ends at 23:59 of the last day. For example, if you register a Subscription license which is valid for one year at 13:00 on August 5, 2020, the license is valid until 23:59 on August 5, 2021.
The capacity enabled by a Perpetual or Subscription license is "totalCapacity" (logical capacity of the storage pool) obtained as described in Obtaining a list of information about storage pools or Obtaining information about individual storage pools.
"status" of a license shows whether the license is valid. "statusSummary" shows whether an error occurred for the license. You can obtain status and statusSummary of a license through an operation as described in Obtaining a list of license information or Obtaining information about individual licenses.
|
Status |
Description |
statusSummary |
|
Active |
The license is invalid.
|
Normal |
|
Warning |
Although the license is valid, a warning threshold is exceeded. In the case of a Perpetual license: • Warning threshold ≤ Consumed capacity < Licensed capacity In the case of a Subscription license (one of the following cases): • Warning threshold ≤ Consumed capacity < Licensed capacity • Warning threshold ≤ Use period < Licensed period You can determine which one is the cause by verifying the "cause" obtained as described in Obtaining a list of license information or Obtaining information about individual licenses. In a warning status, a warning event log is output. The status becomes active when the user changes the warning threshold or removes the cause of the warning threshold being exceeded. |
Warning |
|
GracePeriod |
The license has expired or the licensed capacity is exceeded. In the case of a Perpetual license: • Licensed capacity ≤ Consumed capacity In the case of a Subscription license (one of the following cases): • Licensed capacity ≤ Consumed capacity • Licensed period ≤ Use period You can determine which one is the cause by verifying the "cause" obtained as described in Obtaining a list of license information or Obtaining information about individual licenses. In the GracePeriod, a warning event log is output. If 30 days pass in the GracePeriod state, the license becomes invalid. If a license with an additional period or capacity is registered during the GracePeriod, the license becomes active. |
Error |
|
Invalid |
The license is invalid. An error event log is notified. I/O operations are possible even when the license is invalid. The allowed management operations are license management and user management only. |
Error |
In addition to the statuses mentioned so far, an "Overwritten" status exists. An "Overwritten" status occurs when the license is temporarily invalid because a conflicting license exists.
If a license having an overlapping period is registered when the existing license is active, the existing license is overwritten. In this case, the license that is registered later becomes active. If the license registered later expires or is deleted, the existing license becomes active from the "Overwritten" status. However, if the existing license has expired or exceeded the licensed capacity at this time, it enters the GracePeriod from the "Overwritten" status.
For example, when you register a Perpetual license of 500 TiB when you are using 600 TiB, the Perpetual license enters the GracePeriod. If you register a Subscription license for 600 TiB in this state, the Perpetual license is overwritten and the Subscription license becomes active.
The default valid period of a license is 30 days and the default capacity threshold is 80%. If you set a warning threshold, you can receive a warning notification in an event log when the threshold is reached. To change the threshold setting, see Editing the license warning threshold.
Deleting a license (CLI or REST API)
Delete a license as follows. If no license exists after you delete a license, license deletion is not allowed.
Before you begin
Required role: Storage
Procedure
Verify the ID of the license to be deleted.
REST API: GET /v1/objects/licenses
CLI: license_list
Delete a license.
Run one of the following commands with the license ID specified.
REST API: DELETE /v1/objects/licenses/<id>
CLI: license_uninstall
Verify the job ID which is displayed after the command is run.
Verify the state of the job by specifying the job ID.
REST API: GET /v1/objects/jobs/<jobId>
CLI: job_show
If the job state is "Succeeded", the job is completed.
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 license information (CLI or REST API)
Obtain a list of information about a license as follows.
-
id: License ID (uuid)
-
programProductName: Program product name
-
status: License status
-
statusSummary: License status summary
-
cause: Reason for "Warning" or "Error" license status summary
-
keyType: License key type
-
permittedCapacityInTiB: Total logical capacity of all storage pools allowed by the license (null if no limitation is applied to the capacity)
-
totalPoolCapacityInGiB: Total logical capacity of all storage pools (null if no limitation is applied to the capacity)
-
remainingDays: Number of remaining days (null if the license is valid infinitely)
Before you begin
Required role: Storage, Monitor, or Resource
Procedure
Obtain a list of information about a license.
REST API: GET /v1/objects/licenses
CLI: license_list
Obtaining information about individual licenses (CLI or REST API)
The following information can be obtained.
-
License ID (uuid)
-
Program product name
-
Reason for "Warning" or "Error" license status or statusSummary
-
License key type
-
Total logical capacity of all storage pools allowed by the license (null if no limit is applied to the capacity)
-
Total logical capacity of all storage pools (null if no limitation is applied to the capacity)
-
Number of remaining days (null if the license is valid infinitely)
Before you begin
Required role: Storage, Monitor, or Resource
Procedure
Verify the ID of the license to be obtained.
REST API: GET /v1/objects/licenses
CLI: license_list
Obtain license information.
Run one of the following commands with the license ID specified.
REST API: GET /v1/objects/licenses/<id>
CLI: license_show
Editing the license warning threshold (CLI or REST API)
You can set a warning threshold as follows.
The initial values of the Virtual Storage Software block system (defaults after setup) are as follows:
-
Number of remaining days: 30
-
Warned capacity rate: 80
Before you begin
Required role: Storage
Procedure
Edit the license settings.
Run either of the following commands with the number of days and capacity rate until a warning will be issued specified.
REST API: PATCH /v1/objects/license-setting
CLI: license_setting_set
Verify the job ID which is displayed after the command is run.
Verify the state of the job by specifying the job ID.
REST API: GET /v1/objects/jobs/<jobID>
CLI: job_show
If the job state is "Succeeded", the job is completed.
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 license settings (CLI or REST API)
The following information can be obtained.
-
warningThresholdSetting: License warning threshold settings (number of remaining days and warned capacity rate)
Before you begin
Required role: Storage, Monitor, or Resource
Procedure
Obtain the license settings.
REST API: GET /v1/objects/license-setting
CLI: license_setting_show