<?xml version="1.0" encoding="UTF-8"?>
<!--
! CCPL HEADER START
!
! This work is licensed under the Creative Commons
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
! To view a copy of this license, visit
! or send a letter to Creative Commons, 444 Castro Street,
! Suite 900, Mountain View, California, 94041, USA.
!
! You can also obtain a copy of the license at
! See the License for the specific language governing permissions
! and limitations under the License.
!
! If applicable, add the following below this CCPL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CCPL HEADER END
!
! Copyright 2011-2012 ForgeRock AS
! Portions Copyright 2013 Jens Elkner
!
-->
version="5.0" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refmeta>
<refentrytitle><application>manage-tasks</application></refentrytitle>
</refmeta>
<refnamediv>
<refname><application>manage-tasks</application></refname>
<refpurpose>manage OpenDJ server administration tasks</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>manage-tasks</command>
<arg>-c <replaceable class="parameter">taskId</replaceable></arg>
<arg>-i <replaceable class="parameter">taskId</replaceable></arg>
<arg>-s</arg>
<arg>-n</arg>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-remote"]/*)'/>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-auth"]/*)'/>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-props"]/*)'/>
xpointer='xpointer(//para[@name="s-general"]/*)'/>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
This utility can be used to obtain a list of tasks scheduled to run within the
directory server as well as information about individual tasks.
</para>
</refsection>
<refsection>
<title>Options</title>
<para>
The following options are supported.</para>
<variablelist>
<varlistentry>
<term><option>-c, --cancel</option> <replaceable
class="parameter">taskId</replaceable></term>
<listitem>
<para>
ID of a particular task to cancel.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-i, --info</option> <replaceable
class="parameter">taskId</replaceable></term>
<listitem>
<para>
ID of a particular task about which this tool will display information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s, --summary</option></term>
<listitem>
<para>
Print a summary of tasks.</para>
</listitem>
</varlistentry>
</variablelist>
<refsection>
<title>LDAP Connection Options</title>
<variablelist>
xpointer='xpointer(//para[@name="l-remote"]/*)'/>
xpointer='xpointer(//para[@name="l-auth"]/*)'/>
</variablelist>
</refsection>
<refsection>
<variablelist>
<varlistentry>
<term><option>-n, --no-prompt</option></term>
<listitem>
<para>
Use non-interactive mode. If data in the command is missing, the user is not
prompted and the tool will fail.
</para>
</listitem>
</varlistentry>
xpointer='xpointer(//para[@name="l-props"]/*)'/>
</variablelist>
</refsection>
<refsection>
<title>General Options</title>
<variablelist>
xpointer='xpointer(//para[@name="l-general"]/*)'/>
</variablelist>
</refsection>
</refsection>
<refsection>
<title>Examples</title>
<informalexample>
<para>
The following example demonstrates use of the command with a server that does
daily backups at 2:00 AM.
</para>
<literallayout><prompt
-D "cn=Directory Manager"</command></literallayout>
<screen>
ID Type Status
---------------------------------------------------------------
example-backup Backup Recurring
example-backup-20110622020000000 Backup Waiting on start time
</screen>
</informalexample>
</refsection>
</refentry>