Merge remote-tracking branch 'origin/stable-2.8'

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

diff --git a/man/gnt-backup.rst b/man/gnt-backup.rst
index 4dd66df..bb9851f 100644 (file)
--- a/man/gnt-backup.rst
+++ b/man/gnt-backup.rst
@@ -30,7 +30,7 @@ EXPORT
 
 Exports an instance to the target node. All the instance data and
 its configuration will be exported under the
 
 Exports an instance to the target node. All the instance data and
 its configuration will be exported under the

-``@CUSTOM_EXPORT_DIR@/``*instance* directory on the target node.
+``@CUSTOM_EXPORT_DIR@/$instance`` directory on the target node.

 
 The ``--shutdown-timeout`` is used to specify how much time to wait
 before forcing the shutdown (xm destroy in xen, killing the kvm
 
 The ``--shutdown-timeout`` is used to specify how much time to wait
 before forcing the shutdown (xm destroy in xen, killing the kvm

@@ -54,7 +54,7 @@ execution (and will be stored in the job log). It is recommended
 that for any non-zero exit code, the backup is considered invalid,
 and retried.
 
 that for any non-zero exit code, the backup is considered invalid,
 and retried.
 

-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common

 options.
 
 Example::
 options.
 
 Example::

@@ -121,17 +121,17 @@ ip
     the node expects the instance to use)
 
 mode
     the node expects the instance to use)
 
 mode

-    specifies the connection mode for this nic: ``routed`` or
-    ``bridged``.
+    specifies the connection mode for this NIC: ``routed``,
+    ``bridged`` or ``openvswitch``

 
 link
 
 link

-    in bridged mode specifies the bridge to attach this NIC to, in
-    routed mode it's intended to differentiate between different
-    routing tables/instance groups (but the meaning is dependent on
-    the network script in use, see **gnt-cluster**(8) for more
-    details)
+    in bridged and openvswitch mode specifies the interface to attach
+    this NIC to, in routed mode it's intended to differentiate between
+    different routing tables/instance groups (but the meaning is
+    dependent on the network script in use, see **gnt-cluster**\(8) for
+    more details)

 
 

-Of these ``mode`` and ``link`` are nic parameters, and inherit their
+Of these ``mode`` and ``link`` are NIC parameters, and inherit their

 default at cluster level.
 
 If no network is desired for the instance, you should create a single
 default at cluster level.
 
 If no network is desired for the instance, you should create a single

@@ -210,7 +210,7 @@ value matches the current cluster default and mark it as such
 affect the hypervisor, backend and NIC parameters, both read from
 the export file and passed in via the command line.
 
 affect the hypervisor, backend and NIC parameters, both read from
 the export file and passed in via the command line.
 

-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common

 options.
 
 Example for identical instance import::
 options.
 
 Example for identical instance import::

@@ -228,16 +228,40 @@ Explicit configuration example::
 LIST
 ~~~~
 
 LIST
 ~~~~
 

-**list** [\--node=*NODE*]
+| **list** [\--node=*NODE*] [\--no-headers] [\--separator=*SEPARATOR*]
+| [-o *[+]FIELD,...*]

 
 Lists the exports currently available in the default directory in
 all the nodes of the current cluster, or optionally only a subset
 of them specified using the ``--node`` option (which can be used
 multiple times)
 
 
 Lists the exports currently available in the default directory in
 all the nodes of the current cluster, or optionally only a subset
 of them specified using the ``--node`` option (which can be used
 multiple times)
 

+The ``--no-headers`` option will skip the initial header line. The
+``--separator`` option takes an argument which denotes what will be
+used between the output fields. Both these options are to help
+scripting.
+
+The ``-o`` option takes a comma-separated list of output fields.
+The available fields and their meaning are:
+
+@QUERY_FIELDS_EXPORT@
+
+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.
+

 Example::
 
 Example::
 

-    # gnt-backup list --nodes node1 --nodes node2
+    # gnt-backup list --node node1 --node node2
+
+
+LIST-FIELDS
+~~~~~~~~~~~
+
+**list-fields** [field...]
+
+Lists available fields for exports.

 
 
 REMOVE
 
 
 REMOVE