+ <term>sdb_size</term>
+ <listitem>
+ <simpara>the size of the instance's second disk, if
+ any</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>vcpus</term>
+ <listitem>
+ <simpara>the number of VCPUs allocated to the
+ instance</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>tags</term>
+ <listitem>
+ <simpara>comma-separated list of the instances's
+ 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 track modifications</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>network_port</term>
+ <listitem>
+ <simpara>If the instance has a network port assigned
+ to it (e.g. for VNC connections), this will be shown,
+ otherwise <literal>-</literal> will be
+ displayed.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>beparams</term>
+ <listitem>
+ <simpara>A text format of the entire beparams for the
+ instance. It's more useful to select individual fields
+ from this dictionary, see below.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>disk.count</term>
+ <listitem>
+ <simpara>The number of instance disks.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>disk.size/N</term>
+ <listitem>
+ <simpara>The size of the instance's Nth disk. This is
+ a more generic form of the <literal>sda_size</literal>
+ and <literal>sdb_size</literal> fields.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>disk.sizes</term>
+ <listitem>
+ <simpara>A comma-separated list of the disk sizes for
+ this instance.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>disk_usage</term>
+ <listitem>
+ <simpara>The total disk space used by this instance on
+ each of its nodes. This is not the instance-visible
+ disk size, but the actual disk "cost" of the
+ instance.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nic.mac/N</term>
+ <listitem>
+ <simpara>The MAC of the Nth instance NIC.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nic.ip/N</term>
+ <listitem>
+ <simpara>The IP address of the Nth instance NIC.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nic.bridge/N</term>
+ <listitem>
+ <simpara>The bridge the Nth instance NIC is attached
+ to.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nic.macs</term>
+ <listitem>
+ <simpara>A comma-separated list of all the MACs of the
+ instance's NICs.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nic.ips</term>
+ <listitem>
+ <simpara>A comma-separated list of all the IP
+ addresses of the instance's NICs.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nic.bridges</term>
+ <listitem>
+ <simpara>A comma-separated list of all the bridges of the
+ instance's NICs.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nic.count</term>
+ <listitem>
+ <simpara>The number of instance nics.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>hv/<replaceable>NAME</replaceable></term>
+ <listitem>
+ <simpara>The value of the hypervisor parameter called
+ <replaceable>NAME</replaceable>. For details of what
+ hypervisor parameters exist and their meaning, see the
+ <command>add</command> command.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>be/memory</term>
+ <listitem>
+ <simpara>The configured memory for the instance.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>be/vcpus</term>
+ <listitem>
+ <simpara>The configured number of VCPUs for the
+ instance.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>be/auto_balance</term>
+ <listitem>
+ <simpara>Whether the instance is considered in N+1
+ checks.</simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ If the value of the option starts with the character
+ <constant>+</constant>, the new field(s) will be added to the
+ default list. This allows to quickly see the default list
+ plus a few other fields, instead of retyping the entire list
+ of fields.
+ </para>
+
+ <para>
+ There is a subtle grouping about the available output
+ fields: all fields except for <option>oper_state</option>,
+ <option>oper_ram</option> and <option>status</option> are
+ configuration value and not run-time values. So if you don't
+ select any of the these fields, the query will be satisfied
+ instantly from the cluster configuration, without having 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.
+ </para>
+
+ <para>The default output field list is:
+ <simplelist type="inline">
+ <member>name</member>
+ <member>os</member>
+ <member>pnode</member>
+ <member>admin_state</member>
+ <member>oper_state</member>
+ <member>oper_ram</member>
+ </simplelist>.
+ </para>
+ </refsect3>
+
+ <refsect3>
+ <title>INFO</title>
+
+ <cmdsynopsis>
+ <command>info</command>
+ <group>
+ <arg>-s</arg>
+ <arg>--static</arg>
+ </group>
+ <group choice="req">
+ <arg>--all</arg>
+ <arg rep="repeat"><replaceable>instance</replaceable></arg>
+ </group>
+ </cmdsynopsis>
+
+ <para>
+ Show detailed information about the given instance(s). This is
+ different from <command>list</command> as it shows detailed data
+ about the instance's disks (especially useful for the 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>
+
+ <para>
+ Use the <option>--all</option> to get info about all instances,
+ rather than explicitely passing the ones you're interested in.
+ </para>
+ </refsect3>
+
+ <refsect3>
+ <title>MODIFY</title>
+
+ <cmdsynopsis>
+ <command>modify</command>
+ <sbr>
+ <arg choice="opt">-H <replaceable>HYPERVISOR_PARAMETERS</replaceable></arg>
+ <sbr>
+ <arg choice="opt">-B <replaceable>BACKEND_PARAMETERS</replaceable></arg>
+ <sbr>
+ <group>
+ <arg>--net add<replaceable><optional>:options</optional></replaceable></arg>
+ <arg>--net remove</arg>
+ <arg>--net <replaceable>N:options</replaceable></arg>
+ </group>
+ <sbr>
+ <group>
+ <arg>--disk add:size=<replaceable>SIZE</replaceable></arg>
+ <arg>--disk remove</arg>
+ <arg>--disk <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></arg>
+ </group>
+
+ <sbr>
+ <arg>--submit</arg>
+ <sbr>
+ <arg choice="req"><replaceable>instance</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ Modifies the memory size, number of vcpus, ip address, MAC
+ address and/or bridge for an instance. It can also add and
+ remove disks and NICs to/from the instance. Note that you
+ need to give at least one of the arguments, otherwise the
+ command complains.
+ </para>
+
+ <para>
+ The <option>-H</option> option specifies hypervisor options
+ in the form of <userinput>name=value[,...]</userinput>. For details which options can be specified, see the <command>add</command> command.
+ </para>
+
+ <para>
+ The <option>--disk
+ add:size=<replaceable>SIZE</replaceable></option> option
+ adds a disk to the instance. The <option>--disk
+ remove</option> will remove the last disk of the
+ instance. The <option>--disk
+ <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></option>
+ option will change the mode of the Nth disk of the instance
+ between read-only (<literal>ro</literal>) and read-write
+ (<literal>rw</literal>).
+ </para>
+
+ <para>
+ The <option>--nic
+ add:<replaceable>options</replaceable></option> option will
+ add a new NIC to the instance. The available options are the
+ same as in the <command>add</command> command (mac, ip,
+ bridge). The <option>--nice remove</option> will remove the
+ last NIC of the instance, while the <option>--nic
+ <replaceable>N</replaceable>:<replaceable>options</replaceable></option>
+ option will change the parameters of the Nth instance NIC.
+ </para>
+
+ <para>
+ The <option>--submit</option> option is used to send the job to
+ the master daemon but not wait for its completion. The job
+ ID will be shown so that it can be examined via
+ <command>gnt-job info</command>.
+ </para>
+
+ <para>
+ All the changes take effect at the next restart. If the
+ instance is running, there is no effect on the instance.
+ </para>
+ </refsect3>
+
+ <refsect3>
+ <title>REINSTALL</title>
+
+ <cmdsynopsis>
+ <command>reinstall</command>
+ <arg choice="opt">-o <replaceable>os-type</replaceable></arg>
+ <arg>--select-os</arg>
+ <arg choice="opt">-f <replaceable>force</replaceable></arg>
+ <arg>--force-multiple</arg>
+ <sbr>
+ <group choice="opt">
+ <arg>--instance</arg>
+ <arg>--node</arg>
+ <arg>--primary</arg>
+ <arg>--secondary</arg>
+ <arg>--all</arg>
+ </group>
+ <arg>--submit</arg>
+ <arg choice="opt" rep="repeat"><replaceable>instance</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ Reinstalls the operating system on the given instance(s). The
+ instance(s) must be stopped when running this command. If the
+ <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>
+
+ <para>
+ Since this is a potentially dangerous command, the user will
+ be required to confirm this action, unless the
+ <option>-f</option> flag is passed. When multiple instances
+ are selected (either by passing multiple arguments or by
+ using the <option>--node</option>,
+ <option>--primary</option>, <option>--secondary</option> or
+ <option>--all</option> options), the user must pass both the
+ <option>--force</option> and
+ <option>--force-multiple</option> options to skip the
+ interactive confirmation.
+ </para>
+
+ <para>
+ The <option>--submit</option> option is used to send the job to
+ the master daemon but not wait for its completion. The job
+ ID will be shown so that it can be examined via
+ <command>gnt-job info</command>.
+ </para>
+
+
+ </refsect3>
+
+ <refsect3>
+ <title>RENAME</title>
+
+ <cmdsynopsis>
+ <command>rename</command>
+ <arg>--no-ip-check</arg>
+ <arg>--submit</arg>
+ <arg choice="req"><replaceable>instance</replaceable></arg>
+ <arg choice="req"><replaceable>new_name</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ Renames the given instance. The instance must be stopped
+ when running this command. The requirements for the new name
+ are the same as for adding an instance: the new name must be
+ resolvable and 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
+ <option>--no-ip-check</option> option is passed.
+ </para>
+
+ <para>
+ The <option>--submit</option> option is used to send the job to
+ the master daemon but not wait for its completion. The job
+ ID will be shown so that it can be examined via
+ <command>gnt-job info</command>.
+ </para>
+
+ </refsect3>
+
+ </refsect2>
+
+ <refsect2>
+ <title>Starting/stopping/connecting to console</title>
+
+ <refsect3>
+ <title>STARTUP</title>
+
+ <cmdsynopsis>
+ <command>startup</command>
+ <sbr>
+ <arg>--force</arg>
+ <sbr>
+ <arg>--force-multiple</arg>
+ <sbr>
+ <group choice="opt">
+ <arg>--instance</arg>
+ <arg>--node</arg>
+ <arg>--primary</arg>
+ <arg>--secondary</arg>
+ <arg>--all</arg>
+ </group>
+ <sbr>
+ <arg>-H <option>key=value...</option></arg>
+ <arg>-B <option>key=value...</option></arg>
+ <sbr>
+ <arg>--submit</arg>
+ <sbr>
+ <arg choice="opt"
+ rep="repeat"><replaceable>name</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ Starts one or more instances, depending on the following
+ options. The four available modes are:
+ <variablelist>
+ <varlistentry>
+ <term><option>--instance</option></term>