Skip to main content

We've Moved!

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

Managing license keys

Accessing software functionality for your storage system requires a license key.

Overview

When you install a license key, it is automatically enabled and the timer on the license starts at that time. To preserve time on a term key license, you can disable it without uninstalling it. When you need the software, enable the license again.

If you do not install the software before you install the license key software, the software will install correctly but will be disabled. To enable a license key, install the prerequisite software, and then enable the key.

License key types

To use software, you must install the license key provided when you purchase that software.

You can use software with licensed capacity for a term key by installing a term key and overwriting a permanent key as long as the term key is valid. If the term key expires when the system is being used, and the capacity needed for the operation is insufficient, operations that you can perform are limited. In this case, a SIM that indicates the term key expiration (reference code 7ff7xx) is output on the Alerts tab in the Storage Systems window.

The following table describes the four types of license keys.

Type

Description

Effective term1

Estimating licensed capacity

Permanent

For purchase

No limit

Required

Term

For purchase

365 days

Required

Temporary

For trial use before purchase (try and buy)

120 days

Not required

Emergency

For emergency use

30 days

Not required

Notes:

  1. When you log in to Device Manager - Storage Navigator, a warning message appears if 45 days or less remain before the expiration.

Using the permanent key

You can purchase the permanent key to use a software application indefinitely. You must estimate a licensed capacity required for using the software application and purchase a license key for the amount of the required capacity.

  • If insufficient license capacity is installed, Not Enough License displays in the status field of the License Keys window, and the software application is not enabled.
  • If the capacity of the usable volume exceeds the licensed capacity while the storage system is running (for example, when an LDEV is additionally installed), Grace Period displays in the status field of the License Keys window. You can continue to perform the same operations, but the deficient amount of license capacity must be purchased within 30 days.

Using the term key

You can purchase the term key to use the software application for a specific number of days. You must estimate a licensed capacity required for using the software application and purchase a license key for the amount of the required capacity.

  • If insufficient license capacity is installed, Not Enough License or Grace Period displays in the status field of the License Keys window.
  • You can enable or disable the term key for each software application. Unlike the temporary key and the emergency key, the number of days the term key is enabled is counted as the number of effective days of the term key rather than the number of elapsed days from the installation date.
  • The number of effective days is decremented by one day when the date changes.

    For example, if the term key is set to be enabled for 150 days during installation and the term key is disabled for 100 days and a total of 250 days have elapsed since the installation, the number of remaining effective days of the term key is 215 days. This is determined by subtracting 150 days from 365 days. By disabling the term key on the days when the software application is not used, you can prevent the unnecessary shortening of the period in which the term key can be used.

  • If the term key is expired, Not Installed displays in the status field of the License Keys window, and the software application is disabled.

Using the temporary key

You can use the temporary key for trial purposes. The effective term is 120 days from the time of installation of the temporary key. The effective term is not increased even if the temporary key is reinstalled during the effective term.

If you uninstall the temporary key, even though the effective term remains, Temporary is displayed in the status field, Not Installed is displayed in the Key Type field, and the remaining days of the effective term are displayed in the Term (Days) field of the License Keys window.

If the temporary key expires, you cannot reinstall the temporary key for 180 days. Expired displays in the status field of the License Keys window, and the software application is disabled.

Using the emergency key

You can use the emergency key if the license key cannot be purchased, or if an emergency occurs, such as a system failure or a communication error.

You can also use the emergency key if the configuration of the software application that is installed by the temporary key remains in the changed status and cannot be restored to the original status. For example, if you do not plan to purchase the software application after using the temporary key for trial purposes, you can restore the changed configuration to the original status by temporarily enabling the software application with the emergency key.

Caution
  • If an emergency key is installed for a software application for which a permanent or term key is installed, the effective term of the license key is 30 days. However, because the emergency key can be reinstalled during the effective term, the effective term can be restored to 30 days.
  • In other scenarios, the emergency key can be installed only once.

