Fix some pylint-detected issues

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

diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml
index 0095fbf..9332dfa 100644 (file)
--- a/man/gnt-instance.sgml
+++ b/man/gnt-instance.sgml
@@ -83,6 +83,13 @@
             <replaceable>cdrom-image-path</replaceable></arg>
           <sbr>
 
             <replaceable>cdrom-image-path</replaceable></arg>
           <sbr>
 

+          <arg>--hvm-nic-type <replaceable>NICTYPE</replaceable></arg>
+          <sbr>
+
+          <arg>--hvm-disk-type
+          <replaceable>DISKTYPE</replaceable></arg>
+          <sbr>
+

           <arg>--vnc-bind-address
             <replaceable>vnc-bind-address</replaceable></arg>
           <sbr>
           <arg>--vnc-bind-address
             <replaceable>vnc-bind-address</replaceable></arg>
           <sbr>

@@ -224,35 +231,58 @@
         </para>
 
         <para>
         </para>
 
         <para>

-          The option is only relevant for Xen HVM instances and
-          ignored by all other instances types.
+          The default is not to set an HVM boot order which is
+          interpreted as 'dc'. This option, like all options starting
+          with 'hvm', is only relevant for Xen HVM instances and
+          ignored by all other instance types.

         </para>
 
         <para>
           The <option>--hvm-acpi</option> option specifies if Xen
           should enable ACPI support for this HVM instance. Valid
         </para>
 
         <para>
           The <option>--hvm-acpi</option> option specifies if Xen
           should enable ACPI support for this HVM instance. Valid

-          values are true or false.
+          values are true or false. The default value is false,
+          disabling ACPI support for this instance.

         </para>
 
         <para>
           The <option>--hvm-pae</option> option specifies if Xen
           should enabled PAE support for this HVM instance. Valid
         </para>
 
         <para>
           The <option>--hvm-pae</option> option specifies if Xen
           should enabled PAE support for this HVM instance. Valid

-          values are true or false.
+          values are true or false. The default is false, disabling
+          PAE support for this instance.

         </para>
 
         <para>
           The <option>--hvm-cdrom-image-path</option> option specifies the
         </para>
 
         <para>
           The <option>--hvm-cdrom-image-path</option> option specifies the

-          path to the file xen uses to emulate a virtual CDROM drive
+          path to the file Xen uses to emulate a virtual CDROM drive

           for this HVM instance. Valid values are either an
           absolute path to an existing file or None, which disables
           for this HVM instance. Valid values are either an
           absolute path to an existing file or None, which disables

-          virtual CDROM support for this instance.
+          virtual CDROM support for this instance. The default is
+          None, disabling virtual CDROM support.
+        </para>
+
+        <para>
+          The <option>--hvm-nic-type</option> specifies the NIC type
+          Xen should use for this HVM instance. Valid choices are
+          rtl8139, ne2k_pci, ne2k_isa and paravirtual with rtl8139
+          as the default. The paravirtual setting is intended for use
+          with the GPL PV drivers inside HVM Windows instances.
+        </para>
+
+        <para>
+          The <option>--hvm-disk-type</option> specifies the disk type
+          Xen should use for the HVM instance. Valid choices are ioemu
+          and paravirtual with ioemu as the default. The paravirtual
+          setting is intended for use with the GPL PV drivers inside
+          HVM Windows instances.

         </para>
 
         <para>
           The <option>--vnc-bind-address</option> option specifies the
           address that the VNC listener for this instance should bind
           to. Valid values are IPv4 addresses. Use the address 0.0.0.0
         </para>
 
         <para>
           The <option>--vnc-bind-address</option> option specifies the
           address that the VNC listener for this instance should bind
           to. Valid values are IPv4 addresses. Use the address 0.0.0.0

-          to bind to all available interfaces.
+          to bind to all available interfaces (this is the default)
+          or specify the address of one of the interfaces on the node
+          to restrict listening to that interface.

         </para>
 
         <para>
         </para>
 
         <para>

@@ -582,6 +612,15 @@
                 tags</simpara>
               </listitem>
             </varlistentry>
                 tags</simpara>
               </listitem>
             </varlistentry>

+            <varlistentry>
+              <term>serial_no</term>
+              <listitem>
+                <simpara>the so called 'serial number' of the
+                instance; this is a numeric field that is incremented
+                each time the instance is modified, and it can be used
+                to detect modifications</simpara>
+              </listitem>
+            </varlistentry>

           </variablelist>
         </para>
 
           </variablelist>
         </para>
 

@@ -622,6 +661,10 @@
 
         <cmdsynopsis>
           <command>info</command>
 
         <cmdsynopsis>
           <command>info</command>

+          <group>
+            <arg>-s</arg>
+            <arg>--static</arg>
+          </group>

           <arg rep="repeat"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
 
           <arg rep="repeat"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
 

@@ -631,6 +674,12 @@
           detailed data about the instance's disks (especially useful
           for drbd disk template).
         </para>
           detailed data about the instance's disks (especially useful
           for drbd disk template).
         </para>

+
+        <para>
+          If the option <option>-s</option> is used, only information
+          available in the configuration file is returned, without
+          querying nodes, making the operation faster.
+        </para>

       </refsect3>
 
       <refsect3>
       </refsect3>
 
       <refsect3>

