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