Cautions on license capacities in license-related windows

License capacities are displayed not only in license-related windows but also in the Pools window and the Replication window.

When you install or overwrite a temporary key or an emergency key for an installed software application, the license capacity before the overwrite installation is displayed as Permitted (TB) in license-related windows. However, Unlimited (license capacity for the temporary key or emergency key) is displayed as Licensed Capacity in the Pools window and the Replication window.

For example: You install a term key that has a license capacity of 5 TB for Compatible FlashCopy®, and when the term expires, you use an emergency key. In license-related windows, 5 TB is displayed in the Permitted (TB) field. However, in the Licensed Capacity field in a Replication window, Unlimited (capacity of the emergency key) is displayed.

Estimating licensed capacity

The licensed capacity is volume capacity that you are licensed to use with the software application. You must estimate the amount of capacity that you want to use with the software application before you purchase the permanent key or the term key.

Software and licensed capacity

The following table describes the three types of licensed capacity: used capacity, mounted capacity, and unlimited capacity. The type you select depends on the software application.

CautionIf you use Dynamic Provisioning, the licensed capacity might become insufficient because the used capacity of Dynamic Provisioning pools could increase, even if you do not add any volumes. If this happens, you must purchase an additional license within 30 days to increase the capacity to match the new volume size. For instructions to calculate pool capacity, see the Provisioning Guide.
Licensed capacity types
Type Description
Used capacity The licensed capacity is calculated by using one of the following capacities:
  • Normal volumes (volumes)
  • External volumes mapped to the storage system
  • Pools

If the pool contains pool volumes that belong in accelerated compression-enabled parity groups, you must purchase physical capacity of the pool for the license capacity.

Mounted capacity /usable capacity The licensed capacity is estimated by using the capacity of all the volumes in the storage system.

When you estimate for the capacity of the accelerated compression-enabled parity groups, the physical capacity of the parity group is the maximum of the estimated capacity, even if you created an internal volume which exceeds the physical capacity of the accelerated compression-enabled parity group. See the Provisioning Guide for an explanation of accelerated compression.

Unlimited capacity You can use the software regardless of the volume capacity.

The following tables list the software bundles and specify the licensed capacity type(s) for each bundle.

Software bundle licensed capacity for VSP E series
Software bundleLicensed capacity
Base PackageUsed capacity or mounted capacity
Advanced PackageUsed capacity or mounted capacity
Remote Data ProtectionUsed capacity or mounted capacity
Global-active deviceUsed capacity or mounted capacity
Software bundle licensed capacity for VSP G/F350, G/F370, G/F700, G/F900
Software bundle VSP G350, G370VSP G700, G900VSP F350, F370, F700, F900
Hitachi Foundation Suite Unlimited Used capacity or mounted capacity Unlimited
Hitachi Remote Data Protection Unlimited Used capacity or mounted capacity Unlimited
Global-active device Unlimited Used capacity or mounted capacity Unlimited
Hitachi Encryption License Key Unlimited Unlimited Unlimited

Calculating licensed capacity for a normal volume

A normal volume is a volume that is not blocked or protected. For OPEN-V volumes, the licensed capacity of a volume is the same as the capacity specified when creating the volume.

Calculating licensed capacity for an external volume

Use the following equation to calculate the licensed capacity for an external volume:

External Volume Capacity (KB) = Volume Capacity (number of blocks) X 512 (bytes) / 1,024

Calculating pool capacity

The license capacity of Dynamic Provisioning is calculated using the total capacity of the Dynamic Provisioning pool. If you use Dynamic Provisioning V-VOLs as P-VOLs or S-VOLs of ShadowImage, TrueCopy, Universal Replicator, or global-active device, the license capacity of ShadowImage, TrueCopy, Universal Replicator, or global-active device is calculated by using the page capacity allocated to the Dynamic Provisioning V-VOLs (that is, used pool capacity).

For more information on calculating pool capacity, see the Provisioning Guide.

