Encryption License Key User Guide For VSP One Block
Encryption License Key User Guide For VSP One Block
SVOS
MK-23VSP1B010-02
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 1/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
The data-at-rest encryption feature, called Encryption License Key, protects your sensitive data against
breaches associated with storage media (for example, loss or theft). Encryption License Key provides a
controller-based encryption implementation.
Hardware-based Advanced Encryption Standard (AES) encryption, using 256-bit keys in the XTS
mode of operation, is provided.
Encryption can be applied to some or all supported internal drives.
Each encrypted internal drive is protected with a unique data encryption key (DEK).
Encryption has negligible effects on I/O throughput and latency.
Encryption requires little to no disruption of existing applications and infrastructure.
Cryptographic erasure (media sanitization) of data is performed when an internal encrypted drive is
removed from the storage system.
Encryption hardware
The data at-rest encryption (DARE) functionality is implemented using cryptographic hardware
(chips) on the encrypting controllers (ECTLs) of the VSP One Block storage systems. The ECTLs
encrypt and decrypt data as it is being written to and read from the cache memory.
Enabling and disabling data encryption is controlled at the dynamic-drive-protection (DDP) group
level. All drives in a DDP group (parity group) are either encrypting or non-encrypting. While it is
possible to have both encrypting and non-encrypting DDP groups configured on an ECTL, best
practice is to encrypt all DDP groups on an ECTL.
Key management
Key management for VSP One Block is integrated within the storage system. Each encrypted
internal drive is protected with a unique DEK that is used with the AES-based encryption. AES-XTS
uses a pair of keys, so each key used as a DEK is actually a pair of 256-bit keys. The DEKs are
stored in the shared memory of the storage system. When the storage system boots, the DEKs in
shared memory are used.
The initial set of encryption keys is generated during the initial encryption setup. Any keys that are
not assigned to drives are designated as Free keys and will be available for use. Encryption keys
are generated with the Free (unused) attribute, and the attribute is changed depending on the use
of the key:
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 2/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
When encryption is enabled for a DDP group, DEKs are automatically assigned to the drives in the
DDP group. Similarly, when encryption is disabled, DEKs are automatically replaced: old DEKs are
destroyed, and keys from the free keys are assigned as new DEKs. You can combine this
functionality with migrating data between DDP groups to accomplish rekeying of the DEKs.
Key management server (KMS)
You can use encryption keys created by a KMS that conform to the Key Management
Interoperability Protocol (KMIP) standard. In addition, you can back up encryption keys to a KMS
and restore encryption keys from the backups on the KMS. When an encryption key is backed up
to a KMS, it is encrypted with another encryption key and stored with that encryption key on the
KMS.
Key rotation
Whenever possible, consider using an external KMS and KMIP to automate the encryption key
rotation process to ensure consistency and reduce the risk of human error. Refer to regulatory
requirements and industry standards that may dictate key rotation schedules, such as the following:
NIST Special Publication 800-57: This publication from the National Institute of Standards
and Technology (NIST) provides comprehensive guidance on key management practices,
including key rotation. It recommends regular key rotation based on the sensitivity and
usage of the keys.
PCI DSS (Payment Card Industry Data Security Standard): This standard specifies the
requirements for rotating cryptographic keys for organizations that handle credit card
information.
SOX (Sarbanes-Oxley Act): SOX requires public companies to establish, document, and
maintain internal controls over financial reporting, which can include encryption key
management practices such as key rotation.
Important: If a key compromise is suspected, rotate the encryption keys immediately and
investigate the cause of the compromise.
Primary backup
The storage systems store an encrypted copy of the DEKs in shared memory. A primary backup
(encrypted) of these keys is also made on the flash memory of the ECTLs in the storage system.
When the storage system boots, the DEKs in shared memory are used. If the DEKs in shared
memory are missing or corrupted, the primary backups on the ECTLs are used.
Secondary backup
Secondary backup of encryption keys is performed by the user using VSP One Block Administrator
or the REST API. For this reason, it is the responsibility of the user to store the secondary
encryption key backup. If the primary backup becomes unavailable, a secondary backup is required
to restore the encryption keys. To perform a secondary backup, a dedicated user role, Security
Manager (View & Modify), is required.
CAUTION:
If the primary backup becomes unavailable and no secondary backup exists, the system cannot
decrypt the data.
You can make secondary backups of the keys to a key file on the management client or to a KMS.
If secondary backups are used, it is important that they contain the current DEKs. Make sure to
perform secondary key backups after operations such as generating keys. If the encryption
environment is set to connect to a KMS, the keys cannot be backed up as a file on the
management client.
When backing up by connecting to a KMS, the number of keys that can be backed up to the KMS is
one generation, including secondary backup and automatic backup. The old keys are overwritten
during backup. Encryption keys are backed up against the already created encryption keys.
Important: The creation and secure storage of backup keys must be included as part of your
corporate security policy. To ensure data availability, back up the encryption keys immediately after
they are created and also after each hardware maintenance in which a drive or ECTL is replaced.
You are responsible for storing the secondary backup keys securely.
Automatic backup (KMS only)
If you are using a KMS, the encryption keys are automatically backed up after they are created.
This is called the automatic backup. The number of keys that can be backed up to the KMS is one
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 3/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
generation, including the secondary backup and automatic backup. The old keys are overwritten
during backup.
If you are not using a KMS, automatic backups are not performed.
Restoring encryption keys
If an existing encryption key becomes unavailable, for example, due to a failure, the encryption key
is restored from the primary backup or secondary backup.
Restoring an encryption key from the primary backup is done automatically by the storage
system.
Restoring an encryption key from the secondary backup is performed by the user. To
restore an encryption key from the latest secondary backup, the Security Manager (View &
Modify) user role is required. To restore an encryption key from a secondary backup that is
not the latest, the Security Manager (View & Modify) role and the Maintenance (Vendor
Only) role) are required.
Decrypting data
To decrypt an encrypted DDP group, you can delete the DDP group. When you delete an encrypted
DDP group, the encryption keys for the drives in the group are deleted and new encryption keys
are assigned.
CAUTION:
Care must be taken when decrypting data. You are responsible for backing up any required data in
a DDP group before decrypting it. Alternatively, decrypt the entire DDP group before formatting it,
such as when adding a DDP group or formatting using the LDEV format feature.
Audit logging
The Audit Log feature provides logging of events that occur in the storage system, including events
related to encryption and data encryption keys. You can use the audit log to check and troubleshoot
encryption key generation and backup. For details about audit logging and audit log events, see the
VSP One Block System Administrator Guide.
Key usage for maintenance operations
Encryption keys are used when the following operations and maintenance tasks are performed.
Operation or maintenance task Number of keys Notes
used*
Adding drives 1 per drive You will need one unused key for
each drive being added.
Replacing drives 1 per drive You will need one unused key for
each drive being replaced.
Deleting an encryption-enabled 1 per drive You will need one unused key for
DDP group each drive in the DDP group being
deleted.
* If a failure occurs during the above operations or maintenance tasks, more than the above
number of unused keys might be required for recovery.
Item Specification
Managing Creating and deleting You can manage the encryption keys, including
encryption keys encryption keys creating, backing up, restoring, and deleting keys.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 4/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
Item Specification
For details, see User interface support for encryption.
Attribute of encryption keys Encryption keys are created with the Free attribute.
When a key is allocated to a drive, the attribute
changes to DEK.
When free keys are used After the encryption environment is set up, free keys
are used when the following operations are
performed:
You can perform encryption operations on your VSP One Block storage systems using the following user
interfaces (UIs):
REST API
VSP One Block Administrator
VSP One Block Administrator API
Command Control Interface (CCI)
The following table lists the encryption operations for VSP One Block and indicates the UI support for each
operation.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 5/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
GUI API
Item Requirements
The VSP One Block storage systems are shipped with ECTLs already installed
and encryption enabled.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 6/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
Item Requirements
Note: If the license for Encryption License Key is deleted or expires, encryption
keys cannot be created.
For details about UI support, see User interface support for encryption.
User roles The Security Administrator (View & Modify) role is required for setting up
encryption, enabling encryption on DDP groups, removing encryption, and
backing up and restoring encryption keys.
The Security Administrator (View & Modify) and Support Personnel (Vendor
Only) roles are required to restore an encryption key that is not the latest key
from a secondary backup copy.
Data volumes Data can only be encrypted on internal volumes of the storage system. External
volumes cannot be encrypted.
DNS server If you want to connect to a KMS by specifying a host name instead of an IP
address, set the DNS server in the network information of the management port
of the storage system.
KMS requirements
Item Requirements
Certificates To connect to the KMIP server, you must upload the following certificates to the
storage system:
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 7/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
Item Requirements
The client certificate must be converted to PKCS#12 format. In addition, client
certificates before converting to PKCS#12 format must be signed by the
Certificate Authority of the KMS.
Please pay attention to the expiration date when preparing the certificate. When
the certificate expires, you will not be able to connect to the KMS.
SSL/TLS For SSL/TLS communication and certificate requirements between the storage
communication system and the KMS, see the System Administrator Guide.
Number of KMSs Up to two other KMSs can be registered. If two KMSs are registered, they must
be clustered together. It is recommended to register two KMSs.
Use the following procedure to prepare the client certificate. Encryption keys backed up on the KMS are
managed with the client certificate. The client certificate on the KMS must remain current and not expired.
If the client certificate expires or is not current, the storage system will not be able to access the KMS.
CAUTION:
Encryption keys backed up to the KMS are managed in association with client certificates. If the
client certificate is lost and the storage system controller is replaced, the keys that were backed up
before the controller replacement cannot be restored.
When the connection settings are backed up to the KMS, the storage system does not back up the
client certificate. Make sure that you back up a copy of the connection settings to the KMS and
save a copy of the client certificate separately. Refer to your corporate security policy for
procedures related to backups.
The encryption keys backed up on the KMS are managed with the client certificate. If the client
certificate is changed, the encryption keys that were backed up before the change cannot be
restored. Make sure to back up the encryption keys immediately after changing the client
certificate.
Note:
For information about obtaining the root certificate of the KMS, see the documentation for the KMS.
When configuring the connection to the KMS, you must upload the KMS root certificate and the
client certificate in PKCS #12 format to the storage system. For details, see Configure the
encryption environment.
For details about creating a private key, see the System Administrator Guide.
For details about creating a public key, see the System Administrator Guide.
4. Have the public key file signed by the Certificate Authority (CA) office of the KMS.
For details, see the documentation for the KMS.
5. In the Windows command prompt, change the current folder to the folder where you want to save
the client certificate in the PKCS#12 format.
6. Move the private key file (.key) and the client certificate to this folder, and then run the following
command
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 8/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
In this command example:
Folder to output the client certificate file in PKCS #12 format: c:\key
Private key file name: client.key
Client certificate file name: client.crt
7. Type the client certificate password. This password is used when uploading a client certificate in
PKCS #12 format to the storage system.
The password can be from 0 to 128 characters in length. The valid characters for the password are:
Numbers (0 to 9)
Upper case letters (A-Z)
Lower case letters (a-z)
The following half-width symbols: ! # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
In this command example, the client.p12 file is created in the c:\key folder. This client.p12 file is a
client certificate converted to PKCS#12 format.
You can use VSP One Block Administrator, the REST API, or the initial configuration script to configure the
encryption environment settings. For details about using the initial configuration script, see Using the initial
configuration script to configure the encryption environment and Running the initial configuration script.
CAUTION:
When you use a KMS, the encryption keys backed up on the KMS are used when the storage system is
powered on. Communication between the storage system and the KMS must be established. If
communication with the KMS is not established, the storage system boots up but all volumes become
blocked. Make sure the storage system and the KMS can communicate before powering on the storage
system.
The following table lists the encryption environment settings and indicates when each setting should be
enabled.
Use the following procedure to configure the encryption environment using the REST API. If you are not
using a KMS, perform only step 4.
For details about using VSP One Block Administrator to configure the encryption environment, see the VSP
One Block Administrator User Guide.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 9/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
1. (KMS) Upload the client certificate and the root certificate using the following command:
Tip:
To upload the client certificate, use ClientCertFile for the attribute fileType.
To upload the root certificate, set the attribute fileType to RootCertFile.
2. (KMS) Set up a connection with the KMS using the following command:
3. (KMS) Perform a communication test with the KMS using the following command:
For details about the settings, see the Encryption environment settings table above.
After you have configured your encryption environment, you can begin performing encryption operations.
The first step is to enable encryption on the drives in the storage system.
Use the following workflow to configure the KMS settings for your encryption environment using the initial
configuration script.
2. Download and unzip the kmip.zip file from your storage system:
URL of the kmip.zip file on the storage system:
https://<service IP address>/download/restapi/kmip.zip
ShadowImage, TrueCopy If the primary volume (P-VOL) of a pair is encrypted, encrypt the
secondary volume (S-VOL) to ensure data security.
Thin Image Advanced Match the encryption states of the P-VOL and pool-VOL. If the P-VOL is
encrypted, encrypt all of the pool-VOLs. If the data pool contains an
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 10/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
Universal Replicator Match the encryption states of a P-VOL and S-VOL. If you encrypt the P-
VOL only, the data copied on the S-VOL is not encrypted and therefore not
protected.
Dynamic Provisioning When enabling encryption for data written to a data pool through a V-VOL,
use a data pool that consists of encrypted pool volumes.
Volume Migration Encrypt the source LDEV and the target LDEV. The encryption states of
the source and target LDEVs must match for the Encryption License Key
feature to encrypt and guarantee the security of the data on the source and
target LDEVs.
For details about the user interface support for encryption operations, see User interface support for
encryption.
Enabling encryption
Encryption can be enabled on drives only when a DDP (parity) group is created. When you enable data
encryption on a DDP group and then create new volumes in the DDP group, the data to be stored in those
volumes will be encrypted. In addition, you can migrate data from existing volumes to new encrypted
volumes to encrypt existing data. The data is migrated per V-VOL.
If a DDP group is created with encryption disabled, you cannot later enable encryption on that group.
You can use CCI to create DDP groups with encryption enabled.
Disabling encryption
The encryption setting for a DDP group cannot be changed from enabled to disabled. If you want to disable
encryption on drives, first migrate any volumes out of the target DDP group, delete the group, and then
create a new DDP group with encryption disabled. If desired, you can then migrate the volumes to the new
DDP group.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 11/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
The methods for backing up encryption keys differ depending on whether you use a KMS. You are
responsible for maintaining secondary backups of encryption keys and storing the password.
The primary backup and the secondary backup occur automatically to back up the encryption keys
to the KMS. No manual secondary backup operations are required.
If you want to make another backup of a specific key, or if you are instructed to perform a manual
backup, back up the encryption key to the KMS.
You can use the REST API to back up encryption keys on the KMS.
The primary backup of the encryption key occurs automatically, but the secondary backup requires
a manual operation. After enabling the encryption environment or creating encryption keys, back up
the encryption keys as a file on the management client.
If you want to make another backup of a specific key, or if you are instructed to perform a manual
backup, back up the encryption keys as a file on the management client.
Set a password when you back up encryption keys as a file on the management client. You will
need this password to restore the encryption keys.
You can use VSP One Block Administrator or the REST API to back up encryption keys as a file on
the management client.
Note: The number of keys that can be backed up to the KMS, together with automatic backups, is one
generation. The old keys are overwritten during backup.
If the encryption keys in the storage system, including the encryption keys backed up in the primary
backup, become unavailable, restore the encryption keys backed up in the secondary backup. You can
restore an encryption key from the secondary backup by using the file on the management client or by
connecting to the KMS and restoring it.
Encryption key restoration is performed collectively for the encryption key whose key information has been
lost among the backed up encryption keys (including unused keys and DEKs). However, deleted
encryption keys or unused keys that are explicitly deleted manually are not restored, such as during drive
maintenance.
To restore an encryption key, all pool volumes that belong to the parity group for which the encryption key
is configured must be blocked. Also, after restoring the encryption key, you must recover all pool volumes
that belong to the parity group for which the encryption key is set.
You can use the REST API to restore encryption keys from the management client or from the KMS.
Note: Always restore the latest encryption key. You cannot restore a secondary backup that does not
contain the most recent encryption key. If you do not have a backup of the latest encryption key and cannot
restore the encryption key, contact customer support.
Encryption keys are created automatically when the encryption environment is enabled. The encryption
keys are assigned to drives when a DDP group with encryption enabled is created.
When creating encryption keys, always create the maximum number of keys that can be created: (4,096 -
<current_number_of_keys>)
When you change the encryption key generation location from the storage system to the KMS
Use the encryption keys generated by the KMS, and delete the encryption keys that had been
generated by the storage system.
Use the encryption keys generated on the new server, and delete the encryption keys on the old
server.
You can use the REST API to delete unused (Free) encryption keys in the storage system. Encryption keys
that are not Free cannot be deleted.
Note: Encryption keys that are allocated to implemented drives cannot be deleted. If you want to delete the
encryption key allocated to an implemented drive and allocate a new encryption key, you must first disable
encryption for the DDP group to which the drive belongs.
Encryption keys need to be deleted in the storage system in the following cases:
When changing the encryption environment settings to use the KMS to generate encryption keys
instead of the storage system.
When migrating the KMS to a different server and using the newly generated encryption keys
instead of the existing encryption keys.
You can use the REST API to delete unused (Free) encryption keys in the storage system. Encryption keys
that are not Free cannot be deleted.
To maintain optimal security, you should rekey the KEK on a regular basis. In addition, you should rekey
the KEK when there is a suspected security breach or a significant change in system access or user
privileges.
Important: Back up the encryption keys and the KEK immediately after rekeying the KEK.
You can use VSP One Block Administrator to manage the following KMS settings:
Registering a KMS
Adding and deleting certificates for connecting to a KMS
Performing connection tests to a KMS
Checking and editing the KMS settings
Changing the priority of KMSs
Deleting a KMS
You can edit the following encryption environment settings after you have configured your encryption
environment:
Use of a KMS
Location of encryption key generation
Disabling the encryption environment
If you disable the encryption environment, the encryption environment settings will be initialized and
the encryption keys will be deleted, but the KMS settings will be maintained.
You can use VSP One Block Administrator or the REST API to edit the encryption environment settings.
When you intialize the encryption environment settings, all encryption keys are deleted and the encryption
environment is disabled.
You must initialize the encryption environment settings under the following circumstances:
You can use VSP One Block Administrator or the REST API to initialize the encryption environment that is
already set or to delete the KMS settings.
The encryption scripts use the standard libraries (json, sys, http.client, time, traceback) and the
Requests library, which is a third-party library.
Download the Requests library from the Requests library download page
(https://pypi.org/project/requests/).
The encryption scripts have been tested with Python 3.11.0 and Requests 2.31.0.
The encryption scripts contain the initialization and initialization code required by client programs,
such as uploading the KMS certificate and adding the KMS configuration.
The encryption configuration script files are located on the ESM of your storage system.
https://<service IP address>/download/restapi/kmip.zip
The initial configuration script is used to build an encryption environment with a KMS.
The initialization script is used to initialize the encryption settings, for example, when an error occurs when
the initial configuration script is executed.
This file defines a function to generate a request line as a BlockStorageAPI class. Place this file in the
same folder as setup_kms.py and init_kms.py.
This is a file that defines information about the storage system. Place it in the same folder as setup_kms.py
and init_kms.py.
You can use either online installation or offline installation to install the Requests library.
Online installation:
1. When installing the Requests library in a proxy environment, open the command prompt and
execute the following command:
Offline installation:
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 15/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
1. Download the latest version of requests-X.XX.XX-py3- none-any.whl from the Requests library
download page: https://pypi.org/project/requests/#files
2. Copy the downloaded installation file to a folder in the offline environment using storage media.
3. Open the command prompt, navigate to the folder of the copied installation file, and execute the
following command. The X in the command should be the same as the downloaded .whl file.
Use the following procedure to run the initial configuration script (setup_kms.py). Make sure to run the
initial configuration script before enabling encryption on any DDP groups.
1. Update the Initialize parameters in the initial configuration script file to match your storage
system environment and requirements.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 16/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
2. Update the KMS certificate parameters to match your storage system environment and
requirements.
The paths for the certificate files must be set to the same value for each client certificate and root
certificate. When registering two KMSs, separate the values with commas as shown in the following
example.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 17/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 18/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
4. For each KMS that you add, store the root certificate and client certificate in the path specified in
CLIENT_CERT_FILE_PATH and ROOT_CERT_FILE_PATH of the KMS certificate settings.
5. Open the command prompt, and move to the folder containing the script file.
6. Run the script.
python setup_kms.py
Abnormal termination: The script terminates abnormally with the following message:
An error occurred while running the script. Please check the error
message.
If the specified parameters are incorrect, the script execution is interrupted and an error
message is displayed at the command prompt where the script was executed. Check the
error message output to the command prompt, change the parameter settings accordingly,
and then run the script again.
Use the following procedure to run the initialization script (python init_kms.py). Make sure to run the
initialization script before enabling encryption on any DDP groups.
1. Update the Initialize parameters in the initialization script file to match your storage system
environment and requirements.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 19/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
2. Open the command prompt, and move to the folder containing the script file.
3. Run the script.
python init_kms.py
Abnormal termination: The script terminates abnormally with the following message:
An error occurred while running the script. Please check the error
message.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 20/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
If the specified parameters are incorrect, the script execution is interrupted and an error
message is displayed at the command prompt where the script was executed. Check the
error message output to the command prompt, change the parameter settings accordingly,
and then run the script again.
For instructions on performing encryption operations, see the user guide for the UI (for example, VSP One
Block Administrator User Guide, REST API Reference Guide).
The Security Administrator (View & Modify) role is required to perform encryption operations.
Use the following workflow to set up encryption on your storage system. For details about UI support for
these tasks, see User interface support for encryption.
When you enable encryption on the storage system, a data encryption key (DEK) is generated for
each drive in the storage system.
Use the following workflow to encrypt new data on your storage system:
All host data written to this new volume will be encrypted on the storage system.
Use the following workflow to encrypt an existing volume by migrating it to an encrypted DDP group:
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 21/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
The data in the target volume of the pair is now encrypted on the storage system.
5. Delete the volume pair.
6. Shred or otherwise eradicate the data in the source volume of the pair.
Workflow for encrypting existing data without changing the drive configuration
Use the following workflow to encrypt a volume in a DDP group for which data encryption is disabled
without changing the drive configuration:
The data in the target volume of the pair is now encrypted on the same drive configuration in the
storage system.
Use the following workflow to back up the encryption keys for your storage system:
1. Immediately after configuring the encryption environment, back up the encryption keys (DEKs) to
the management client* or to the KMS.
2. Immediately after creating encryption keys, back up the encryption keys (DEKs) to the
management client* or to the KMS.
* Keep the password used for encryption key backup on the management client in a secure location. This
password must be used for key restoration as well.
Workflow for changing the data encryption key for encrypted data
Use the following working to re-encrypt encrypted data with another encryption key:
The migrated data in the new volume is now encrypted with a different encryption key.
If you want to migrate the KMS to another server, change the settings of the primary server and the
secondary server to match the new KMS. When you change the connection destination of the KMS, the
encryption keys are backed up to the newly configured KMS.
Use the following command to set up a connection with the KMS to be used after migration:
If you want to change the KMS itself, set the KMS migration flag isMigration to true. A backup of
the KEK and encryption keys is registered on the destination KMS.
If you want to change the IP address, host name, or other settings without changing the KMS itself,
set the KMS migration flag isMigration to false. No new key encryption key or encryption key
backups are registered on the KMS.
CAUTION:
Do not turn off the storage system during the configuration process of migrating the KMS to another server.
If the storage system is turned off during this task, the key encryption key and encryption keys backed up
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 22/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
to the KMS cannot be retrieved when the power is turned on, and the data cannot be decrypted.
Note: If all volumes are blocked and SIM code 661000 or 661001 (Failed to retrieve encrypted key from
Key Management Server) is reported, perform the following actions before migrating the KMS:
When you disable a software license, you can re-enable the license. When you remove a software license,
you must contact customer support if you want to reinstall the license. For additional information about
disabling and removing software licenses, see the VSP One Block System Administrator Guide.
Use the following workflow to disable or remove the Encryption License Key software:
If encryption is enabled on any DDP group, the software license cannot be disabled or removed.
If the encryption environment settings have not been initialized, the software license cannot be
disabled or removed.
Troubleshooting
When error conditions associated with Encryption License Key occur, the following events take place:
You can use the information provided in the error messages, SIMs, and SNMP traps to troubleshoot and
resolve error conditions associated with Encryption License Key.
The following table provides general troubleshooting information for Encryption License Key. If you need
technical assistance, please contact customer support.
Problem Actions
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 23/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
Problem Actions
Check to see if timeouts are occurring, possibly due to
an increase in the number of keys in the KMS.
Check whether the time matches between the storage
system and the KMS.
Check whether SSL/TLS communication and
certificate requirements between the storage system
and the KMS are met. For details, see the System
Administrator Guide.
After checking the above, get the list of encryption keys and check
whether an encryption key has been created. For instructions, see the
REST API Reference Guide.
After checking the above, get the list of encryption keys and check
whether the encryption key has been deleted. For instructions, see
the REST API Reference Guide.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 24/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
Problem Actions
If the encryption key was not deleted, try deleting the
encryption key again.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 25/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
Problem Actions
After checking the above, see if the encryption configuration settings
have changed.
The encryption key operation If all volumes are blocked and SIM code 661000, 661001 is reported:
failed with one of the following
error codes: 1. Check the connection with the KMS and confirm that the
connection test completes successfully.
36162-00204208 2. Contact customer support and ask them to restart the storage
36162-00204209 system.
36162-00204224 3. After the storage system has restarted, make sure that all
blocked volumes are recovered.
In other cases:
Test communication succeeded, The functions required to configure a KMS are not supported by the
but error code 36162-00204225 KMS to which you are connected. Review KMS requirements and
was displayed. update the KMS software as needed.
SIM code 660100 or 660200 was The number of unused keys (encryption key with the Free attribute)
returned. might be lower than the number required for maintenance. Create the
maximum number of Free keys.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 26/27
5/12/25, 11:03 AM Encryption License Key User Guide for VSP One Block
Problem Actions
Check whether the time matches between the storage
system and the KMS.
Make sure the maximum number of keys that the KMS
can back up has not been exceeded.
Check whether SSL/TLS communication and
certificate requirements between the storage system
and the KMS are met. For details, see the System
Administrator Guide.
If the KMS settings have been updated, return to the settings before
the KMS migration (KMS migration flag isMigration=false ), and then
perform the KMS migration again.
If the KMS settings have not been updated, perform the KMS
migration again.
https://docs.hitachivantara.com/internal/api/webapp/print/ca29b23d-3ee3-48ad-a672-f708aba06b6e 27/27