Managing Storage Licenses

This section describes the process of managing Storage licenses. You will learn to do the following:

  • Install a new license for a Storage cluster.
  • Update the installed license.
  • View the installed license contents.
  • Check the current license status.

Obtaining the Hardware Node ID

The Hardware Node ID (HWID) is required to purchase a Storage license. You can obtain the HWID with the vstorage stat --license-hwid command. For example:

1
2
3
# vstorage -c stor1 stat --license-hwid
...
3F96.DFF2.EAF6.CE86.DD49.786C.DC01.3D53
A Storage Hardware Node ID is not the same as a Virtuozzo Hardware Node ID shown by the vzlicview command.

Installing the License

Along with installing Virtuozzo licenses on all clients in a cluster, you need to install a separate license to start using the Storage functionality. One license is required per cluster. You can install the license from any server participating in the cluster: an MDS server, a chunk server, or a client.

To install the license, use the vstorage load-license command:

1
# vstorage -c stor1 load-license -p XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX

If you have obtained the license in the form of a file, you can install it by using the -f option instead of -p and specifying the full path to the license file:

1
# vstorage -c stor1 load-license -f /etc/storlicense

Updating the License

In Virtuozzo, you can use the vstorage update-license command to update the license currently installed on your server. When executed, the utility connects to the Key Authentication (KA) server, retrieves a new license, downloads it to the server, and installs it there.

To update a license, do the following:

  1. Make sure that the server where you want to update the license is connected to the Internet.
  2. Run the vstorage update-license command to update the license.

For example, to update a license installed in the pcs1 cluster, execute this command:

1
# vstorage -c pcs1 update-license

By default, vstorage obtains a new license from the default KA server. However, you can explicitly specify what KA server to use by passing the --server option to the command:

1
# vstorage -c pcs1 update-license --server ka.server.com

Once you run the command, vstorage will connect to the KA server with the hostname of ka.server.com, download a new license, and install it on your server.

Viewing the License Contents

You can use the vstorage view-license command to view the information on the license currently installed in your cluster. When executed, the utility processes the license and shows its contents on the screen. A sample output of vstorage view-license is given below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# vstorage -c stor1 view-license
HWID: XXXX.XXXX.XXXX.XXXX.XXXX.XXXX.XXXX.XXXX
PCSSTOR
    status="ACTIVE"
    version=1.0
    expiration="08/24/2012 19:59:59"
    graceperiod=3600
    key_number="PCSS.XXXXXXXX.XXXX"
    platform="Linux"
    product="PCSS"
    gracecapacity=5
    autorecovery=0
    autorebalance=0
    snapshots=1
    capacity=500
    replicas=5

The main license parameters are explained in the table below.

NameDescription
HWIDCluster ID.
statusLicense status. For details, see Checking the License Status (p. 46).
versionVersion of Storage for which the license was issued.
expirationLicense expiration date and time.
graceperiodPeriod, in seconds, during which Storage continues functioning after the license has expired.
key_numberKey number under which the license is registered on the Key Authentication server.
platformOperating system with which the license is compatible.
productProduct for which the license has been issued.
gracecapacity

Amount of disk space that data chunks may occupy in the cluster, in per cent to the capacity limit value.

For example, if the capacity limit is set to 1 TB, and the grace capacity is 5%, data chunks may use 50 GB above the capacity limit.

capacity

Total amount of disk space, in GB, data chunks may occupy in the cluster.

To view the disk space currently used by chunks, run the vstorage top command, press the V key on your keyboard, and check the FS field. For details, see [Understanding Disk Space Usage](#). |

replicasMaximum number of replicas a data chunk may have.
autorecoveryDenotes whether the auto-recovery feature is enabled (1) or disabled (0).
autorebalanceDenotes whether the auto-rebalance feature is enabled (1) or disabled (0).
snapshotsDenotes whether the snapshots feature is enabled (1) or disabled (0).

Checking the License Status

You can check the status of your license in one of the following ways:

  • Using the vstorage view-license, for example:
1
2
# vstorage -c stor1 view-license | grep status
status="ACTIVE"
  • Using the vstorage stat or vstorage top command, for example:
1
2
3
# vstorage -c stor1 stat | grep License
connected to MDS#1
License: PCSS.XXXXXXXX.XXXX is ACTIVE

The table below lists all statuses a license can have.

StatusDescription
ACTIVELicense is valid and active.
VALIDLicense is valid and can be installed in the cluster.
EXPIREDLicense has expired.
GRACEDLicense is currently on the grace period or data chunks in the cluster use disk space from the grace capacity.
INVALIDLicense is invalid (for example, because its start date is in the future).