root / man / gnt-job.rst @ 43d51ef2
History | View | Annotate | Download (2.7 kB)
1 |
gnt-job(8) Ganeti | Version @GANETI_VERSION@ |
---|---|
2 |
============================================ |
3 |
|
4 |
Name |
5 |
---- |
6 |
|
7 |
gnt-job - Job commands |
8 |
|
9 |
Synopsis |
10 |
-------- |
11 |
|
12 |
**gnt-job** {command} [arguments...] |
13 |
|
14 |
DESCRIPTION |
15 |
----------- |
16 |
|
17 |
The **gnt-job** is used for examining and manipulating the job |
18 |
queue. |
19 |
|
20 |
COMMANDS |
21 |
-------- |
22 |
|
23 |
ARCHIVE |
24 |
~~~~~~~ |
25 |
|
26 |
**archive** {id...} |
27 |
|
28 |
This command can be used to archive job by their IDs. Only jobs |
29 |
that have finished execution (i.e either *success*, *error* or |
30 |
*canceled* jobs). |
31 |
|
32 |
AUTOARCHIVE |
33 |
~~~~~~~~~~~ |
34 |
|
35 |
**autoarchive** {*age* | ``all``} |
36 |
|
37 |
Archive jobs by their age. This command can archive jobs older than |
38 |
*age* seconds, or alternatively all finished jobs can be archived |
39 |
if the string all is passed. |
40 |
|
41 |
CANCEL |
42 |
~~~~~~ |
43 |
|
44 |
**cancel** {*id*} |
45 |
|
46 |
Cancel the job identified by the given *id*. Only jobs that have |
47 |
not yet started to run can be canceled; that is, jobs in either the |
48 |
*queued* or *waiting* state. |
49 |
|
50 |
INFO |
51 |
~~~~ |
52 |
|
53 |
**info** {*id*...} |
54 |
|
55 |
Show detailed information about the given job id(s). If no job id |
56 |
is given, all jobs are examined (warning, this is a lot of |
57 |
information). |
58 |
|
59 |
LIST |
60 |
~~~~ |
61 |
|
62 |
| **list** [\--no-headers] [\--separator=*SEPARATOR*] |
63 |
| [-o *[+]FIELD,...*] [\--filter] [job-id...] |
64 |
|
65 |
Lists the jobs and their status. By default, the job id, job |
66 |
status, and a small job description is listed, but additional |
67 |
parameters can be selected. |
68 |
|
69 |
The ``--no-headers`` option will skip the initial header line. The |
70 |
``--separator`` option takes an argument which denotes what will be |
71 |
used between the output fields. Both these options are to help |
72 |
scripting. |
73 |
|
74 |
The ``-o`` option takes a comma-separated list of output fields. |
75 |
The available fields and their meaning are: |
76 |
|
77 |
@QUERY_FIELDS_JOB@ |
78 |
|
79 |
If the value of the option starts with the character ``+``, the new |
80 |
fields will be added to the default list. This allows one to quickly |
81 |
see the default list plus a few other fields, instead of retyping |
82 |
the entire list of fields. |
83 |
|
84 |
To include archived jobs in the list the ``--archived`` option can be |
85 |
used. |
86 |
|
87 |
The following options can be used to show only specific jobs: |
88 |
|
89 |
``--pending`` |
90 |
Show only jobs pending execution. |
91 |
``--running`` |
92 |
Show jobs currently running only. |
93 |
``--error`` |
94 |
Show failed jobs only. |
95 |
``--finished`` |
96 |
Show finished jobs only. |
97 |
|
98 |
If exactly one argument is given and it appears to be a query filter |
99 |
(see **ganeti(7)**), the query result is filtered accordingly. For |
100 |
ambiguous cases (e.g. a single field name as a filter) the ``--filter`` |
101 |
(``-F``) option forces the argument to be treated as a filter. |
102 |
|
103 |
|
104 |
LIST-FIELDS |
105 |
~~~~~~~~~~~ |
106 |
|
107 |
**list-fields** [field...] |
108 |
|
109 |
Lists available fields for jobs. |
110 |
|
111 |
|
112 |
WATCH |
113 |
~~~~~ |
114 |
|
115 |
**watch** {id} |
116 |
|
117 |
This command follows the output of the job by the given *id* and |
118 |
prints it. |
119 |
|
120 |
.. vim: set textwidth=72 : |
121 |
.. Local Variables: |
122 |
.. mode: rst |
123 |
.. fill-column: 72 |
124 |
.. End: |