Modifying Software Encryption Properties of a Storage Policy Copy or a Storage Pool Using the Command Line Interface

To change software encryption properties on a storage policy copy or a storage pool through the command line, you can use the modify_encryption_properties.xml configuration file that contains parameters that define encryption.

Note

You can use the Client Encryption Information app to edit the encryption settings for one or more client computers, storage policies and storage pools.

Procedure

To log on to the CommServe, run the qlogin command.
Download the modify_encryption_properties.xml file, and then save it on the computer from where the command will be run.
Choose one of the following methods to modify the encryption properties:
- Using the XML configuration file to specify command line arguments:
  1. In a text or XML editor, open the modify_encryption_properties.xml file, and then change the parameter values in the XML.
    
    For more information on parameters, see Elements for Software Data Encryption Properties.
  2. Run the following command from the software_installation_directory\Base directory:
```
 
qoperation execute -af <download location>\modify_encryption_properties.xml
```
- Using the XML configuration file to pass input parameters in the command line:
  1. To modify the encryption properties for a storage policy copy, run the following command from the software_installation_directory\Base directory:
```
 
qoperation execute -af <download location>\modify_encryption_properties.xml -copyName <storage_policy_copy_name> -storagePolicyName <storage_policy_name> -encryptData <1|0> -encryptionType [Cipher_Name] -encryptionKeyLength [Key_Length] -preserveEncryptionModeAsInSource [1|0] -auxCopyReencryptData [1|0] -storePlainText [1|0] -encryptOnNetworkUsingSelectedCipher [1|0] -storeKeyOnMedia [1|0]
```
  2. To enable encryption or modify the encryption properties for a storage pool, run the following command from the software_installation_directory\Base directory:
```
qoperation execute -af <download location>\modify_encryption_properties.xml -copyName <storage_poolicy_copy_name> -storagePolicyName <storage_pool_name> -encryptData <1|0> -encryptionType [Cipher_Name] -encryptionKeyLength [Key_Length] -encryptOnDependentPrimary <1|0> -storeKeyOnMedia [1|0]
```
  For more information on parameters, see Elements for Software Data Encryption Properties.

Example

To update encryption type to GOST, key length as 256, and to encrypt backup data during transmission and store as plain text on the secondary storage run the following command:

Using the XML configuration file as command line argument:

In the XML configuration file, modify the following elements:
- copyName
- storagePolicyName
- encryptData
- encryptionType
- encryptionKeyLength
```
 
qoperation execute -af download location>\modify_encryption_properties.xml
```

Using the XML configuration file to pass input parameters:

qoperation execute -af <download location>\modify_encryption_properties.xml -copyName copy01 -storagePolicyName SP01 -encryptData 1 -encryptionType GOST -encryptionKeyLength 256 -encryptOnNetworkUsingSelectedCipher 1 -storeKeyOnMedia 1