Move gnt-job to ganeti.client.gnt_job

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

diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml
index 560b665..565b22a 100644 (file)
--- a/man/gnt-instance.sgml
+++ b/man/gnt-instance.sgml
@@ -136,7 +136,7 @@
           interpreted (when no unit is given) in mebibytes. You can
           also use one of the suffixes
           <literal>m</literal>, <literal>g</literal> or
-          <literal>t</literal> to specificy the exact the units used;
+          <literal>t</literal> to specify the exact the units used;
           these suffixes map to mebibytes, gibibytes and tebibytes.
         </para>
 
@@ -633,9 +633,9 @@
               <listitem>
                 <simpara>Valid for the KVM hypervisor.</simpara>
 
-                <simpara>Under security model <quote>user</quote> the username
-                to run the instance under. It must be a valid username
-                existing on the host.
+                <simpara>Under security model <quote>user</quote> the
+                username to run the instance under. It must be a valid
+                username existing on the host.
                 </simpara>
                 <simpara>Cannot be set under security model <quote>none</quote>
                 or <quote>pool</quote>.
@@ -714,13 +714,17 @@
                 <simpara>This boolean option determines wether to run the KVM
                 instance in a chroot directory.
                 </simpara>
-                <para>If it is set to <quote>true</quote>, an empty directory
-                is created before starting the instance and its path is passed
-                via the <option>-chroot</option> flag to kvm.
-                The directory is removed when the instance is stopped.
+
+                <para>If it is set to <quote>true</quote>, an empty
+                directory is created before starting the instance and
+                its path is passed via the <option>-chroot</option>
+                flag to kvm.  The directory is removed when the
+                instance is stopped.
                 </para>
 
-                <simpara>It is set to <quote>false</quote> by default.</simpara>
+                <simpara>It is set to <quote>false</quote> by
+                default.</simpara>
+
               </listitem>
             </varlistentry>
 
@@ -1025,7 +1029,8 @@
         </para>
 
         <para>
-          The command will display the job id for each submitted instance, as follows:
+          The command will display the job id for each submitted
+          instance, as follows:
           <screen>
 # gnt-instance batch-create instances.json
 instance3: 11224
@@ -1092,6 +1097,8 @@ instance5: 11225
           <command>list</command>
           <arg>--no-headers</arg>
           <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
+        <sbr>
+        <arg>--units=<replaceable>UNITS</replaceable></arg>
           <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
           <arg>--roman</arg>
           <arg rep="repeat">instance</arg>
@@ -1111,6 +1118,16 @@ instance5: 11225
         </para>
 
         <para>
+          The units used to display the numeric values in the output
+          varies, depending on the options given. By default, the values
+          will be formatted in the most appropriate unit. If the
+          <option>--separator</option> option is given, then the values
+          are shown in mebibytes to allow parsing by scripts. In both
+          cases, the <option>--units</option> option can be used to
+          enforce a given output unit.
+        </para>
+
+        <para>
           The <option>--roman</option> option allows latin people to better
           understand the cluster instances' status.
         </para>
@@ -1634,6 +1651,8 @@ instance5: 11225
             <arg>--secondary</arg>
             <arg>--all</arg>
           </group>
+          <sbr>
+          <arg choice="opt">-O <replaceable>OS_PARAMETERS</replaceable></arg>
           <arg>--submit</arg>
           <arg choice="opt" rep="repeat"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
@@ -1648,7 +1667,8 @@ instance5: 11225
         <para>
           The <option>--select-os</option> option switches to an
           interactive OS reinstall. The user is prompted to select the OS
-          template from the list of available OS templates.
+          template from the list of available OS templates. OS parameters
+          can be overridden using <option>-O</option>.
         </para>
 
         <para>
@@ -1670,7 +1690,6 @@ instance5: 11225
           <command>gnt-job info</command>.
         </para>
 
-
       </refsect3>
 
       <refsect3>
@@ -1724,6 +1743,7 @@ instance5: 11225
           <command>startup</command>
           <sbr>
           <arg>--force</arg>
+          <arg>--ignore-offline</arg>
           <sbr>
           <arg>--force-multiple</arg>
           <sbr>
@@ -1831,7 +1851,9 @@ instance5: 11225
 
         <para>
           Use <option>--force</option> to start even if secondary disks are
-          failing.
+          failing. <option>--ignore-offline</option> can be used to ignore
+          offline primary nodes and mark the instance as started even if
+          the primary is not available.
         </para>
 
         <para>
@@ -1887,6 +1909,7 @@ instance5: 11225
           <arg>--timeout=<replaceable>N</replaceable></arg>
           <sbr>
           <arg>--force-multiple</arg>
+          <arg>--ignore-offline</arg>
           <sbr>
           <group choice="opt">
             <arg>--instance</arg>
@@ -1937,6 +1960,12 @@ instance5: 11225
           <command>gnt-job info</command>.
         </para>
 
+        <para>
+          <option>--ignore-offline</option> can be used to ignore offline
+          primary nodes and force the instance to be marked as stopped. This
+          option should be used with care as it can lead to an
+          inconsistent cluster state.
+        </para>
 
         <para>
           Example: