QA: adapt changes wrt DRBD usermode helper

[ganeti-local] / man / gnt-job.rst

diff --git a/man/gnt-job.rst b/man/gnt-job.rst
index a8f44a1..7f3c80d 100644 (file)
--- a/man/gnt-job.rst
+++ b/man/gnt-job.rst
@@ -41,11 +41,28 @@ 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 +76,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
@@ -74,59 +91,48 @@ scripting.
 The ``-o`` option takes a comma-separated list of output fields.
 The available fields and their meaning are:
 
+@QUERY_FIELDS_JOB@
 
+If the value of the option starts with the character ``+``, the new
+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.
 
-id
-    the job id
-
-status
-    the status of the job
-
-priority
-    current priority of the job
-
-received_ts
-    the timestamp the job was received
-
-start_ts
-    the timestamp when the job was started
-
-end_ts
-    the timestamp when the job was ended
+To include archived jobs in the list the ``--archived`` option can be
+used.
 
-summary
-    a summary of the opcodes that define the job
+The following options can be used to show only specific jobs:
 
-ops
-    the list of opcodes defining the job
+``--pending``
+  Show only jobs pending execution.
+``--running``
+  Show jobs currently running only.
+``--error``
+  Show failed jobs only.
+``--finished``
+  Show finished jobs only.
 
-opresult
-    the list of opcode results
+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.
 
-opstatus
-    the list of opcode statuses
 
-oplog
-    the list of opcode logs
+LIST-FIELDS
+~~~~~~~~~~~
 
-opstart
-    the list of opcode start times (before acquiring locks)
+**list-fields** [field...]
 
-opexec
-    the list of opcode execution start times (after acquiring any
-    necessary locks)
+Lists available fields for jobs.
 
-opend
-    the list of opcode end times
 
-oppriority
-    the priority of each opcode
+WAIT
+~~~~~
 
+**wait** {id}
 
-If the value of the option starts with the character ``+``, the new
-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.
+Wait for the job by the given *id* to finish; do not produce
+any output.
 
 WATCH
 ~~~~~
@@ -135,3 +141,9 @@ WATCH
 
 This command follows the output of the job by the given *id* and
 prints it.
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: