ZxPowerstore: Volume Management

Warning! This wiki is outdated and not maintained anymore, please refer to the new Zextras Documentation Hub at https://docs.zextras.com

This documentation is outdated.

Please refer to https://docs.zextras.com

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 ZxPowerstore

Creating a new volume

From the ZeXtras Administration Zimlet

From the ZxPowerstore tab of the ZeXtras Administration Zimler:

• Click the appropriate "Add" in the "Volumes Managment" section according to the type of volume you want to create.

• Select the store type, choosing between local mountpoint or S3 Bucket

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

• In case of S3 Bucket, it's possible to store multiple Bucket information

• Press "OK" to create the new volume. Should the operation fail, a Notification containing any related errors will be generated

From the ZeXtras CLI

To create a new volume through the ZeXtras 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 ZeXtras Administration Zimlet

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

From the ZeXtras CLI

To edit a volume through the ZeXtras CLI, the "doUpdateVolume" command is available:

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 ZeXtras Administration Zimlet

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

Desde a CLI

Para deletar um volume desde a linha de comandos está disponível o comando "doDeleteVolume":

zimbra@test:~$ zxsuite powerstore doDeleteVolume

command doDeleteVolume requires more parameters

Syntax:
   zxsuite powerstore doDeleteVolume {volume_name}

PARAMETER LIST

NAME              TYPE
volume_name(M)    String

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

Usage example:

zxsuite powerstore dodeletevolume hsm
Deletes volume with name hsm