Difference between revisions of "Zimbra Next Generation Modules/Zimbra NG Backup/Operation queue and queue management"

m (1 revision imported: Zimbra NG)
 
Line 1: Line 1:
<div class="col-md-12"><br></div>
+
#REDIRECT [[Zimbra_NG_Modules/Zimbra_NG_Backup/Operation_queue_and_queue_management]]
<div class="col-md-12"><br></div>
 
<ol class="breadcrumb">
 
  <li>[[Main Page|Zimbra Wiki]]</li>
 
  <li>[[Zimbra_Next_Generation_Modules]]</li>
 
  <li>[[Zimbra_NG_Backup]]</li>
 
  <li class="active"> Operation queue and queue management</li>
 
</ol>
 
__NOTOC__
 
<div class="col-md-12"><br /></div>
 
<div class="col-md-9">
 
    <h2 class="title-header" style="padding-bottom: 9px; border-bottom: 4px solid #0087c3;">Zimbra NG Backup - Operation queue and queue management</h2>
 
    <div class="col-md-12">
 
        <div class="ibox-content">
 
            <div class="post animated fadeInLeft animation-delay-8" style="padding-top:5px">
 
                <div class="panel panel-default">
 
                    <div class="panel-body">
 
                        <h5 class="post-title">Zimbra NG Backup - Operation queue and queue management</h5>
 
                        <div class="row">
 
Every time a Zimbra NG 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 Zimbra NG Backup's configuration are not enqueued and are applied immediately.
 
 
 
== Operation Queue Management ==
 
=== Through the Zimbra Next Generation Modules Administration Console ===
 
==== Viewing the Queue ====
 
In order to view the operation queue, access the "Notifications" tab in the Zimbra Next Generation Modules Administration Zimlet and click the "Operation Queue" button.
 
 
 
<div class="col-md-8">
 
    <div class="alert alert-warning fade in"> <p> <i class="fa  fa-warning"></i> <strong>warning</strong> </p>
 
    <p class="text-justify">The Zimbra Next Generation Modules Administration Zimlet displays operations enqueued both by the Zimbra NG Backup and the Zimbra NG HSM modules in a single view. This is just a design choice, as the two queues are completely separated, meaning that one Zimbra NG Backup operation and one Zimbra NG HSM operation can be running at the same time.</p>
 
    </div>
 
</div>
 
<div class="clearfix"></div>
 
 
 
==== Emptying the queue ====
 
In order to stop the current operation and empty Zimbra NG Backup's operation queue, enter the "Zimbra NG Backup" tab in the Zimbra Next Generation Modules Administration Zimlet and click the "Stop all Operations" button.
 
 
 
=== Through the Zimbra Next Generation Modules CLI ===
 
==== Viewing the Queue ====
 
In order to view Zimbra NG Backup's operation queue, the `getAllOperations` command is available:
 
 
 
<pre>
 
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
 
</pre>
 
 
 
==== Emptying the queue ====
 
In order to stop the current operation and empty Zimbra NG Backup's operation queue, the `doStopAllOperations` command is available:
 
<pre>
 
zimbra@mail:~$ zxsuite help backup doStopAllOperations
 
 
 
Syntax:
 
  zxsuite backup doStopAllOperations
 
 
 
 
 
Usage example:
 
 
 
zxsuite backup doStopAllOperations
 
Stops all running operations
 
</pre>
 
 
 
==== 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:
 
<pre>
 
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
 
 
 
</pre>
 
                        </div>
 
                    </div>
 
                    <div class="col-md-9">
 
                        <div class="panel-footer">
 
                            <p><i class="fa fa-clock-o"></i> Aug 25, 2016 - [https://www.zimbra.com/email-server-software/ Know more »]</p>
 
                        </div>
 
                    </div>
 
                </div>
 
            </div>
 
        </div>
 
    </div>
 
</div>
 
<div class="col-md-3"><br /></div>
 
<div class="col-md-3">
 
    <div class="panel panel-zimbrared-light-border">
 
        <div class="panel-heading">
 
            <h3 class="panel-title"><i class="fa fa-gear pull-left"></i> Zimbra Next Generation Modules</h3>
 
        </div>
 
        <div class="panel-body">
 
            {{ZNG}}
 
        </div>
 
    </div>
 
</div>
 
<div class="col-md-3">
 
    <div class="panel panel-primary-light-border">
 
        <div class="panel-heading">
 
            <h3 class="panel-title"><i class="fa fa-info-circle pull-left"></i> Zimbra Next Generation Modules Resources</h3>
 
        </div>
 
        <div class="panel-body">
 
            {{ZNGL}}
 
        </div>
 
    </div>
 
</div>
 
<div class="clearfix"></div>
 
<div class="col-md-12"><br></div>
 
{{FH}}
 

Latest revision as of 12:53, 29 November 2017

Jump to: navigation, search