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.

License keys overview

When you install a license key, it is also enabled. The functionality for the software that you installed is available in Device Manager - Storage Navigator.

The license key can be disabled. This allows you to conserve time on a term key, for example. If you have a 365-day term key for a software product, the license server starts the count the day you install the key. However, you may not use the license immediately, in which case you can disable the key. Disabling stops the count. You re-enable the key when you become ready to use it.

This topic provides information in the order it is required:

  • License key types. Lists the key types; explains whether keys are permanent or temporary; shows the term limit, if any; and provides the estimated license capacity, if required.
  • Using the term key. Explains that you can conserve the term key when you are not using it.
  • Using the temporary key. Explains that you can conserve the temporary key when you are not using it.
  • Estimating licensed capacity. Provides information and instructions for calculating license capacity according to your system and organization requirements.
  • Installing and uninstalling software. Provides instructions for installing, disabling, enabling, and removing keys.
  • License key expiration provide information for dealing with these situations.

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.

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

Three licensed capacity types are available. The one you choose depends on the software application. The following tables describe the licensed capacity types:

Table 1: 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 table lists the software and the licensed capacity.

Option name

Licensed capacity

Notes

HDvM/Device Manager - Storage Navigator

Mounted capacity

SNMP Agent

Mounted capacity

JAVA API

Mounted capacity

SMI-S Provider

Mounted capacity

LUN Manager

Mounted capacity

Used only for open-system devices (including LUN security).

Virtual LVI

Mounted capacity

Open Volume Management

Mounted capacity

Used only for open-systems devices

Volume Shredder

Mounted capacity

Cache Residency Manager

Mounted capacity

Cache Residency Manager for Mainframe

Mounted capacity

Performance Monitor

Mounted capacity

Server Priority Manager

Mounted capacity

To use Server Priority Manager, first install Performance Monitor.

Volume Migration

Mounted capacity

To use Volume Migration, first install Performance Monitor.

For information about Volume Migration, contact the customer support.

Volume Migration V2

Mounted capacity

For information about Volume Migration V2, contact the customer support.

TrueCopy

Used capacity for normal volumes1

Default state1

TrueCopy for Mainframe

Used capacity for normal volumes1

Universal Replicator

Used capacity for normal volumes1

To use Universal Replicator, first install TrueCopy.

Universal Replicator for Mainframe

Used capacity for normal volumes1

To use Universal Replicator for Mainframe, first install TrueCopy for Mainframe.

Disaster Recovery Extended

Unlimited

To use Disaster Recovery Extended, first install Universal Replicator or Universal Replicator for Mainframe. See the prerequisites for these in the two rows directly above this one.

ShadowImage

Used capacity for normal volumes1

ShadowImage for Mainframe

Used capacity for normal volumes1

Compatible FlashCopy® V2

Used capacity for normal volumes1

Hitachi Compatible FlashCopy®

Used capacity for normal volumes1

Thin Image

Used capacity for normal volumes1 + total pool capacity

To use Thin Image, first install Dynamic Provisioning.

Dynamic Provisioning

Used capacity (Total pool capacity)

Dynamic Provisioning for Mainframe

