ZxBackup: Operation queue and queue management

From ZeXtras Suite Wiki

Jump to: navigation, search
Language: English  • español • português
ZxBackup logo box.png
Available since version: 0.87
Latest Version: 2.12.2
Released on: January 2nd, 2019
Compatibility List
Admin Guide
FAQ
Troubleshooting
Backup Initialization
ZspBackup logo box.png

ZeXtras Backup's Operation Queue

Every time a ZeXtras Backup operation is started - either manually or through scheduling - it is enqueued in a dedicated unprioritized FIFO queue. Each operation is executed as soon as any preceding operation is dequeued (either because it has been completed or terminated).

The queue system affects the following operations:

  • External Backup
  • All restore operations
  • Smartscan

Changes to ZeXtras Backup's configuration are not enqueued and are applied immediately.

Operation Queue Management

Through the ZeXtras Administration Console

Viewing the Queue

In order to view the operation queue, access the "Notifications" tab in the ZeXtras Administration Zimlet and click the "Operation Queue" button.

Operation queue.png

Warning.png Warning!

The ZeXtras Administration Zimlet displays operations enqueued both by the ZeXtras Backup and the ZeXtras Powerstore modules in a single view. This is just a design choice, as the two queues are completely separated, meaning that one ZxBackup operation and one ZxPowerstore operation can be running at the same time.

Emptying the queue

In order to stop the current operation and empty ZeXtras Backup's operation queue, enter the "ZxBackup" tab in the ZeXtras Administration Zimlet and click the "Stop all Operations" button.

Stop all operations.png

Through the ZeXtras CLI

Viewing the Queue

In order to view ZeXtras Backup's operation queue, the `getAllOperations` command is available:

zimbra@server:~$ zxsuite help backup getAllOperations

Syntax:
   zxsuite backup getAllOperations [attr1 value1 [attr2 value2...]]


PARAMETER LIST

NAME          TYPE       EXPECTED VALUES    DEFAULT
verbose(O)    Boolean    true|false         false

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

Usage example:

zxsuite backup getAllOperations
Shows all running and queued operations

Emptying the queue

In order to stop the current operation and empty ZeXtras Backup's operation queue, the `doStopAllOperations` command is available:

zimbra@mail:~$ zxsuite help backup doStopAllOperations

Syntax:
   zxsuite backup doStopAllOperations 


Usage example:

zxsuite backup doStopAllOperations
Stops all running operations

Removing a single operation from the queue

In order to stop the current operation or to remove a specific operation from the queue, the `doStopOperation` command is available:

zimbra@mail:~$ zxsuite help backup doStopOperation

Syntax:
   zxsuite backup doStopOperation {operation_uuid} 


PARAMETER LIST

NAME                 TYPE    
operation_uuid(M)    Uiid    

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

Usage example:

zxsuite backup doStopOperation 30ed9eb9-eb28-4ca6-b65e-9940654b8601
Stops operation with id = 30ed9eb9-eb28-4ca6-b65e-9940654b8601

Personal tools