root / man / gnt-job.rst @ f5d13a77
History | View | Annotate | Download (3.5 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** |
45 |
| {[\--force] {\--pending | \--queued | \--waiting} | *job-id* ...} |
46 |
|
47 |
Cancel the job(s) identified by the given *job id*. Only jobs that have |
48 |
not yet started to run can be canceled; that is, jobs in either the |
49 |
*queued* or *waiting* state. To skip a confirmation, pass ``--force``. |
50 |
``--queued`` and ``waiting`` can be used to cancel all jobs in the |
51 |
respective state, ``--pending`` includes both. |
52 |
|
53 |
CHANGE-PRIORITY |
54 |
~~~~~~~~~~~~~~~ |
55 |
|
56 |
| **change-priority** \--priority {low | normal | high} |
57 |
| {[\--force] {\--pending | \--queued | \--waiting} | *job-id* ...} |
58 |
|
59 |
Changes the priority of one or multiple pending jobs. Jobs currently |
60 |
running have only the priority of remaining opcodes changed. |
61 |
``--priority`` must be specified. ``--queued`` and ``waiting`` can be |
62 |
used to re-prioritize all jobs in the respective state, ``--pending`` |
63 |
includes both. To skip a confirmation, pass ``--force``. |
64 |
|
65 |
INFO |
66 |
~~~~ |
67 |
|
68 |
**info** {*id*...} |
69 |
|
70 |
Show detailed information about the given job id(s). If no job id |
71 |
is given, all jobs are examined (warning, this is a lot of |
72 |
information). |
73 |
|
74 |
LIST |
75 |
~~~~ |
76 |
|
77 |
| **list** [\--no-headers] [\--separator=*SEPARATOR*] |
78 |
| [-o *[+]FIELD,...*] [\--filter] [job-id...] |
79 |
|
80 |
Lists the jobs and their status. By default, the job id, job |
81 |
status, and a small job description is listed, but additional |
82 |
parameters can be selected. |
83 |
|
84 |
The ``--no-headers`` option will skip the initial header line. The |
85 |
``--separator`` option takes an argument which denotes what will be |
86 |
used between the output fields. Both these options are to help |
87 |
scripting. |
88 |
|
89 |
The ``-o`` option takes a comma-separated list of output fields. |
90 |
The available fields and their meaning are: |
91 |
|
92 |
@QUERY_FIELDS_JOB@ |
93 |
|
94 |
If the value of the option starts with the character ``+``, the new |
95 |
fields will be added to the default list. This allows one to quickly |
96 |
see the default list plus a few other fields, instead of retyping |
97 |
the entire list of fields. |
98 |
|
99 |
To include archived jobs in the list the ``--archived`` option can be |
100 |
used. |
101 |
|
102 |
The following options can be used to show only specific jobs: |
103 |
|
104 |
``--pending`` |
105 |
Show only jobs pending execution. |
106 |
``--running`` |
107 |
Show jobs currently running only. |
108 |
``--error`` |
109 |
Show failed jobs only. |
110 |
``--finished`` |
111 |
Show finished jobs only. |
112 |
|
113 |
If exactly one argument is given and it appears to be a query filter |
114 |
(see **ganeti**\(7)), the query result is filtered accordingly. For |
115 |
ambiguous cases (e.g. a single field name as a filter) the ``--filter`` |
116 |
(``-F``) option forces the argument to be treated as a filter. |
117 |
|
118 |
|
119 |
LIST-FIELDS |
120 |
~~~~~~~~~~~ |
121 |
|
122 |
**list-fields** [field...] |
123 |
|
124 |
Lists available fields for jobs. |
125 |
|
126 |
|
127 |
WAIT |
128 |
~~~~~ |
129 |
|
130 |
**wait** {id} |
131 |
|
132 |
Wait for the job by the given *id* to finish; do not produce |
133 |
any output. |
134 |
|
135 |
WATCH |
136 |
~~~~~ |
137 |
|
138 |
**watch** {id} |
139 |
|
140 |
This command follows the output of the job by the given *id* and |
141 |
prints it. |
142 |
|
143 |
.. vim: set textwidth=72 : |
144 |
.. Local Variables: |
145 |
.. mode: rst |
146 |
.. fill-column: 72 |
147 |
.. End: |