Used capacity (Total pool capacity

To use Dynamic Provisioning for Mainframe, first install Dynamic Provisioning.

Dynamic Tiering

Used capacity (Total pool capacity)

To use Dynamic Tiering, first install Dynamic Provisioning.

Dynamic Tiering for Mainframe

Used capacity (Total pool capacity

To use Dynamic Tiering for Mainframe, first install Dynamic Provisioning for Mainframe and Dynamic Tiering.

Active flash

Used capacity (Total pool capacity

To use active flash, first install Dynamic Tiering.

Active flash for mainframe

Used capacity (Total pool capacity

To use active flash for mainframe, first install active flash and Dynamic Tiering for Mainframe.

Compatible PAV

Used capacity for normal volumes

Compatible Hyper PAV

Unlimited

To use Compatible Hyper PAV, first install Compatible PAV.

Compatible XRC

Used capacity for normal volumes

For controller emulation type I-2107 only.

FICON® Data Migration

Used capacity for external volumes

High Performance Connectivity for FICON®

Unlimited

Data Retention Utility

Mounted capacity

Volume Retention Manager

Mounted volumes

Universal Volume Manager

Used capacity for external volumes

Virtual Partition Manager

Unlimited

You may use up to four CLPRs without the Virtual Partition Manager license key. With a license key, you can define up to 32 CLPRs.

Resource Partition Manager

Unlimited

Nondisruptive migration

Used capacity for external volumes.

Encryption License Key

Unlimited

FMD Encryption License Key

Unlimited

Global-active device

Used capacity for normal volumes1

High temperature mode

Unlimited

FIPS140-2 Level2

Unlimited

To use, first install Encryption License Key.

VSP F1500 All Flash Array

Unlimited

A license key which is required for VSP F1500.

Dedupe and compression

Unlimited

A license which is required to use the capacity saving function. To use the capacity saving function, you need to install Dynamic Provisioning.

VSP G1500 and F1500 VSD

Unlimited

A license which is required to upgrade from VSP G1000 to VSP G1500. To upgrade to VSP G1500, change the MP blade type from MPB1 to MPB2 before installing this license.

Notes:

  1. If you use V-VOLs of Dynamic Provisioning, Dynamic Provisioning for Mainframe, Dynamic Tiering, or Dynamic Tiering for Mainframe as P-VOLs or S-VOLs of the following software applications, the license capacity is calculated using the page capacity allocated to the V-VOLs (that is, used pool capacity).
    • ShadowImage
    • Thin Image
    • TrueCopy
    • Universal Replicator
    • ShadowImage for Mainframe
    • TrueCopy for Mainframe
    • Universal Replicator for Mainframe
    • Compatible FlashCopy®
    • Global-active device

Calculating licensed capacity for a normal volume

A normal volume is a volume that is not blocked or protected. The volume can be written to. The calculation of the normal volume capacity depends on the volume emulation type. Use the formula in the following table to estimate capacity for purchase. When you calculate the volume capacity, round the value up to the second decimal place.For OPEN-V volumes, the licensed capacity of a volume is the same as the capacity specified when creating the volume.

Table 1: Formulas for calculating capacity of a normal volume

Volume emulation type

Formula for calculating capacity of a normal volume

3390-x1

870 KB × number-of-user-cylinders

OPEN-x1

Same as the capacity specified when creating the volume

Notes:

  1. x indicates a number or a letter. For example, OPEN-x refers to emulation types such as OPEN-3 and OPEN-V.

An example is shown in the following table.

Table 2: Example of calculating license capacity

Item

Value

Volume emulation type

3390-3

Number of user cylinders

3,339

Number of volumes

2,048

Total capacity of all the volumes

870 KB × 3,339 × 2,048 = 5,949,296,640 KB

5,949,296,640 KB / 1,024 = 5,809,860 MB

5,809,860 MB / 1,024 GUID-6A91F271-B305-45B9-A5C7-63463FBB1BC6-low.png 5,673.70 GB

5,673.70 GB / 1,024 GUID-6A91F271-B305-45B9-A5C7-63463FBB1BC6-low.png 5.55 TB

Estimated required capacity

At least 6 TB

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 for Open Systems and the Provisioning Guide for Mainframe Systems.

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 and uninstalling software

This section provides instructions for installing and uninstalling software.

Installing license keys using Device Manager - Storage Navigator

Use license keys to install software.

Before you begin

  • You must have the Storage Administrator (Initial Configuration) role to perform this task.
  • You must install a license key for each software application before you use it.

Procedure

  1. From the Administration tree, click License Keys.

  2. In the License Keys window, click Install Licenses.

  3. 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 several symbols (" \ ; : * ? < > | / ,). The file extension is "plk".
  4. Click Add .

  5. In the Selected License Keys table, set the status of license keys for each software application.

    • Enable Licenses: Installs license keys in enabled status. You can select more than one software application to install licenses for.
    • Disable Licenses: Installs license keys in disabled status. You can select more than one software application to install licenses for.
    • Clear All: Delete all license keys from the Selected License Keys table.
  6. Click Finish. The Confirm window opens.

  7. In the Confirm window, check the settings. In the Task Name field, enter a task name.

  8. Click Apply. The task is registered. If the Go to tasks window for status check box is checked, the Task window opens.

    If a software installation fails, the Error Message window opens. To display the cause of error, from the Error Message window, select the software and click Detail.

When the status is Installed (Disabled)

If 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.

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 Administration tree, click License Keys.

  2. In the License Keys window, select one or more licenses to enable, and then click Enable Licenses.

  3. Check the settings, and then 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 Administration tree, click License Keys.

  2. In the License Keys window, select one or more licenses to disable, and then click Disable Licenses.

  3. Check the settings, and then click Apply.

Removing a software application

Remove software from the storage system by uninstalling license keys.

Before you begin

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

Procedure

  1. From the Administration tree, click License Keys.

  2. In the License Keys window, select one or more licenses to uninstall.

    Note

    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 then uninstall the software.

  3. Click Remove to display the Remove Licenses window.

  4. Check the settings, and then click Apply.

    Note

    To reinstall a license key after uninstalling it, contact customer support to reissue the license key file.

Updating license status

In the following cases, the status of software might remain at Not Enough License or Grace Period. In that case, update the license status.

  • When the licensed capacity exceeds the mounted capacity after you reduce the number of LDEVs
  • When the licensed capacity exceeds the used capacity after you delete pairs or pool volumes

Before you begin

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

Procedure

  1. From the Administration tree, click License Keys.

  2. In the License Keys window, click Update License Status.

  3. Check the settings, and then click Apply

Examples of license information

The following table provides examples of license information displayed in the License Key window.

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

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.

Cautions on licenses

Observe the following precautions when working with licenses:

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 for Open Systems.
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.

Resolving errors when removing Data Retention Utility

If a Data Retention Utility error occurs during removal, you must resolve it before continuing removal.

For details about the Data Retention window, see the Provisioning Guide for Open Systems.

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 (secondary volumes).

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

  4. Uninstall Data Retention Utility.

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.