Accelerated compression-enabled parity group capacity

For the actual capacity of accelerated compression-enabled parity groups, the total capacity of LDEVs created in the parity group and the physical capacity are compared. The one with the least capacity is added as the actual capacity. See the following table for an example.

Total LDEV capacity in the parity group Physical capacity Actual capacity which is added
12 TB 20 TB 12 TB
24 TB 20 TB 20 TB

Installing license keys using maintenance utility

When installing a software product that enables you to use additional features, you first need to register the license key provided when you purchased that software product.

Before you begin

Prepare the license key code or the license key file for the software product to be installed.

Procedure

  1. In the navigation bar, click GUID-86A03C30-5E3C-4836-88C3-5B6794E8056F-low.gif (Settings), and then select Licenses.

  2. In the maintenance utility, click Install.

  3. Specify the license key code or the license key file, and register the license key.

    TipFor more information, refer to Help in the maintenance utility.
  4. In the list of license keys, confirm that the status of the software product has changed to Installed.

  5. In the maintenance utility, click Log Out.

Managing licenses

Use the Licenses window in the maintenance utility to install and uninstall block license keys.

GUID-69C0E674-A0EC-4CFA-9A4D-4657333B5071-low.png

CautionIf you use Dynamic Provisioning, the licensed capacity might become insufficient because the used capacity of Dynamic Provisioning pools could increase even if you do not add any volumes. If this occurs, you must purchase an additional license within 30 days to cover the capacity shortage. For details on how to calculate pool capacity, see the Provisioning Guide.
CautionWhen you remove Data Retention Utility an error might occur even if the Permitted Volumes column of the License Keys window indicates that the licensed capacity is 0 TB.

Installing block and file licenses using NAS Manager

Use NAS Manager to install and enable both block and file license keys on VSP Gx00 models with NAS modules. Using NAS Manager, you can install both block and file licenses but only remove file licenses. To remove block licenses, you must use the maintenance utility.

Adding a license key

Adding a license key can enable services or increase the capabilities of your system. To add a license key:

Procedure

  1. Navigate to Home Server Settings License Keys.

  2. Click add.

    GUID-4779507B-8191-4DE7-AC4D-B5445780F5D0-low.png

    The following table describes the fields on this page:

    Field/Item Description
    Add a File License Key
    File License Key Enables the user to manually enter the license key.
    Import File License Keys From a File
    File License Key File Name Enables the user to import a license key from a file.
    Import Block License Keys From a File (NAS module only)
    Block License Key File Name Enables the user to import a software application license key from a file.
    cancel Closes the page without saving configuration changes.
    NoteAfter adding a license key, if a reboot is required in order to start a service/protocol or enable a feature, you are instructed to reboot or restart the system.
    For a file license, you can either enter the key manually or import it from a file. For a block license, you can only import the key from a file:
    • To enter the key manually, type it in the field, then click add.
    • To import the key, click Choose File / Browse, navigate to the file, select the key file, then click Import.

    After all the keys have been entered or imported, they will be displayed on the License Keys page. Follow the instructions to reboot the system (if necessary).

Installing block licenses using maintenance utility

Before you begin

You must have the Storage Administrator (Initial Configuration) role to perform this task.
NoteIf you do not install the prerequisite software before you install the license key software, the software will install correctly but will be disabled. To enable a license key, install the prerequisite software, and then enable the key.

Procedure

  1. In the maintenance utility Administration tree, select Licenses.

  2. Select whether to enter a key code or specify a license key file.

    • Key Code: Enter a key code to install the software. In Key Code, enter the license key code for the software.
    • File: Specify a license key file to install the software. Click Browse and specify the license key file. You can use a file name of up to 200 alphanumeric characters excluding these symbols: (“ \ : ; , * ? < > | / ). Include the .plk file extension.
  3. Click Apply.

Enabling a license

You can enable a license that is in disabled status.

Before you begin

You must have the Storage Administrator (Initial Configuration) role to perform this task.

