root / man / gnt-job.sgml @ e7d6946c
History | View | Annotate | Download (7.5 kB)
1 |
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|---|
2 |
|
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"> |
11 |
|
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"> |
16 |
]> |
17 |
|
18 |
<refentry> |
19 |
<refentryinfo> |
20 |
<copyright> |
21 |
<year>2008</year> |
22 |
<year>2009</year> |
23 |
<holder>Google Inc.</holder> |
24 |
</copyright> |
25 |
&dhdate; |
26 |
</refentryinfo> |
27 |
<refmeta> |
28 |
&dhucpackage; |
29 |
|
30 |
&dhsection; |
31 |
<refmiscinfo>ganeti 2.0</refmiscinfo> |
32 |
</refmeta> |
33 |
<refnamediv> |
34 |
<refname>&dhpackage;</refname> |
35 |
|
36 |
<refpurpose>job commands</refpurpose> |
37 |
</refnamediv> |
38 |
<refsynopsisdiv> |
39 |
<cmdsynopsis> |
40 |
<command>&dhpackage; </command> |
41 |
|
42 |
<arg choice="req">command</arg> |
43 |
<arg>arguments...</arg> |
44 |
</cmdsynopsis> |
45 |
</refsynopsisdiv> |
46 |
<refsect1> |
47 |
<title>DESCRIPTION</title> |
48 |
|
49 |
<para> |
50 |
The <command>&dhpackage;</command> is used for examining and |
51 |
manipulating the job queue. |
52 |
</para> |
53 |
|
54 |
</refsect1> |
55 |
<refsect1> |
56 |
<title>COMMANDS</title> |
57 |
|
58 |
<refsect2> |
59 |
<title>ARCHIVE</title> |
60 |
<cmdsynopsis> |
61 |
<command>archive</command> |
62 |
|
63 |
<arg choice="req" rep="repeat">id</arg> |
64 |
</cmdsynopsis> |
65 |
|
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> |
70 |
|
71 |
</refsect2> |
72 |
|
73 |
<refsect2> |
74 |
<title>AUTOARCHIVE</title> |
75 |
<cmdsynopsis> |
76 |
<command>autoarchive</command> |
77 |
<group choice="req"> |
78 |
<arg><replaceable>age</replaceable></arg> |
79 |
<arg>all</arg> |
80 |
</group> |
81 |
</cmdsynopsis> |
82 |
|
83 |
<para> |
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 |
87 |
</literal> is passed. |
88 |
</para> |
89 |
</refsect2> |
90 |
|
91 |
<refsect2> |
92 |
<title>CANCEL</title> |
93 |
<cmdsynopsis> |
94 |
<command>cancel</command> |
95 |
<arg choice="req"><replaceable>id</replaceable></arg> |
96 |
</cmdsynopsis> |
97 |
|
98 |
<para> |
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> |
103 |
state. |
104 |
</para> |
105 |
</refsect2> |
106 |
|
107 |
<refsect2> |
108 |
<title>INFO</title> |
109 |
<cmdsynopsis> |
110 |
<command>cancel</command> |
111 |
<arg choice="req" rep="repeat"><replaceable>id</replaceable></arg> |
112 |
</cmdsynopsis> |
113 |
|
114 |
<para> |
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 |
117 |
information). |
118 |
</para> |
119 |
|
120 |
</refsect2> |
121 |
|
122 |
<refsect2> |
123 |
<title>LIST</title> |
124 |
<cmdsynopsis> |
125 |
<command>list</command> |
126 |
<arg>--no-headers</arg> |
127 |
<arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
128 |
<sbr> |
129 |
<arg>-o <replaceable>[+]FIELD,...</replaceable></arg> |
130 |
<sbr> |
131 |
</cmdsynopsis> |
132 |
|
133 |
<para> |
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. |
137 |
</para> |
138 |
|
139 |
<para> |
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. |
144 |
</para> |
145 |
|
146 |
<para> |
147 |
The <option>-o</option> option takes a comma-separated list of |
148 |
output fields. The available fields and their meaning are: |
149 |
<variablelist> |
150 |
<varlistentry> |
151 |
<term>id</term> |
152 |
<listitem> |
153 |
<simpara>the job id</simpara> |
154 |
</listitem> |
155 |
</varlistentry> |
156 |
<varlistentry> |
157 |
<term>status</term> |
158 |
<listitem> |
159 |
<simpara>the status of the job</simpara> |
160 |
</listitem> |
161 |
</varlistentry> |
162 |
<varlistentry> |
163 |
<term>received_ts</term> |
164 |
<listitem> |
165 |
<simpara>the timestamp the job was received</simpara> |
166 |
</listitem> |
167 |
</varlistentry> |
168 |
<varlistentry> |
169 |
<term>start_ts</term> |
170 |
<listitem> |
171 |
<simpara>the timestamp when the job was started</simpara> |
172 |
</listitem> |
173 |
</varlistentry> |
174 |
<varlistentry> |
175 |
<term>end_ts</term> |
176 |
<listitem> |
177 |
<simpara>the timestamp when the job was ended</simpara> |
178 |
</listitem> |
179 |
</varlistentry> |
180 |
<varlistentry> |
181 |
<term>summary</term> |
182 |
<listitem> |
183 |
<simpara>a summary of the opcodes that define the job</simpara> |
184 |
</listitem> |
185 |
</varlistentry> |
186 |
<varlistentry> |
187 |
<term>ops</term> |
188 |
<listitem> |
189 |
<simpara>the list of opcodes defining the job</simpara> |
190 |
</listitem> |
191 |
</varlistentry> |
192 |
<varlistentry> |
193 |
<term>opresult</term> |
194 |
<listitem> |
195 |
<simpara>the list of opcode results</simpara> |
196 |
</listitem> |
197 |
</varlistentry> |
198 |
<varlistentry> |
199 |
<term>opstatus</term> |
200 |
<listitem> |
201 |
<simpara>the list of opcode statuses</simpara> |
202 |
</listitem> |
203 |
</varlistentry> |
204 |
<varlistentry> |
205 |
<term>oplog</term> |
206 |
<listitem> |
207 |
<simpara>the list of opcode logs</simpara> |
208 |
</listitem> |
209 |
</varlistentry> |
210 |
<varlistentry> |
211 |
<term>opstart</term> |
212 |
<listitem> |
213 |
<simpara>the list of opcode start times</simpara> |
214 |
</listitem> |
215 |
</varlistentry> |
216 |
<varlistentry> |
217 |
<term>opend</term> |
218 |
<listitem> |
219 |
<simpara>the list of opcode end times</simpara> |
220 |
</listitem> |
221 |
</varlistentry> |
222 |
</variablelist> |
223 |
</para> |
224 |
|
225 |
<para> |
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 |
230 |
fields. |
231 |
</para> |
232 |
|
233 |
</refsect2> |
234 |
|
235 |
<refsect2> |
236 |
<title>WATCH</title> |
237 |
<cmdsynopsis> |
238 |
<command>watch</command> |
239 |
<arg>id</arg> |
240 |
</cmdsynopsis> |
241 |
|
242 |
<para> |
243 |
This command follows the output of the job by the given |
244 |
<replaceable>id</replaceable> and prints it. |
245 |
</para> |
246 |
</refsect2> |
247 |
|
248 |
</refsect1> |
249 |
|
250 |
&footer; |
251 |
|
252 |
</refentry> |
253 |
|
254 |
<!-- Keep this comment at the end of the file |
255 |
Local variables: |
256 |
mode: sgml |
257 |
sgml-omittag:t |
258 |
sgml-shorttag:t |
259 |
sgml-minimize-attributes:nil |
260 |
sgml-always-quote-attributes:t |
261 |
sgml-indent-step:2 |
262 |
sgml-indent-data:t |
263 |
sgml-parent-document:nil |
264 |
sgml-default-dtd-file:nil |
265 |
sgml-exposed-tags:nil |
266 |
sgml-local-catalogs:nil |
267 |
sgml-local-ecat-files:nil |
268 |
End: |
269 |
--> |