Zimbra NG Modules/Zimbra NG HSM/Volume Management

Zimbra NG HSM - Volume Management

Zimbra Volumes

A Volume is the physical representation of the notion of Store, a distinct entity (path) on a filesystem with all the associated properties.

Volume Properties

All Zimbra Volumes are defined by the following properties:

Name: a unique identifier for the volume
Path: the path where the data is going to be saved. The Zimbra user must have r/w permissions on this path.
Compression: Enable or Disable the file compression for the volume.
Compression Threshold: the minimum file size that will trigger the compression. 'Files under this size will never be compressed even if the compression is enabled.'
"Current": A "Current" volume is a volume where data will be written upon arrival (Primary Current) or HSM Policy Application (Secondary Current)

Volume Management with Zimbra NG HSM

Creating a new volume

From the Zimbra NG Modules Administration Zimlet

From the Zimbra NG HSM tab of the Zimbra NG Modules Administration Zimlet:

Click the appropriate "Add" in the "Volumes Managment" section according to the type of volume you want to create.
Enter the new volume's name.
Enter a path for the new volume.
Check the "Enable Compression" button if you wish to activate data compression on the new volume.
Select the Compression Thereshold.
Press "OK" to create the new volume. Should the operation fail, a Notification containing any related errors will be generated

From the Zimbra NG Modules CLI

To create a new volume through the Zimbra NG Modules CLI, the "doCreateVolume" command is available:

Syntax:
   zxsuite powerstore doCreateVolume {primary|secondary|index} {volume_name} {volume_path} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                              TYPE               EXPECTED VALUES            DEFAULT
volume_type(M)                    Multiple choice    primary|secondary|index    
volume_name(M)                    String                                        
volume_path(M)                    Path                                          
volume_compressed(O)              Boolean            true|false                 false
compression_threshold_bytes(O)    Long                                          4096

(M) == mandatory parameter, (O) == optional parameter

Usage example:

zxsuite powerstore docreatevolume secondary "volume B" "/opt/zimbra/store_B/" volume_compressed true compression_threshold_bytes 4096
Creates a new secondary volume named "volume B" in /opt/zimbra/store_B/, with compression and compression threshold to 4096 bytes

Editing a volume

From the Zimbra NG Modules Administration Zimlet

Simply select an existing volume and press the appropriate "Edit" button.

From the Zimbra NG Modules CLI

To edit a volume through the Zimbra NG Modules CLI, the "doUpdateVolume" command is available:

Syntax:
   zxsuite powerstore doCreateVolume {primary|secondary|index} {volume_name} {volume_path} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                              TYPE               EXPECTED VALUES            DEFAULT
volume_type(M)                    Multiple choice    primary|secondary|index    
volume_name(M)                    String                                        
volume_path(M)                    Path                                          
volume_compressed(O)              Boolean            true|false                 false
compression_threshold_bytes(O)    Long                                          4096

(M) == mandatory parameter, (O) == optional parameter

Usage example:

zxsuite powerstore docreatevolume secondary "volume B" "/opt/zimbra/store_B/" volume_compressed true compression_threshold_bytes 4096
Creates a new secondary volume named "volume B" in /opt/zimbra/store_B/, with compression and compression threshold to 4096 bytes
zimbra@test:~$ zxsuite powerstore doUpdateVolume

command doUpdateVolume requires more parameters

Syntax:
   zxsuite powerstore doUpdateVolume {volume_id} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                        TYPE       EXPECTED VALUES    DEFAULT
volume_id(M)                Integer                       
volume_type(O)              String                        inherited_value
volume_name(O)              String                        inherited_value
volume_path(O)              Path                          inherited_value
current_volume(O)           Boolean    true|false         false
volume_compressed(O)        Boolean    true|false         false
compression_threshold(O)    Long                          4096

(M) == mandatory parameter, (O) == optional parameter

Usage example:

zxsuite powerstore doupdatevolume 3 secondary "example volume" "/opt/zimbra/store_example/"
Sets name of volume 3 to "example volume", make it secondary, and set its path to /opt/zimbra/store_example/

Deleting a volume

From the Zimbra NG Modules Administration Zimlet

Select and existing volume and press the appropriate "Delete" button. Remember that only empty volumes can be deleted.

From the Zimbra NG Modules CLI

To delete a volume through the Zimbra NG Modules CLI, the "doDeleteVolume" command is available:

Syntax:
   zxsuite powerstore doUpdateVolume {volume_id} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                        TYPE       EXPECTED VALUES    DEFAULT
volume_id(M)                Integer                       
volume_type(O)              String                        inherited_value
volume_name(O)              String                        inherited_value
volume_path(O)              Path                          inherited_value
current_volume(O)           Boolean    true|false         false
volume_compressed(O)        Boolean    true|false         false
compression_threshold(O)    Long                          4096

(M) == mandatory parameter, (O) == optional parameter

Usage example:

zxsuite powerstore doupdatevolume 3 secondary "example volume" "/opt/zimbra/store_example/"
Sets name of volume 3 to "example volume", make it secondary, and set its path to /opt/zimbra/store_example/
zimbra@simone:~$ zxsuite powerstore doDeleteVolume

command doDeleteVolume requires more parameters

Syntax:
   zxsuite powerstore doDeleteVolume {volume_id} 

PARAMETER LIST

NAME            TYPE       
volume_id(M)    Integer    

(M) == mandatory parameter, (O) == optional parameter

Usage example:

zxsuite powerstore dodeletevolume 3
Deletes volume with id 3

Aug 25, 2016 - Know more »