Procedure

  1. From the Maintenance Utility menu, click License Keys to open the License Keys window.

  2. Select the license to enable. You can select from one to all of the licenses listed in the window at the same time.

  3. Click Enable to display the License Keys window.

  4. Check the settings and click Apply.

Disabling a license

You can disable a license that is in enabled status.

Before you begin

You must have the Storage Administrator (Initial Configuration) role to perform this task.

Procedure

  1. From the Maintenance Utility menu, click License Keys to open the License Keys window.

  2. Select the license to disable. You can select from one to all of the licenses listed in window the at the same time.

  3. Click Disable to display the License Keys window.

  4. Click Finish.

  5. Check the settings and click Apply.

Removing a software license

You can remove a software license that is in disabled status.

Before you begin

You must have the Storage Administrator (Initial Configuration) role to perform this task.

Procedure

  1. In the maintenance utility Administration tree, click License Keys.

  2. In the License Keys window, select the license to uninstall. You can select from one to all of the licenses listed in the window at the same time.

  3. In the License Keys window, click Uninstall Licenses.

  4. Check the settings and click Apply.

    On rare occasions, a software option that is listed as Not Installed but still has available licensed capacity (shown as XX TB) might remain in the list. In this case, select that option and uninstall the software.
    NoteTo reinstall a license key after uninstalling it, contact customer support to reissue the license key file.

Removing a Data Retention Utility license

CautionWhen you remove a Data Retention Utility license, an error might occur, even if the Permitted Volumes column of the License Keys window indicates that the licensed capacity is 0 TB.

Procedure

  1. Click Actions Other Function Data Retention to open the Data Retention window.

  2. In the Data Retention window, find logical volumes that are unusable as S-VOLs.

  3. Change the settings so that the logical volumes are usable as S-VOLs.

  4. Uninstall the Data Retention Utility.

Examples of license information

The following table provides examples of license information displayed in the License Keys table of the maintenance utility.

NoteWhen using Volume Migration, you do not need to install the license key. The function of Volume Migration is available regardless of the license key status displayed in the maintenance utility.

License key status (example)

Status

Key type

Licensed capacity

Term (Days)

Not installed

Not installed

blank

Blank

Blank

Installed with the permanent key

Installed

permanent

Permitted

-

Installed with the term key and set to Enabled

Installed

term

Permitted

Number of remaining days before expiration

Installed with the term key and set to Disabled

Installed (Disabled)

term

Permitted

-

Installed with the temporary key.

Installed

temporary

-

Number of remaining days before expiration

Installed with the emergency key.

Installed

emergency

-

Number of remaining days before expiration

A temporary key was installed, but has expired.

Expired

temporary

-

Number of remaining days before expiration

A term key or an emergency key was installed, but has expired.

Not installed

blank

Blank

Blank

Installed with the permanent key or the term key, but the licensed capacity was insufficient.

Not Enough License

permanent or term

Permitted and Used

-

Installed with the permanent or term key, and then LDEVs are added, but the license capacity was insufficient.

Grace Period

permanent or term

Permitted and Used

Number of remaining days before expiration

Installed with the temporary key, and then reinstalled with the permanent key, but the license capacity was insufficient.

Installed

temporary

Permitted and Used

Number of remaining days before expiration

Installed with the permanent or term key, then reinstalled with the emergency key.

Installed

emergency

Permitted and Used

Number of remaining days before expiration

License key expiration

If the license key for software-A expires, the license key for software-B is also disabled if software-B requires an enabled software-A. In this scenario, Installed (Disabled) is shown for software-B in the Status column of the License Keys table. After that, when you re-enable software-A, software-B is also re-enabled. If the Status column for software-B continues to display Installed (Disabled), go to the License Keys table and manually change the status of software-B back to Installed.

After your license key expires, no new configuration settings can be made, and no monitoring functions can be used with Performance Monitor. Configuration settings made before the expiration of the license key remain in effect. You can cancel configuration changes for some software.