root / man / gnt-job.sgml @ f4ad2ef0
History | View | Annotate | Download (7.7 kB)
1 | d3b4cf9f | Iustin Pop | <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|---|---|---|
2 | d3b4cf9f | Iustin Pop | |
3 | d3b4cf9f | Iustin Pop | <!-- Fill in your name for FIRSTNAME and SURNAME. --> |
4 | d3b4cf9f | Iustin Pop | <!-- Please adjust the date whenever revising the manpage. --> |
5 | d3b4cf9f | Iustin Pop | <!ENTITY dhdate "<date>February 12, 2009</date>"> |
6 | d3b4cf9f | Iustin Pop | <!-- SECTION should be 1-8, maybe w/ subsection other parameters are |
7 | d3b4cf9f | Iustin Pop | allowed: see man(7), man(1). --> |
8 | d3b4cf9f | Iustin Pop | <!ENTITY dhsection "<manvolnum>8</manvolnum>"> |
9 | d3b4cf9f | Iustin Pop | <!ENTITY dhucpackage "<refentrytitle>gnt-job</refentrytitle>"> |
10 | d3b4cf9f | Iustin Pop | <!ENTITY dhpackage "gnt-job"> |
11 | d3b4cf9f | Iustin Pop | |
12 | d3b4cf9f | Iustin Pop | <!ENTITY debian "<productname>Debian</productname>"> |
13 | d3b4cf9f | Iustin Pop | <!ENTITY gnu "<acronym>GNU</acronym>"> |
14 | d3b4cf9f | Iustin Pop | <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> |
15 | d3b4cf9f | Iustin Pop | <!ENTITY footer SYSTEM "footer.sgml"> |
16 | d3b4cf9f | Iustin Pop | ]> |
17 | d3b4cf9f | Iustin Pop | |
18 | d3b4cf9f | Iustin Pop | <refentry> |
19 | d3b4cf9f | Iustin Pop | <refentryinfo> |
20 | d3b4cf9f | Iustin Pop | <copyright> |
21 | d3b4cf9f | Iustin Pop | <year>2008</year> |
22 | d3b4cf9f | Iustin Pop | <year>2009</year> |
23 | d3b4cf9f | Iustin Pop | <holder>Google Inc.</holder> |
24 | d3b4cf9f | Iustin Pop | </copyright> |
25 | d3b4cf9f | Iustin Pop | &dhdate; |
26 | d3b4cf9f | Iustin Pop | </refentryinfo> |
27 | d3b4cf9f | Iustin Pop | <refmeta> |
28 | d3b4cf9f | Iustin Pop | &dhucpackage; |
29 | d3b4cf9f | Iustin Pop | |
30 | d3b4cf9f | Iustin Pop | &dhsection; |
31 | d3b4cf9f | Iustin Pop | <refmiscinfo>ganeti 2.0</refmiscinfo> |
32 | d3b4cf9f | Iustin Pop | </refmeta> |
33 | d3b4cf9f | Iustin Pop | <refnamediv> |
34 | d3b4cf9f | Iustin Pop | <refname>&dhpackage;</refname> |
35 | d3b4cf9f | Iustin Pop | |
36 | d3b4cf9f | Iustin Pop | <refpurpose>job commands</refpurpose> |
37 | d3b4cf9f | Iustin Pop | </refnamediv> |
38 | d3b4cf9f | Iustin Pop | <refsynopsisdiv> |
39 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
40 | d3b4cf9f | Iustin Pop | <command>&dhpackage; </command> |
41 | d3b4cf9f | Iustin Pop | |
42 | d3b4cf9f | Iustin Pop | <arg choice="req">command</arg> |
43 | d3b4cf9f | Iustin Pop | <arg>arguments...</arg> |
44 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
45 | d3b4cf9f | Iustin Pop | </refsynopsisdiv> |
46 | d3b4cf9f | Iustin Pop | <refsect1> |
47 | d3b4cf9f | Iustin Pop | <title>DESCRIPTION</title> |
48 | d3b4cf9f | Iustin Pop | |
49 | d3b4cf9f | Iustin Pop | <para> |
50 | d3b4cf9f | Iustin Pop | The <command>&dhpackage;</command> is used for examining and |
51 | d3b4cf9f | Iustin Pop | manipulating the job queue. |
52 | d3b4cf9f | Iustin Pop | </para> |
53 | d3b4cf9f | Iustin Pop | |
54 | d3b4cf9f | Iustin Pop | </refsect1> |
55 | d3b4cf9f | Iustin Pop | <refsect1> |
56 | d3b4cf9f | Iustin Pop | <title>COMMANDS</title> |
57 | d3b4cf9f | Iustin Pop | |
58 | d3b4cf9f | Iustin Pop | <refsect2> |
59 | d3b4cf9f | Iustin Pop | <title>ARCHIVE</title> |
60 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
61 | d3b4cf9f | Iustin Pop | <command>archive</command> |
62 | d3b4cf9f | Iustin Pop | |
63 | d3b4cf9f | Iustin Pop | <arg choice="req" rep="repeat">id</arg> |
64 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
65 | d3b4cf9f | Iustin Pop | |
66 | d3b4cf9f | Iustin Pop | <para>This command can be used to archive job by their IDs. Only |
67 | d3b4cf9f | Iustin Pop | jobs that have finished execution (i.e either |
68 | d3b4cf9f | Iustin Pop | <emphasis>success</emphasis>, <emphasis>error</emphasis> or |
69 | d3b4cf9f | Iustin Pop | <emphasis>canceled</emphasis> jobs).</para> |
70 | d3b4cf9f | Iustin Pop | |
71 | d3b4cf9f | Iustin Pop | </refsect2> |
72 | d3b4cf9f | Iustin Pop | |
73 | d3b4cf9f | Iustin Pop | <refsect2> |
74 | d3b4cf9f | Iustin Pop | <title>AUTOARCHIVE</title> |
75 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
76 | d3b4cf9f | Iustin Pop | <command>autoarchive</command> |
77 | d3b4cf9f | Iustin Pop | <group choice="req"> |
78 | d3b4cf9f | Iustin Pop | <arg><replaceable>age</replaceable></arg> |
79 | d3b4cf9f | Iustin Pop | <arg>all</arg> |
80 | d3b4cf9f | Iustin Pop | </group> |
81 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
82 | d3b4cf9f | Iustin Pop | |
83 | d3b4cf9f | Iustin Pop | <para> |
84 | d3b4cf9f | Iustin Pop | Archive jobs by their age. This command can archive jobs older |
85 | d3b4cf9f | Iustin Pop | than <replaceable>age</replaceable> seconds, or alternatively |
86 | d3b4cf9f | Iustin Pop | all finished jobs can be archived if the string <literal>all |
87 | d3b4cf9f | Iustin Pop | </literal> is passed. |
88 | d3b4cf9f | Iustin Pop | </para> |
89 | d3b4cf9f | Iustin Pop | </refsect2> |
90 | d3b4cf9f | Iustin Pop | |
91 | d3b4cf9f | Iustin Pop | <refsect2> |
92 | d3b4cf9f | Iustin Pop | <title>CANCEL</title> |
93 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
94 | d3b4cf9f | Iustin Pop | <command>cancel</command> |
95 | d3b4cf9f | Iustin Pop | <arg choice="req"><replaceable>id</replaceable></arg> |
96 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
97 | d3b4cf9f | Iustin Pop | |
98 | d3b4cf9f | Iustin Pop | <para> |
99 | d3b4cf9f | Iustin Pop | Cancel the job identified by the given |
100 | d3b4cf9f | Iustin Pop | <replaceable>id</replaceable>. Only jobs that have not yet |
101 | d3b4cf9f | Iustin Pop | started to run can be canceled; that is, jobs in either the |
102 | d3b4cf9f | Iustin Pop | <emphasis>queued</emphasis> or <emphasis>waiting</emphasis> |
103 | d3b4cf9f | Iustin Pop | state. |
104 | d3b4cf9f | Iustin Pop | </para> |
105 | d3b4cf9f | Iustin Pop | </refsect2> |
106 | d3b4cf9f | Iustin Pop | |
107 | d3b4cf9f | Iustin Pop | <refsect2> |
108 | d3b4cf9f | Iustin Pop | <title>INFO</title> |
109 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
110 | 4b339d4c | Michael Hanselmann | <command>info</command> |
111 | d3b4cf9f | Iustin Pop | <arg choice="req" rep="repeat"><replaceable>id</replaceable></arg> |
112 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
113 | d3b4cf9f | Iustin Pop | |
114 | d3b4cf9f | Iustin Pop | <para> |
115 | d3b4cf9f | Iustin Pop | Show detailed information about the given job id(s). If no job |
116 | d3b4cf9f | Iustin Pop | id is given, all jobs are examined (warning, this is a lot of |
117 | d3b4cf9f | Iustin Pop | information). |
118 | d3b4cf9f | Iustin Pop | </para> |
119 | d3b4cf9f | Iustin Pop | |
120 | d3b4cf9f | Iustin Pop | </refsect2> |
121 | d3b4cf9f | Iustin Pop | |
122 | d3b4cf9f | Iustin Pop | <refsect2> |
123 | d3b4cf9f | Iustin Pop | <title>LIST</title> |
124 | d3b4cf9f | Iustin Pop | <cmdsynopsis> |
125 | d3b4cf9f | Iustin Pop | <command>list</command> |
126 | d3b4cf9f | Iustin Pop | <arg>--no-headers</arg> |
127 | d3b4cf9f | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
128 | d3b4cf9f | Iustin Pop | <sbr> |
129 | d3b4cf9f | Iustin Pop | <arg>-o <replaceable>[+]FIELD,...</replaceable></arg> |
130 | d3b4cf9f | Iustin Pop | <sbr> |
131 | d3b4cf9f | Iustin Pop | </cmdsynopsis> |
132 | d3b4cf9f | Iustin Pop | |
133 | d3b4cf9f | Iustin Pop | <para> |
134 | d3b4cf9f | Iustin Pop | Lists the jobs and their status. By default, the job id, job |
135 | d3b4cf9f | Iustin Pop | status, and a small job description is listed, but additional |
136 | d3b4cf9f | Iustin Pop | parameters can be selected. |
137 | d3b4cf9f | Iustin Pop | </para> |
138 | d3b4cf9f | Iustin Pop | |
139 | d3b4cf9f | Iustin Pop | <para> |
140 | d3b4cf9f | Iustin Pop | The <option>--no-headers</option> option will skip the initial |
141 | d3b4cf9f | Iustin Pop | header line. The <option>--separator</option> option takes an |
142 | d3b4cf9f | Iustin Pop | argument which denotes what will be used between the output |
143 | d3b4cf9f | Iustin Pop | fields. Both these options are to help scripting. |
144 | d3b4cf9f | Iustin Pop | </para> |
145 | d3b4cf9f | Iustin Pop | |
146 | d3b4cf9f | Iustin Pop | <para> |
147 | d3b4cf9f | Iustin Pop | The <option>-o</option> option takes a comma-separated list of |
148 | d3b4cf9f | Iustin Pop | output fields. The available fields and their meaning are: |
149 | d3b4cf9f | Iustin Pop | <variablelist> |
150 | d3b4cf9f | Iustin Pop | <varlistentry> |
151 | d3b4cf9f | Iustin Pop | <term>id</term> |
152 | d3b4cf9f | Iustin Pop | <listitem> |
153 | d3b4cf9f | Iustin Pop | <simpara>the job id</simpara> |
154 | d3b4cf9f | Iustin Pop | </listitem> |
155 | d3b4cf9f | Iustin Pop | </varlistentry> |
156 | d3b4cf9f | Iustin Pop | <varlistentry> |
157 | d3b4cf9f | Iustin Pop | <term>status</term> |
158 | d3b4cf9f | Iustin Pop | <listitem> |
159 | d3b4cf9f | Iustin Pop | <simpara>the status of the job</simpara> |
160 | d3b4cf9f | Iustin Pop | </listitem> |
161 | d3b4cf9f | Iustin Pop | </varlistentry> |
162 | d3b4cf9f | Iustin Pop | <varlistentry> |
163 | d3b4cf9f | Iustin Pop | <term>received_ts</term> |
164 | d3b4cf9f | Iustin Pop | <listitem> |
165 | d3b4cf9f | Iustin Pop | <simpara>the timestamp the job was received</simpara> |
166 | d3b4cf9f | Iustin Pop | </listitem> |
167 | d3b4cf9f | Iustin Pop | </varlistentry> |
168 | d3b4cf9f | Iustin Pop | <varlistentry> |
169 | d3b4cf9f | Iustin Pop | <term>start_ts</term> |
170 | d3b4cf9f | Iustin Pop | <listitem> |
171 | d3b4cf9f | Iustin Pop | <simpara>the timestamp when the job was started</simpara> |
172 | d3b4cf9f | Iustin Pop | </listitem> |
173 | d3b4cf9f | Iustin Pop | </varlistentry> |
174 | d3b4cf9f | Iustin Pop | <varlistentry> |
175 | d3b4cf9f | Iustin Pop | <term>end_ts</term> |
176 | d3b4cf9f | Iustin Pop | <listitem> |
177 | d3b4cf9f | Iustin Pop | <simpara>the timestamp when the job was ended</simpara> |
178 | d3b4cf9f | Iustin Pop | </listitem> |
179 | d3b4cf9f | Iustin Pop | </varlistentry> |
180 | d3b4cf9f | Iustin Pop | <varlistentry> |
181 | d3b4cf9f | Iustin Pop | <term>summary</term> |
182 | d3b4cf9f | Iustin Pop | <listitem> |
183 | d3b4cf9f | Iustin Pop | <simpara>a summary of the opcodes that define the job</simpara> |
184 | d3b4cf9f | Iustin Pop | </listitem> |
185 | d3b4cf9f | Iustin Pop | </varlistentry> |
186 | d3b4cf9f | Iustin Pop | <varlistentry> |
187 | d3b4cf9f | Iustin Pop | <term>ops</term> |
188 | d3b4cf9f | Iustin Pop | <listitem> |
189 | d3b4cf9f | Iustin Pop | <simpara>the list of opcodes defining the job</simpara> |
190 | d3b4cf9f | Iustin Pop | </listitem> |
191 | d3b4cf9f | Iustin Pop | </varlistentry> |
192 | d3b4cf9f | Iustin Pop | <varlistentry> |
193 | d3b4cf9f | Iustin Pop | <term>opresult</term> |
194 | d3b4cf9f | Iustin Pop | <listitem> |
195 | d3b4cf9f | Iustin Pop | <simpara>the list of opcode results</simpara> |
196 | d3b4cf9f | Iustin Pop | </listitem> |
197 | d3b4cf9f | Iustin Pop | </varlistentry> |
198 | d3b4cf9f | Iustin Pop | <varlistentry> |
199 | d3b4cf9f | Iustin Pop | <term>opstatus</term> |
200 | d3b4cf9f | Iustin Pop | <listitem> |
201 | d3b4cf9f | Iustin Pop | <simpara>the list of opcode statuses</simpara> |
202 | d3b4cf9f | Iustin Pop | </listitem> |
203 | d3b4cf9f | Iustin Pop | </varlistentry> |
204 | d3b4cf9f | Iustin Pop | <varlistentry> |
205 | d3b4cf9f | Iustin Pop | <term>oplog</term> |
206 | d3b4cf9f | Iustin Pop | <listitem> |
207 | d3b4cf9f | Iustin Pop | <simpara>the list of opcode logs</simpara> |
208 | d3b4cf9f | Iustin Pop | </listitem> |
209 | d3b4cf9f | Iustin Pop | </varlistentry> |
210 | d3b4cf9f | Iustin Pop | <varlistentry> |
211 | d3b4cf9f | Iustin Pop | <term>opstart</term> |
212 | d3b4cf9f | Iustin Pop | <listitem> |
213 | d3b4cf9f | Iustin Pop | <simpara>the list of opcode start times</simpara> |
214 | d3b4cf9f | Iustin Pop | </listitem> |
215 | d3b4cf9f | Iustin Pop | </varlistentry> |
216 | d3b4cf9f | Iustin Pop | <varlistentry> |
217 | d3b4cf9f | Iustin Pop | <term>opend</term> |
218 | d3b4cf9f | Iustin Pop | <listitem> |
219 | d3b4cf9f | Iustin Pop | <simpara>the list of opcode end times</simpara> |
220 | d3b4cf9f | Iustin Pop | </listitem> |
221 | d3b4cf9f | Iustin Pop | </varlistentry> |
222 | 1d2dcdfd | Michael Hanselmann | <varlistentry> |
223 | 1d2dcdfd | Michael Hanselmann | <term>lock_status</term> |
224 | 1d2dcdfd | Michael Hanselmann | <listitem> |
225 | 5db6a71c | Michael Hanselmann | <simpara>the lock status (useful for debugging)</simpara> |
226 | 1d2dcdfd | Michael Hanselmann | </listitem> |
227 | 1d2dcdfd | Michael Hanselmann | </varlistentry> |
228 | d3b4cf9f | Iustin Pop | </variablelist> |
229 | d3b4cf9f | Iustin Pop | </para> |
230 | d3b4cf9f | Iustin Pop | |
231 | d3b4cf9f | Iustin Pop | <para> |
232 | d3b4cf9f | Iustin Pop | If the value of the option starts with the character |
233 | d3b4cf9f | Iustin Pop | <constant>+</constant>, the new fields will be added to the |
234 | d3b4cf9f | Iustin Pop | default list. This allows to quickly see the default list plus |
235 | d3b4cf9f | Iustin Pop | a few other fields, instead of retyping the entire list of |
236 | d3b4cf9f | Iustin Pop | fields. |
237 | d3b4cf9f | Iustin Pop | </para> |
238 | d3b4cf9f | Iustin Pop | |
239 | d3b4cf9f | Iustin Pop | </refsect2> |
240 | e7d6946c | Michael Hanselmann | |
241 | e7d6946c | Michael Hanselmann | <refsect2> |
242 | e7d6946c | Michael Hanselmann | <title>WATCH</title> |
243 | e7d6946c | Michael Hanselmann | <cmdsynopsis> |
244 | e7d6946c | Michael Hanselmann | <command>watch</command> |
245 | e7d6946c | Michael Hanselmann | <arg>id</arg> |
246 | e7d6946c | Michael Hanselmann | </cmdsynopsis> |
247 | e7d6946c | Michael Hanselmann | |
248 | e7d6946c | Michael Hanselmann | <para> |
249 | e7d6946c | Michael Hanselmann | This command follows the output of the job by the given |
250 | e7d6946c | Michael Hanselmann | <replaceable>id</replaceable> and prints it. |
251 | e7d6946c | Michael Hanselmann | </para> |
252 | e7d6946c | Michael Hanselmann | </refsect2> |
253 | e7d6946c | Michael Hanselmann | |
254 | d3b4cf9f | Iustin Pop | </refsect1> |
255 | d3b4cf9f | Iustin Pop | |
256 | d3b4cf9f | Iustin Pop | &footer; |
257 | d3b4cf9f | Iustin Pop | |
258 | d3b4cf9f | Iustin Pop | </refentry> |
259 | d3b4cf9f | Iustin Pop | |
260 | d3b4cf9f | Iustin Pop | <!-- Keep this comment at the end of the file |
261 | d3b4cf9f | Iustin Pop | Local variables: |
262 | d3b4cf9f | Iustin Pop | mode: sgml |
263 | d3b4cf9f | Iustin Pop | sgml-omittag:t |
264 | d3b4cf9f | Iustin Pop | sgml-shorttag:t |
265 | d3b4cf9f | Iustin Pop | sgml-minimize-attributes:nil |
266 | d3b4cf9f | Iustin Pop | sgml-always-quote-attributes:t |
267 | d3b4cf9f | Iustin Pop | sgml-indent-step:2 |
268 | d3b4cf9f | Iustin Pop | sgml-indent-data:t |
269 | d3b4cf9f | Iustin Pop | sgml-parent-document:nil |
270 | d3b4cf9f | Iustin Pop | sgml-default-dtd-file:nil |
271 | d3b4cf9f | Iustin Pop | sgml-exposed-tags:nil |
272 | d3b4cf9f | Iustin Pop | sgml-local-catalogs:nil |
273 | d3b4cf9f | Iustin Pop | sgml-local-ecat-files:nil |
274 | d3b4cf9f | Iustin Pop | End: |
275 | d3b4cf9f | Iustin Pop | --> |