Typos in ganeti-os-interface.rst
[ganeti-local] / man / mon-collector.rst
index 6260e2e..046a20e 100644 (file)
@@ -24,19 +24,81 @@ collector to be run.
 When executed, ``mon-collector`` will run the specified collector and will
 print its output to stdout, in JSON format.
 
-
-
-
 COLLECTORS
 ----------
 
 DRBD
 ~~~~
 
-| drbd [*status-file*]
+| drbd [ [ **-s** | **\--drbd-status** ] = *status-file* ] [ [ **-p** |
+  **\--drbd-pairing**] = *pairing-file* ]
 
 Collects the information about the version and status of the DRBD kernel
 module, and of the disks it is managing.
 
-If *status-file* is specified, the status will be read from that file.
-Otherwise, the collector will read it from /proc/drbd.
+If *status-file* and *pairing-file* are specified, the status and the
+instance-minor paring information will be read from those files.
+Otherwise, the collector will read them, respectively, from /proc/drbd
+and from the Confd server.
+
+The options that can be passed to the DRBD collector are as follows:
+
+-s *status-file*, \--drbd-status=*status-file*
+  Read the DRBD status from the specified file instead of /proc/drbd.
+
+-p *pairing-file*, \--drbd-pairing=*pairing-file*
+  Read the information about the pairing between instances and DRBD minors
+  from the specified file instead of asking the Confd servers for them.
+
+INSTANCE STATUS
+~~~~~~~~~~~~~~~
+
+| inst-status-xen [ [ **-a** | **\--address** ] = *ip-address* ] [ [ **-p** |
+  **\--port** ] = *port-number* ]
+
+Collects the information about the status of the instances of the current node.
+In order to perform this task, it needs to connect to the ConfD daemon to fetch
+some configuration information. The following parameters allow the user to
+specify the position where the daemon is listening, in case it's not the default
+one:
+
+-a *ip-address*, \--address=*ip-address*
+  The IP address the ConfD daemon is listening on.
+
+-p *port-number*, \--port=*port-number*
+  The port the ConfD deamon is listening on.
+
+LOGICAL VOLUMES
+~~~~~~~~~~~~~~~
+
+| lv [ [ **-a** | **\--address** ] = *ip-address* ] [ [ **-p** | **\--port** ] 
+  = *port-number* ] [ [ **-f** | **\--file** ] = *input-file* ] 
+  [ [ **-i** | **\--instances** ] = *instances-file* ]
+
+Collects the information about the logical volumes of the current node.
+
+In order to perform this task, it needs to interact with the ``lvs`` command
+line tool and to connect to the ConfD daemon to fetch some configuration
+information. The following parameters allow the user to specify the position
+where the daemon is listening, in case it's not the default one:
+
+-a *ip-address*, \--address=*ip-address*
+  The IP address the ConfD daemon is listening on.
+
+-p *port-number*, \--port=*port-number*
+  The port the ConfD deamon is listening on.
+
+Instead of accessing the live data on the cluster, the tool can also read data
+serialized on files (mainly for testing purposes). Namely:
+
+-f *input-file*, \--file *input-file*
+  The name of the file containing a recorded output of the ``lvs`` tool.
+
+-i *instances-file*, \--instances=*instances-file*
+  The name of the file containing a JSON serialization of instances the 
+  current node is primary and secondary for, listed as::
+
+    ([Instance], [Instance])
+
+  where the first list contains the instances the node is primary for, the 
+  second list those the node is secondary for.