gnt-node list: Query filter support

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

diff --git a/man/gnt-instance.rst b/man/gnt-instance.rst
index 5d166b0..397466e 100644 (file)
--- a/man/gnt-instance.rst
+++ b/man/gnt-instance.rst
@@ -625,7 +625,7 @@ LIST
 
 | **list**
 | [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]
-| [-o *[+]FIELD,...*] [instance...]
+| [-o *[+]FIELD,...*] [--filter] [instance...]
 
 Shows the currently configured instances with memory usage, disk
 usage, the node they are running on, and their run status.
@@ -664,8 +664,14 @@ to ask the remote nodes for the data. This can be helpful for big
 clusters when you only want some data and it makes sense to specify
 a reduced set of output fields.
 
-The default output field list is: name, os, pnode, admin\_state,
-oper\_state, oper\_ram.
+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 (e.g.
+``gnt-instance list -F admin_state``).
+
+The default output field list is: ``name``, ``os``, ``pnode``,
+``admin_state``, ``oper_state``, ``oper_ram``.
 
 
 LIST-FIELDS
@@ -793,11 +799,11 @@ the IP it resolves to must not be reachable (in order to prevent
 duplicate IPs the next time the instance is started). The IP test
 can be skipped if the ``--no-ip-check`` option is passed.
 
-The ``--no-name-check`` skips the check for the new instance name
-via the resolver (e.g. in DNS or /etc/hosts, depending on your
-setup). Since the name check is used to compute the IP address, if
-you pass this option you must also pass the ``--no-ip-check``
-option.
+The ``--no-name-check`` skips the check for the new instance name via
+the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and
+that the resolved name matches the provided name. Since the name check
+is used to compute the IP address, if you pass this option you must also
+pass the ``--no-ip-check`` option.
 
 The ``--submit`` option is used to send the job to the master
 daemon but not wait for its completion. The job ID will be shown so
@@ -1219,8 +1225,8 @@ MIGRATE
 
 **migrate** [-f] {--cleanup} {*instance*}
 
-**migrate** [-f] [--non-live] [--migration-mode=live\|non-live]
-{*instance*}
+**migrate** [-f] [--allow-failover] [--non-live]
+[--migration-mode=live\|non-live] {*instance*}
 
 Migrate will move the instance to its secondary node without
 shutdown. It only works for instances having the drbd8 disk
@@ -1252,6 +1258,11 @@ instances's disks are configured correctly. In this mode, the
 
 The option ``-f`` will skip the prompting for confirmation.
 
+If ``--allow-failover`` is specified it tries to fallback to failover if
+it already can determine that a migration wont work (i.e. if the
+instance is shutdown). Please note that the fallback will not happen
+during execution. If a migration fails during execution it still fails.
+
 Example (and expected output)::
 
     # gnt-instance migrate instance1
@@ -1337,3 +1348,5 @@ be extended with the contents of that file (each line becomes a tag).
 In this case, there is not need to pass tags on the command line (if
 you do, tags from both sources will be removed). A file name of - will
 be interpreted as stdin.
+
+.. vim: set textwidth=72 :