1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4 <!-- Please adjust the date whenever revising the manpage. -->
5 <!ENTITY dhdate "<date>February 12, 2009</date>">
6 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
7 allowed: see man(7), man(1). -->
8 <!ENTITY dhsection "<manvolnum>8</manvolnum>">
9 <!ENTITY dhucpackage "<refentrytitle>gnt-job</refentrytitle>">
10 <!ENTITY dhpackage "gnt-job">
12 <!ENTITY debian "<productname>Debian</productname>">
13 <!ENTITY gnu "<acronym>GNU</acronym>">
14 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
15 <!ENTITY footer SYSTEM "footer.sgml">
23 <holder>Google Inc.</holder>
31 <refmiscinfo>ganeti 2.0</refmiscinfo>
34 <refname>&dhpackage;</refname>
36 <refpurpose>job commands</refpurpose>
40 <command>&dhpackage; </command>
42 <arg choice="req">command</arg>
43 <arg>arguments...</arg>
47 <title>DESCRIPTION</title>
50 The <command>&dhpackage;</command> is used for examining and
51 manipulating the job queue.
56 <title>COMMANDS</title>
59 <title>ARCHIVE</title>
61 <command>archive</command>
63 <arg choice="req" rep="repeat">id</arg>
66 <para>This command can be used to archive job by their IDs. Only
67 jobs that have finished execution (i.e either
68 <emphasis>success</emphasis>, <emphasis>error</emphasis> or
69 <emphasis>canceled</emphasis> jobs).</para>
74 <title>AUTOARCHIVE</title>
76 <command>autoarchive</command>
78 <arg><replaceable>age</replaceable></arg>
84 Archive jobs by their age. This command can archive jobs older
85 than <replaceable>age</replaceable> seconds, or alternatively
86 all finished jobs can be archived if the string <literal>all
94 <command>cancel</command>
95 <arg choice="req"><replaceable>id</replaceable></arg>
99 Cancel the job identified by the given
100 <replaceable>id</replaceable>. Only jobs that have not yet
101 started to run can be canceled; that is, jobs in either the
102 <emphasis>queued</emphasis> or <emphasis>waiting</emphasis>
110 <command>cancel</command>
111 <arg choice="req" rep="repeat"><replaceable>id</replaceable></arg>
115 Show detailed information about the given job id(s). If no job
116 id is given, all jobs are examined (warning, this is a lot of
125 <command>list</command>
126 <arg>--no-headers</arg>
127 <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
129 <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
134 Lists the jobs and their status. By default, the job id, job
135 status, and a small job description is listed, but additional
136 parameters can be selected.
140 The <option>--no-headers</option> option will skip the initial
141 header line. The <option>--separator</option> option takes an
142 argument which denotes what will be used between the output
143 fields. Both these options are to help scripting.
147 The <option>-o</option> option takes a comma-separated list of
148 output fields. The available fields and their meaning are:
153 <simpara>the job id</simpara>
159 <simpara>the status of the job</simpara>
163 <term>received_ts</term>
165 <simpara>the timestamp the job was received</simpara>
169 <term>start_ts</term>
171 <simpara>the timestamp when the job was started</simpara>
177 <simpara>the timestamp when the job was ended</simpara>
183 <simpara>a summary of the opcodes that define the job</simpara>
189 <simpara>the list of opcodes defining the job</simpara>
193 <term>opresult</term>
195 <simpara>the list of opcode results</simpara>
199 <term>opstatus</term>
201 <simpara>the list of opcode statuses</simpara>
207 <simpara>the list of opcode logs</simpara>
213 <simpara>the list of opcode start times</simpara>
219 <simpara>the list of opcode end times</simpara>
226 If the value of the option starts with the character
227 <constant>+</constant>, the new fields will be added to the
228 default list. This allows to quickly see the default list plus
229 a few other fields, instead of retyping the entire list of
240 <!-- Keep this comment at the end of the file
245 sgml-minimize-attributes:nil
246 sgml-always-quote-attributes:t
249 sgml-parent-document:nil
250 sgml-default-dtd-file:nil
251 sgml-exposed-tags:nil
252 sgml-local-catalogs:nil
253 sgml-local-ecat-files:nil