X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/3086220e0c2bc427955b6ecdcbd3b041be108221..313fdabc5bd7b32e6e57e1d0a0cd57f8005607b5:/man/gnt-job.rst diff --git a/man/gnt-job.rst b/man/gnt-job.rst index c634d0d..83a3361 100644 --- a/man/gnt-job.rst +++ b/man/gnt-job.rst @@ -41,11 +41,26 @@ if the string all is passed. CANCEL ~~~~~~ -**cancel** {*id*} +| **cancel** +| {[\--force] {\--pending | \--queued | \--waiting} | *job-id* ...} -Cancel the job identified by the given *id*. Only jobs that have +Cancel the job(s) identified by the given *job id*. Only jobs that have not yet started to run can be canceled; that is, jobs in either the -*queued* or *waiting* state. +*queued* or *waiting* state. To skip a confirmation, pass ``--force``. +``--queued`` and ``waiting`` can be used to cancel all jobs in the +respective state, ``--pending`` includes both. + +CHANGE-PRIORITY +~~~~~~~~~~~~~~~ + +| **change-priority** \--priority {low | normal | high} +| {[\--force] {\--pending | \--queued | \--waiting} | *job-id* ...} + +Changes the priority of one or multiple pending jobs. Jobs currently +running have only the priority of remaining opcodes changed. +``--priority`` must be specified. ``--queued`` and ``waiting`` can be +used to re-prioritize all jobs in the respective state, ``--pending`` +includes both. To skip a confirmation, pass ``--force``. INFO ~~~~ @@ -59,8 +74,8 @@ information). LIST ~~~~ -**list** [\--no-headers] [\--separator=*SEPARATOR*] -[-o *[+]FIELD,...*] +| **list** [\--no-headers] [\--separator=*SEPARATOR*] +| [-o *[+]FIELD,...*] [\--filter] [job-id...] Lists the jobs and their status. By default, the job id, job status, and a small job description is listed, but additional @@ -81,6 +96,25 @@ fields will be added to the default list. This allows one to quickly see the default list plus a few other fields, instead of retyping the entire list of fields. +To include archived jobs in the list the ``--archived`` option can be +used. + +The following options can be used to show only specific jobs: + +``--pending`` + Show only jobs pending execution. +``--running`` + Show jobs currently running only. +``--error`` + Show failed jobs only. +``--finished`` + Show finished jobs only. + +If exactly one argument is given and it appears to be a query filter +(see **ganeti**\(7)), the query result is filtered accordingly. For +ambiguous cases (e.g. a single field name as a filter) the ``--filter`` +(``-F``) option forces the argument to be treated as a filter. + LIST-FIELDS ~~~~~~~~~~~