@@ -648,6 +697,8 @@
           <arg>--hvm-pae <replaceable>PAE-support</replaceable></arg>
           <arg>--hvm-cdrom-image-path
             <replaceable>cdrom-image-path</replaceable></arg>
           <arg>--hvm-pae <replaceable>PAE-support</replaceable></arg>
           <arg>--hvm-cdrom-image-path
             <replaceable>cdrom-image-path</replaceable></arg>

+          <arg>--hvm-nic-type <replaceable>NICTYPE</replaceable></arg>
+          <arg>--hvm-disk-type <replaceable>DISKTYPE</replaceable></arg>

           <arg>--vnc-bind-address
             <replaceable>vnc-bind-address</replaceable></arg>
 
           <arg>--vnc-bind-address
             <replaceable>vnc-bind-address</replaceable></arg>
 

@@ -709,6 +760,22 @@
         </para>
 
         <para>
         </para>
 
         <para>

+          The <option>--hvm-nic-type</option> specifies the NIC type
+          Xen should use for this HVM instance. Valid choices are
+          rtl8139, ne2k_pci, ne2k_isa and paravirtual with rtl8139
+          as the default. The paravirtual setting is intended for use
+          with the GPL PV drivers inside HVM Windows instances.
+        </para>
+
+        <para>
+          The <option>--hvm-disk-type</option> specifies the disk type
+          Xen should use for the HVM instance. Valid choices are ioemu
+          and paravirtual with ioemu as the default. The paravirtual
+          setting is intended for use with the GPL PV drivers inside
+          HVM Windows instances.
+        </para>
+
+        <para>

           The <option>--vnc-bind-address</option> specifies the
           address that the VNC listener for this instance should bind
           to. Valid values are IPv4 addresses. Use the address 0.0.0.0
           The <option>--vnc-bind-address</option> specifies the
           address that the VNC listener for this instance should bind
           to. Valid values are IPv4 addresses. Use the address 0.0.0.0

@@ -728,6 +795,7 @@
           <command>reinstall</command>
           <arg choice="opt">-o <replaceable>os-type</replaceable></arg>
           <arg choice="opt">-f <replaceable>force</replaceable></arg>
           <command>reinstall</command>
           <arg choice="opt">-o <replaceable>os-type</replaceable></arg>
           <arg choice="opt">-f <replaceable>force</replaceable></arg>

+          <arg>--select-os</arg>

           <arg choice="req"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
 
           <arg choice="req"><replaceable>instance</replaceable></arg>
         </cmdsynopsis>
 

@@ -737,6 +805,12 @@
           <option>--os-type</option> is specified, the operating system is
           changed.
         </para>
           <option>--os-type</option> is specified, the operating system is
           changed.
         </para>

+
+        <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.
+        </para>

       </refsect3>
 
       <refsect3>
       </refsect3>
 
       <refsect3>

@@ -937,7 +1011,7 @@
           recreates the hypervisor config for the instance and
           starts the instance. A full reboot does the equivalent
           of <command>gnt-instance shutdown &amp;&amp; gnt-instance
           recreates the hypervisor config for the instance and
           starts the instance. A full reboot does the equivalent
           of <command>gnt-instance shutdown &amp;&amp; gnt-instance

-          startup</command>. The default is soft reboot.
+          startup</command>. The default is hard reboot.

         </para>
 
         <para>
         </para>
 
         <para>

@@ -984,6 +1058,13 @@
         </para>
 
         <para>
         </para>
 
         <para>

+          For HVM instances, this will attempt to connect to the serial
+          console of the instance. To connect to the virtualized
+          "physical" console of a HVM instance, use a VNC client with
+          the connection info from gnt-instance info.
+        </para>
+
+        <para>

           Example:
           <screen>
 # gnt-instance console instance1.example.com
           Example:
           <screen>
 # gnt-instance console instance1.example.com

@@ -1095,6 +1176,7 @@ node1.example.com:sdb:/dev/drbd1
         <title>GROW-DISK</title>
         <cmdsynopsis>
           <command>grow-disk</command>
         <title>GROW-DISK</title>
         <cmdsynopsis>
           <command>grow-disk</command>

+          <arg>--no-wait-for-sync</arg>

           <arg choice="req"><replaceable>instance</replaceable></arg>
           <arg choice="req"><replaceable>disk</replaceable></arg>
           <arg choice="req"><replaceable>amount</replaceable></arg>
           <arg choice="req"><replaceable>instance</replaceable></arg>
           <arg choice="req"><replaceable>disk</replaceable></arg>
           <arg choice="req"><replaceable>amount</replaceable></arg>

@@ -1151,7 +1233,14 @@ node1.example.com:sdb:/dev/drbd1
           create problems (except for unused space).
         </para>
 
           create problems (except for unused space).
         </para>
 

-        <para>Example (increasing sda for instance1 with 16GiB):
+        <para>
+          If you do not want gnt-instance to wait for the new disk
+          region to be synced, use the
+          <option>--no-wait-for-sync</option> option.
+        </para>
+
+
+        <para>Example (increase sda for instance1 by 16GiB):

           <screen>
 # gnt-instance grow-disk instance1.example.com sda 16g
           </screen>
           <screen>
 # gnt-instance grow-disk instance1.example.com sda 16g
           </screen>