code.grnet.gr Git - ganeti-local/blob - man/gnt-instance.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
   4   <!-- Please adjust the date whenever revising the manpage. -->
   5   <!ENTITY dhdate      "<date>February 11, 2009</date>">
   6   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
   7        allowed: see man(7), man(1). -->
   8   <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
   9   <!ENTITY dhucpackage "<refentrytitle>gnt-instance</refentrytitle>">
  10   <!ENTITY dhpackage   "gnt-instance">
  11
  12   <!ENTITY debian      "<productname>Debian</productname>">
  13   <!ENTITY gnu         "<acronym>GNU</acronym>">
  14   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  15   <!ENTITY footer SYSTEM "footer.sgml">
  16 ]>
  17
  18 <refentry>
  19   <refentryinfo>
  20     <copyright>
  21       <year>2006</year>
  22       <year>2007</year>
  23       <year>2008</year>
  24       <year>2009</year>
  25       <holder>Google Inc.</holder>
  26     </copyright>
  27     &dhdate;
  28   </refentryinfo>
  29   <refmeta>
  30     &dhucpackage;
  31
  32     &dhsection;
  33     <refmiscinfo>ganeti 2.0</refmiscinfo>
  34   </refmeta>
  35   <refnamediv>
  36     <refname>&dhpackage;</refname>
  37
  38     <refpurpose>ganeti instance administration</refpurpose>
  39   </refnamediv>
  40   <refsynopsisdiv>
  41     <cmdsynopsis>
  42       <command>&dhpackage; </command>
  43
  44       <arg choice="req">command</arg>
  45       <arg>arguments...</arg>
  46     </cmdsynopsis>
  47   </refsynopsisdiv>
  48   <refsect1>
  49     <title>DESCRIPTION</title>
  50
  51     <para>
  52       The <command>&dhpackage;</command> is used for instance
  53       administration in the ganeti system.
  54     </para>
  55
  56   </refsect1>
  57   <refsect1>
  58     <title>COMMANDS</title>
  59
  60     <refsect2>
  61       <title>Creation/removal/querying</title>
  62
  63       <refsect3>
  64         <title>ADD</title>
  65         <cmdsynopsis>
  66           <command>add</command>
  67           <sbr>
  68           <arg choice="req">-t<group choice="req">
  69               <arg>diskless</arg>
  70               <arg>file</arg>
  71               <arg>plain</arg>
  72               <arg>drbd</arg>
  73             </group></arg>
  74           <sbr>
  75
  76           <group choice="req">
  77             <arg rep="repeat">--disk=<replaceable>N</replaceable>:size=<replaceable>VAL</replaceable><arg>,mode=<replaceable>ro|rw</replaceable></arg></arg>
  78             <arg>-s <replaceable>SIZE</replaceable></arg>
  79           </group>
  80           <sbr>
  81           <group>
  82             <arg rep="repeat">--net=<replaceable>N</replaceable><arg rep="repeat">:options</arg></arg>
  83             <arg>--no-nics</arg>
  84           </group>
  85           <sbr>
  86           <arg>-B <replaceable>BEPARAMS</replaceable></arg>
  87           <sbr>
  88
  89           <arg>-H <replaceable>HYPERVISOR</replaceable><arg>:<arg choice="plain" rep="repeat">option=<replaceable>value</replaceable></arg></arg></arg>
  90           <sbr>
  91
  92           <arg>--file-storage-dir <replaceable>dir_path</replaceable></arg>
  93           <arg>--file-driver<group choice="req">
  94               <arg>loop</arg>
  95               <arg>blktap</arg>
  96             </group></arg>
  97           <sbr>
  98
  99           <group choice="req">
 100             <arg>-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
 101             <arg>--iallocator <replaceable>name</replaceable></arg>
 102           </group>
 103           <sbr>
 104
 105           <arg choice="req">-o <replaceable>os-type</replaceable></arg>
 106           <sbr>
 107           <arg>--submit</arg>
 108           <sbr>
 109
 110           <arg choice="req"><replaceable>instance</replaceable></arg>
 111         </cmdsynopsis>
 112
 113         <para>
 114           Creates a new instance on the specified host. The
 115           <replaceable>instance</replaceable> argument must be in DNS,
 116           but depending on the bridge setup, need not be in the same
 117           network as the nodes in the cluster.
 118         </para>
 119
 120         <para>
 121           The <option>disk</option> option specifies the parameters
 122           for the disks of the instance. The numbering of disks starts
 123           at zero, and at least one disk needs to be passed. For each
 124           disk, at least the size needs to be given, and optionally
 125           the access mode (read-only or the default of read-write) can
 126           also be specified.  The size is interpreted (when no unit is
 127           given) in mebibytes. You can also use one of the suffixes
 128           <literal>m</literal>, <literal>g</literal> or
 129           <literal>t</literal> to specificy the exact the units used;
 130           these suffixes map to mebibytes, gibibytes and tebibytes.
 131         </para>
 132
 133         <para>
 134           Alternatively, a single-disk instance can be created via the
 135           <option>-s</option> option which takes a single argument,
 136           the size of the disk. This is similar to the Ganeti 1.2
 137           version (but will only create one disk).
 138         </para>
 139
 140         <para>
 141           The minimum disk specification is therefore
 142           <userinput>--disk 0:size=20G</userinput> (or <userinput>-s
 143           20G</userinput> when using the <option>-s</option> option),
 144           and a three-disk instance can be specified as
 145           <userinput>--disk 0:size=20G --disk 1:size=4G --disk
 146           2:size=100G</userinput>.
 147         </para>
 148
 149         <para>
 150           The NICs of the instances can be specified via the
 151           <option>--nic</option> option. By default, one NIC is
 152           created for the instance, with a random MAC, and connected
 153           to the default bridge. Each NIC can take up to three
 154           parameters (all optional):
 155           <variablelist>
 156             <varlistentry>
 157               <term>mac</term>
 158               <listitem>
 159                 <simpara>either a value or <constant>GENERATE</constant>
 160                   to generate a new unique MAC</simpara>
 161               </listitem>
 162             </varlistentry>
 163             <varlistentry>
 164               <term>ip</term>
 165               <listitem>
 166                 <simpara>specifies the IP address assigned to the
 167                   instance from the Ganeti side (this is not necessarily
 168                   what the instance will use, but what the node expects
 169                   the instance to use)</simpara>
 170               </listitem>
 171             </varlistentry>
 172             <varlistentry>
 173               <term>bridge</term>
 174               <listitem>
 175                 <simpara>specifies the bridge to attach this NIC
 176                   to</simpara>
 177               </listitem>
 178             </varlistentry>
 179           </variablelist>
 180         </para>
 181
 182         <para>
 183           Alternatively, if no network is desired for the instance, you
 184           can prevent the default of one NIC with the
 185           <option>--no-nics</option> option.
 186         </para>
 187
 188         <para>
 189           The <option>-o</option> options specifies the operating
 190           system to be installed. The available operating systems can
 191           be listed with <command>gnt-os list</command>.
 192         </para>
 193
 194         <para>
 195           The <option>-B</option> option specifies the backend
 196           parameters for the instance. If no such parameters are
 197           specified, the values are inherited from the cluster. Possible
 198           parameters are:
 199           <variablelist>
 200             <varlistentry>
 201               <term>memory</term>
 202               <listitem>
 203                 <simpara>the memory size of the instance; as usual,
 204                   suffixes can be used to denote the unit, otherwise the
 205                   value is taken in mebibites</simpara>
 206               </listitem>
 207             </varlistentry>
 208             <varlistentry>
 209               <term>vcpus</term>
 210               <listitem>
 211                 <simpara>the number of VCPUs to assign to the instance
 212                   (if this value makes sense for the hypervisor)</simpara>
 213               </listitem>
 214             </varlistentry>
 215             <varlistentry>
 216               <term>auto_balance</term>
 217               <listitem>
 218                 <simpara>whether the instance is considered in the N+1
 219                   cluster checks (enough redundancy in the cluster to
 220                   survive a node failure)</simpara>
 221               </listitem>
 222             </varlistentry>
 223           </variablelist>
 224         </para>
 225
 226         <para>
 227           The <option>-H</option> option specified the hypervisor to
 228           use for the instance (must be one of the enabled hypervisors
 229           on the cluster) and optionally custom parameters for this
 230           instance. If not other options are used (i.e. the invocation
 231           is just <userinput>-H
 232           <replaceable>NAME</replaceable></userinput>) the instance
 233           will inherit the cluster options. The defaults below show
 234           the cluster defaults at cluster creation time.
 235         </para>
 236
 237         <para>
 238           The possible hypervisor options are as follows:
 239           <variablelist>
 240             <varlistentry>
 241               <term>boot_order</term>
 242               <listitem>
 243                 <simpara>Valid for the Xen HVM and KVM
 244                 hypervisors.</simpara>
 245
 246                 <simpara>A string value denoting the boot order. This
 247                 has different meaning for the Xen HVM hypervisor and
 248                 for the KVM one.</simpara>
 249
 250                 <simpara>
 251                   For Xen HVM, The boot order is a string of letters
 252                   listing the boot devices, with valid device letters
 253                   being:
 254                 </simpara>
 255                   <variablelist>
 256                     <varlistentry>
 257                       <term>a</term>
 258                       <listitem>
 259                         <para>
 260                           floppy drive
 261                         </para>
 262                       </listitem>
 263                     </varlistentry>
 264                     <varlistentry>
 265                       <term>c</term>
 266                       <listitem>
 267                         <para>
 268                           hard disk
 269                         </para>
 270                       </listitem>
 271                     </varlistentry>
 272                     <varlistentry>
 273                       <term>d</term>
 274                       <listitem>
 275                         <para>
 276                           CDROM drive
 277                         </para>
 278                       </listitem>
 279                     </varlistentry>
 280                     <varlistentry>
 281                       <term>n</term>
 282                       <listitem>
 283                         <para>
 284                           network boot (PXE)
 285                         </para>
 286                       </listitem>
 287                     </varlistentry>
 288                   </variablelist>
 289                 <simpara>
 290                   The default is not to set an HVM boot order which is
 291                   interpreted as 'dc'.
 292                 </simpara>
 293
 294               </listitem>
 295             </varlistentry>
 296             <varlistentry>
 297               <term>cdrom_image_path</term>
 298               <listitem>
 299                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 300
 301                 <simpara>The path to a CDROM image to attach to the
 302                 instance.</simpara>
 303
 304               </listitem>
 305             </varlistentry>
 306             <varlistentry>
 307               <term>nic_type</term>
 308               <listitem>
 309                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 310
 311                 <para>
 312                   This parameter determines the way the network cards
 313                   are presented to the instance. The possible options are:
 314                   <simplelist>
 315                     <member>rtl8139 (default for Xen HVM) (HVM & KVM)</member>
 316                     <member>ne2k_isa (HVM & KVM)</member>
 317                     <member>ne2k_pci (HVM & KVM)</member>
 318                     <member>i82551 (KVM)</member>
 319                     <member>i82557b (KVM)</member>
 320                     <member>i82559er (KVM)</member>
 321                     <member>pcnet (KVM)</member>
 322                     <member>e1000 (KVM)</member>
 323                     <member>paravirtual (default for KVM) (HVM & KVM)</member>
 324                   </simplelist>
 325                 </para>
 326               </listitem>
 327             </varlistentry>
 328             <varlistentry>
 329               <term>disk_type</term>
 330               <listitem>
 331                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 332
 333                 <para>
 334                   This parameter determines the way the disks are
 335                   presented to the instance. The possible options are:
 336                   <simplelist>
 337                     <member>ioemu (default for HVM & KVM) (HVM & KVM)</member>
 338                     <member>ide (HVM & KVM)</member>
 339                     <member>scsi (KVM)</member>
 340                     <member>sd (KVM)</member>
 341                     <member>mtd (KVM)</member>
 342                     <member>pflash (KVM)</member>
 343                   </simplelist>
 344                 </para>
 345               </listitem>
 346             </varlistentry>
 347             <varlistentry>
 348               <term>vnc_bind_address</term>
 349               <listitem>
 350                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 351
 352                 <para>Specifies the address that the VNC listener for
 353                 this instance should bind to. Valid values are IPv4
 354                 addresses. Use the address 0.0.0.0 to bind to all
 355                 available interfaces (this is the default) or specify
 356                 the address of one of the interfaces on the node to
 357                 restrict listening to that interface.</para>
 358               </listitem>
 359             </varlistentry>
 360
 361             <varlistentry>
 362               <term>vnc_tls</term>
 363               <listitem>
 364                 <simpara>Valid for the KVM hypervisor.</simpara>
 365
 366                 <simpara>A boolean option that controls whether the
 367                 VNC connection is secured with TLS.</simpara>
 368               </listitem>
 369             </varlistentry>
 370
 371             <varlistentry>
 372               <term>vnc_x509_path</term>
 373               <listitem>
 374                 <simpara>Valid for the KVM hypervisor.</simpara>
 375
 376                 <para>If <option>vnc_tls</option> is enabled, this
 377                 options specifies the path to the x509 certificate to
 378                 use.</para>
 379               </listitem>
 380             </varlistentry>
 381
 382             <varlistentry>
 383               <term>vnc_x509_verify</term>
 384               <listitem>
 385                 <simpara>Valid for the KVM hypervisor.</simpara>
 386               </listitem>
 387             </varlistentry>
 388
 389             <varlistentry>
 390               <term>acpi</term>
 391               <listitem>
 392                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 393
 394                 <para>
 395                   A boolean option that specifies if the hypervisor
 396                   should enable ACPI support for this instance. By
 397                   default, ACPI is disabled.
 398                 </para>
 399               </listitem>
 400             </varlistentry>
 401
 402             <varlistentry>
 403               <term>pae</term>
 404               <listitem>
 405                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 406
 407                 <para>
 408                   A boolean option that specifies if the hypervisor
 409                   should enabled PAE support for this instance. The
 410                   default is false, disabling PAE support.
 411                 </para>
 412               </listitem>
 413             </varlistentry>
 414
 415             <varlistentry>
 416               <term>kernel_path</term>
 417               <listitem>
 418                 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
 419
 420                 <para>
 421                   This option specifies the path (on the node) to the
 422                   kernel to boot the instance with. Xen PVM instances
 423                   always require this, while for KVM if this option is
 424                   empty, it will cause the machine to load the kernel
 425                   from its disks.
 426                 </para>
 427               </listitem>
 428             </varlistentry>
 429
 430             <varlistentry>
 431               <term>kernel_args</term>
 432               <listitem>
 433                 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
 434
 435                 <para>
 436                   This options specifies extra arguments to the kernel
 437                   that will be loaded.  device. This is always used
 438                   for Xen PVM, while for KVM it is only used if the
 439                   <option>kernel_path</option> option is also
 440                   specified.
 441                 </para>
 442
 443                 <para>
 444                   The default setting for this value is simply
 445                   <constant>"ro"</constant>, which mounts the root
 446                   disk (initially) in read-only one. For example,
 447                   setting this to <userinput>single</userinput> will
 448                   cause the instance to start in single-user mode.
 449                 </para>
 450               </listitem>
 451             </varlistentry>
 452
 453             <varlistentry>
 454               <term>initrd_path</term>
 455               <listitem>
 456                 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
 457
 458                 <para>
 459                   This option specifies the path (on the node) to the
 460                   initrd to boot the instance with. Xen PVM instances
 461                   can use this always, while for KVM if this option is
 462                   only used if the <option>kernel_path</option> option
 463                   is also specified. You can pass here either an
 464                   absolute filename (the path to the initrd) if you
 465                   want to use an initrd, or use the format
 466                   <userinput>no_initrd_path</userinput> for no initrd.
 467                 </para>
 468               </listitem>
 469             </varlistentry>
 470
 471             <varlistentry>
 472               <term>root_path</term>
 473               <listitem>
 474                 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
 475
 476                 <para>
 477                   This options specifies the name of the root
 478                   device. This is always needed for Xen PVM, while for
 479                   KVM it is only used if the
 480                   <option>kernel_path</option> option is also
 481                   specified.
 482                 </para>
 483               </listitem>
 484             </varlistentry>
 485
 486             <varlistentry>
 487               <term>serial_console</term>
 488               <listitem>
 489                 <simpara>Valid for the KVM hypervisor.</simpara>
 490
 491                 <simpara>This boolean option specifies whether to
 492                 emulate a serial console for the instance.</simpara>
 493               </listitem>
 494             </varlistentry>
 495           </variablelist>
 496         </para>
 497
 498         <para>
 499         </para>
 500
 501         <para>
 502           The <option>--iallocator</option> option specifies the instance
 503           allocator plugin to use. If you pass in this option the allocator
 504           will select nodes for this instance automatically, so you don't need
 505           to pass them with the <option>-n</option> option. For more
 506           information please refer to the instance allocator documentation.
 507         </para>
 508
 509         <para>
 510           The <option>-t</option> options specifies the disk layout type for
 511           the instance. The available choices are:
 512           <variablelist>
 513             <varlistentry>
 514               <term>diskless</term>
 515               <listitem>
 516                 <para>
 517                   This creates an instance with no disks. Its useful for
 518                   testing only (or other special cases).
 519                 </para>
 520               </listitem>
 521             </varlistentry>
 522             <varlistentry>
 523               <term>file</term>
 524               <listitem>
 525                 <para>Disk devices will be regular files.</para>
 526               </listitem>
 527             </varlistentry>
 528             <varlistentry>
 529               <term>plain</term>
 530               <listitem>
 531                 <para>Disk devices will be logical volumes.</para>
 532               </listitem>
 533             </varlistentry>
 534             <varlistentry>
 535               <term>drbd</term>
 536               <listitem>
 537                 <para>
 538                   Disk devices will be drbd (version 8.x) on top of
 539                   lvm volumes.
 540                 </para>
 541               </listitem>
 542             </varlistentry>
 543           </variablelist>
 544         </para>
 545
 546         <para>
 547           The optional second value of the <option>--node</option> is used for
 548           the drbd template type and specifies the remote node.
 549         </para>
 550
 551         <para>
 552           If you do not want gnt-instance to wait for the disk mirror
 553           to be synced, use the <option>--no-wait-for-sync</option>
 554           option.
 555         </para>
 556
 557         <para>
 558           The <option>--file-storage-dir</option> specifies the relative path
 559           under the cluster-wide file storage directory to store file-based
 560           disks. It is useful for having different subdirectories for
 561           different instances. The full path of the directory where the disk
 562           files are stored will consist of cluster-wide file storage directory
 563           + optional subdirectory + instance name. Example:
 564           /srv/ganeti/file-storage/mysubdir/instance1.example.com. This option
 565           is only relevant for instances using the file storage backend.
 566         </para>
 567
 568         <para>
 569           The <option>--file-driver</option> specifies the driver to use for
 570           file-based disks. Note that currently these drivers work with the
 571           xen hypervisor only. This option is only relevant for instances using
 572           the file storage backend. The available choices are:
 573           <variablelist>
 574             <varlistentry>
 575               <term>loop</term>
 576               <listitem>
 577                 <para>
 578                   Kernel loopback driver. This driver uses loopback
 579                   devices to access the filesystem within the
 580                   file. However, running I/O intensive applications in
 581                   your instance using the loop driver might result in
 582                   slowdowns.  Furthermore, if you use the loopback
 583                   driver consider increasing the maximum amount of
 584                   loopback devices (on most systems it's 8) using the
 585                   max_loop param.
 586                 </para>
 587               </listitem>
 588             </varlistentry>
 589             <varlistentry>
 590               <term>blktap</term>
 591               <listitem>
 592                 <para>The blktap driver (for Xen hypervisors). In
 593                 order to be able to use the blktap driver you should
 594                 check if the 'blktapctrl' user space disk agent is
 595                 running (usually automatically started via xend). This
 596                 user-level disk I/O interface has the advantage of
 597                 better performance. Especially if you use a network
 598                 file system (e.g. NFS) to store your instances this is
 599                 the recommended choice.
 600                 </para>
 601               </listitem>
 602             </varlistentry>
 603           </variablelist>
 604         </para>
 605
 606         <para>
 607           The <option>--submit</option> option is used to send the job to
 608           the master daemon but not wait for its completion. The job
 609           ID will be shown so that it can be examined via
 610           <command>gnt-job info</command>.
 611         </para>
 612
 613         <para>
 614           Example:
 615           <screen>
 616 # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
 617   -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
 618 # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
 619   -n node1.example.com instance1.example.com
 620 # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
 621   -n node1.example.com:node2.example.com instance2.example.com
 622           </screen>
 623         </para>
 624       </refsect3>
 625
 626       <refsect3>
 627         <title>BATCH-CREATE</title>
 628         <cmdsynopsis>
 629           <command>batch-create</command>
 630           <arg choice="req">instances_file.json</arg>
 631         </cmdsynopsis>
 632
 633         <para>
 634           This command (similar to the Ganeti 1.2
 635           <command>batcher</command> tool) submits multiple instance
 636           creation jobs based on a definition file. The instance
 637           configurations do not encompass all the possible options for
 638           the <command>add</command> command, but only a subset.
 639         </para>
 640
 641         <para>
 642           The instance file should be a valid-formed JSON file,
 643           containing a dictionary with instance name and instance
 644           parameters. The accepted parameters are:
 645
 646           <variablelist>
 647             <varlistentry>
 648               <term>disk_size</term>
 649               <listitem>
 650                 <simpara>The size of the disks of the instance.</simpara>
 651               </listitem>
 652             </varlistentry>
 653             <varlistentry>
 654               <term>disk_templace</term>
 655               <listitem>
 656                 <simpara>The disk template to use for the instance,
 657                 the same as in the <command>add</command>
 658                 command.</simpara>
 659               </listitem>
 660             </varlistentry>
 661             <varlistentry>
 662               <term>backend</term>
 663               <listitem>
 664                 <simpara>A dictionary of backend parameters.</simpara>
 665               </listitem>
 666             </varlistentry>
 667             <varlistentry>
 668               <term>hypervisor</term>
 669               <listitem>
 670                 <simpara>A dictionary with a single key (the
 671                 hypervisor name), and as value the hypervisor
 672                 options. If not passed, the default hypervisor and
 673                 hypervisor options will be inherited.</simpara>
 674               </listitem>
 675             </varlistentry>
 676             <varlistentry>
 677               <term>mac, ip, bridge</term>
 678               <listitem>
 679                 <simpara>Specifications for the one NIC that will be
 680                 created for the instance.</simpara>
 681               </listitem>
 682             </varlistentry>
 683             <varlistentry>
 684               <term>primary_node, secondary_node</term>
 685               <listitem>
 686                 <simpara>The primary and optionally the secondary node
 687                 to use for the instance (in case an iallocator script
 688                 is not used).</simpara>
 689               </listitem>
 690             </varlistentry>
 691             <varlistentry>
 692               <term>iallocator</term>
 693               <listitem>
 694                 <simpara>Instead of specifying the nodes, an
 695                 iallocator script can be used to automatically compute
 696                 them.</simpara>
 697               </listitem>
 698             </varlistentry>
 699             <varlistentry>
 700               <term>start</term>
 701               <listitem>
 702                 <simpara>whether to start the instance</simpara>
 703               </listitem>
 704             </varlistentry>
 705             <varlistentry>
 706               <term>ip_check</term>
 707               <listitem>
 708                 <simpara>Skip the check for already-in-use instance;
 709                 see the description in the <command>add</command>
 710                 command for details.</simpara>
 711               </listitem>
 712             </varlistentry>
 713             <varlistentry>
 714               <term>file_storage_dir, file_driver</term>
 715               <listitem>
 716                 <simpara>Configuration for the <literal>file</literal>
 717                 disk type, see the <command>add</command> command for
 718                 details.</simpara>
 719               </listitem>
 720             </varlistentry>
 721           </variablelist>
 722         </para>
 723
 724         <para>
 725           A simple definition for one instance can be (with most of
 726           the parameters taken from the cluster defaults):
 727           <screen>
 728 {
 729   "instance3": {
 730     "template": "drbd",
 731     "os": "debootstrap",
 732     "disk_size": ["25G"],
 733     "iallocator": "dumb"
 734   },
 735   "instance5": {
 736     "template": "drbd",
 737     "os": "debootstrap",
 738     "disk_size": ["25G"],
 739     "iallocator": "dumb",
 740     "hypervisor": "xen-hvm",
 741     "hvparams": {"acpi": true},
 742     "backend": {"memory": 512}
 743   }
 744 }
 745 </screen>
 746         </para>
 747
 748         <para>
 749           The command will display the job id for each submitted instance, as follows:
 750           <screen>
 751 # gnt-instance batch-create instances.json
 752 instance3: 11224
 753 instance5: 11225
 754 </screen>
 755         </para>
 756
 757       </refsect3>
 758
 759       <refsect3>
 760         <title>REMOVE</title>
 761
 762         <cmdsynopsis>
 763           <command>remove</command>
 764           <arg>--ignore-failures</arg>
 765           <arg>--submit</arg>
 766           <arg choice="req"><replaceable>instance</replaceable></arg>
 767         </cmdsynopsis>
 768
 769         <para>
 770           Remove an instance. This will remove all data from the
 771           instance and there is <emphasis>no way back</emphasis>. If
 772           you are not sure if you use an instance again, use
 773           <command>shutdown</command> first and leave it in the
 774           shutdown state for a while.
 775
 776         </para>
 777
 778         <para>
 779           The <option>--ignore-failures</option> option will cause the
 780           removal to proceed even in the presence of errors during the
 781           removal of the instance (e.g. during the shutdown or the
 782           disk removal). If this option is not given, the command will
 783           stop at the first error.
 784         </para>
 785
 786         <para>
 787           The <option>--submit</option> option is used to send the job to
 788           the master daemon but not wait for its completion. The job
 789           ID will be shown so that it can be examined via
 790           <command>gnt-job info</command>.
 791         </para>
 792
 793         <para>
 794           Example:
 795           <screen>
 796 # gnt-instance remove instance1.example.com
 797           </screen>
 798         </para>
 799       </refsect3>
 800
 801       <refsect3>
 802         <title>LIST</title>
 803
 804         <cmdsynopsis>
 805           <command>list</command>
 806           <arg>--no-headers</arg>
 807           <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
 808           <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
 809           <arg rep="repeat">instance</arg>
 810         </cmdsynopsis>
 811
 812         <para>
 813           Shows the currently configured instances with memory usage,
 814           disk usage, the node they are running on, and their run
 815           status.
 816         </para>
 817
 818         <para>
 819           The <option>--no-headers</option> option will skip the
 820           initial header line. The <option>--separator</option> option
 821           takes an argument which denotes what will be used between
 822           the output fields. Both these options are to help scripting.
 823         </para>
 824
 825         <para>
 826           The <option>-o</option> option takes a comma-separated list
 827           of output fields. The available fields and their meaning
 828           are:
 829           <variablelist>
 830             <varlistentry>
 831               <term>name</term>
 832               <listitem>
 833                 <simpara>the instance name</simpara>
 834               </listitem>
 835             </varlistentry>
 836             <varlistentry>
 837               <term>os</term>
 838               <listitem>
 839                 <simpara>the OS of the instance</simpara>
 840               </listitem>
 841             </varlistentry>
 842             <varlistentry>
 843               <term>pnode</term>
 844               <listitem>
 845                 <simpara>the primary node of the instance</simpara>
 846               </listitem>
 847             </varlistentry>
 848             <varlistentry>
 849               <term>snodes</term>
 850               <listitem>
 851                 <simpara>comma-separated list of secondary nodes for the
 852                   instance; usually this will be just one node</simpara>
 853               </listitem>
 854             </varlistentry>
 855             <varlistentry>
 856               <term>admin_state</term>
 857               <listitem>
 858                 <simpara>the desired state of the instance (either "yes"
 859                   or "no" denoting the instance should run or
 860                   not)</simpara>
 861               </listitem>
 862             </varlistentry>
 863             <varlistentry>
 864               <term>disk_template</term>
 865               <listitem>
 866                 <simpara>the disk template of the instance</simpara>
 867               </listitem>
 868             </varlistentry>
 869             <varlistentry>
 870               <term>oper_state</term>
 871               <listitem>
 872                 <simpara>the actual state of the instance; can be
 873                 one of the values "running", "stopped", "(node
 874                 down)"</simpara>
 875               </listitem>
 876             </varlistentry>
 877             <varlistentry>
 878               <term>status</term>
 879               <listitem>
 880                 <simpara>combined form of admin_state and oper_stat;
 881                 this can be one of:
 882                 <computeroutput>ERROR_nodedown</computeroutput> if the
 883                 node of the instance is down,
 884                 <computeroutput>ERROR_down</computeroutput> if the
 885                 instance should run but is down,
 886                 <computeroutput>ERROR_up</computeroutput> if the
 887                 instance should be stopped but is actually running,
 888                 <computeroutput>ADMIN_down</computeroutput> if the
 889                 instance has been stopped (and is stopped) and
 890                 <computeroutput>running</computeroutput> if the
 891                 instance is set to be running (and is
 892                 running)</simpara>
 893               </listitem>
 894             </varlistentry>
 895             <varlistentry>
 896               <term>oper_ram</term>
 897               <listitem>
 898                 <simpara>the actual memory usage of the instance as seen
 899                   by the hypervisor</simpara>
 900               </listitem>
 901             </varlistentry>
 902             <varlistentry>
 903               <term>ip</term>
 904               <listitem>
 905                 <simpara>the ip address ganeti recognizes as associated with
 906                 the first instance interface</simpara>
 907               </listitem>
 908             </varlistentry>
 909             <varlistentry>
 910               <term>mac</term>
 911               <listitem>
 912                 <simpara>the first instance interface MAC address</simpara>
 913               </listitem>
 914             </varlistentry>
 915             <varlistentry>
 916               <term>bridge</term>
 917               <listitem>
 918                 <simpara>the bridge of the first instance NIC
 919                 </simpara>
 920               </listitem>
 921             </varlistentry>
 922             <varlistentry>
 923               <term>sda_size</term>
 924               <listitem>
 925                 <simpara>the size of the instance's first disk</simpara>
 926               </listitem>
 927             </varlistentry>
 928             <varlistentry>
 929               <term>sdb_size</term>
 930               <listitem>
 931                 <simpara>the size of the instance's second disk, if
 932                 any</simpara>
 933               </listitem>
 934             </varlistentry>
 935             <varlistentry>
 936               <term>vcpus</term>
 937               <listitem>
 938                 <simpara>the number of VCPUs allocated to the
 939                 instance</simpara>
 940               </listitem>
 941             </varlistentry>
 942             <varlistentry>
 943               <term>tags</term>
 944               <listitem>
 945                 <simpara>comma-separated list of the instances's
 946                 tags</simpara>
 947               </listitem>
 948             </varlistentry>
 949             <varlistentry>
 950               <term>serial_no</term>
 951               <listitem>
 952                 <simpara>the so called 'serial number' of the
 953                 instance; this is a numeric field that is incremented
 954                 each time the instance is modified, and it can be used
 955                 to track modifications</simpara>
 956               </listitem>
 957             </varlistentry>
 958             <varlistentry>
 959               <term>network_port</term>
 960               <listitem>
 961                 <simpara>If the instance has a network port assigned
 962                 to it (e.g. for VNC connections), this will be shown,
 963                 otherwise <literal>-</literal> will be
 964                 displayed.</simpara>
 965               </listitem>
 966             </varlistentry>
 967             <varlistentry>
 968               <term>beparams</term>
 969               <listitem>
 970                 <simpara>A text format of the entire beparams for the
 971                 instance. It's more useful to select individual fields
 972                 from this dictionary, see below.</simpara>
 973               </listitem>
 974             </varlistentry>
 975             <varlistentry>
 976               <term>disk.count</term>
 977               <listitem>
 978                 <simpara>The number of instance disks.</simpara>
 979               </listitem>
 980             </varlistentry>
 981             <varlistentry>
 982               <term>disk.size/N</term>
 983               <listitem>
 984                 <simpara>The size of the instance's Nth disk. This is
 985                 a more generic form of the <literal>sda_size</literal>
 986                 and <literal>sdb_size</literal> fields.</simpara>
 987               </listitem>
 988             </varlistentry>
 989             <varlistentry>
 990               <term>disk.sizes</term>
 991               <listitem>
 992                 <simpara>A comma-separated list of the disk sizes for
 993                 this instance.</simpara>
 994               </listitem>
 995             </varlistentry>
 996             <varlistentry>
 997               <term>disk_usage</term>
 998               <listitem>
 999                 <simpara>The total disk space used by this instance on
1000                 each of its nodes. This is not the instance-visible
1001                 disk size, but the actual disk "cost" of the
1002                 instance.</simpara>
1003               </listitem>
1004             </varlistentry>
1005             <varlistentry>
1006               <term>nic.mac/N</term>
1007               <listitem>
1008                 <simpara>The MAC of the Nth instance NIC.</simpara>
1009               </listitem>
1010             </varlistentry>
1011             <varlistentry>
1012               <term>nic.ip/N</term>
1013               <listitem>
1014                 <simpara>The IP address of the Nth instance NIC.</simpara>
1015               </listitem>
1016             </varlistentry>
1017             <varlistentry>
1018               <term>nic.bridge/N</term>
1019               <listitem>
1020                 <simpara>The bridge the Nth instance NIC is attached
1021                 to.</simpara>
1022               </listitem>
1023             </varlistentry>
1024             <varlistentry>
1025               <term>nic.macs</term>
1026               <listitem>
1027                 <simpara>A comma-separated list of all the MACs of the
1028                 instance's NICs.</simpara>
1029               </listitem>
1030             </varlistentry>
1031             <varlistentry>
1032               <term>nic.ips</term>
1033               <listitem>
1034                 <simpara>A comma-separated list of all the IP
1035                 addresses of the instance's NICs.</simpara>
1036               </listitem>
1037             </varlistentry>
1038             <varlistentry>
1039               <term>nic.bridges</term>
1040               <listitem>
1041                 <simpara>A comma-separated list of all the bridges of the
1042                 instance's NICs.</simpara>
1043               </listitem>
1044             </varlistentry>
1045             <varlistentry>
1046               <term>nic.count</term>
1047               <listitem>
1048                 <simpara>The number of instance nics.</simpara>
1049               </listitem>
1050             </varlistentry>
1051             <varlistentry>
1052               <term>hv/<replaceable>NAME</replaceable></term>
1053               <listitem>
1054                 <simpara>The value of the hypervisor parameter called
1055                 <replaceable>NAME</replaceable>. For details of what
1056                 hypervisor parameters exist and their meaning, see the
1057                 <command>add</command> command.</simpara>
1058               </listitem>
1059             </varlistentry>
1060             <varlistentry>
1061               <term>be/memory</term>
1062               <listitem>
1063                 <simpara>The configured memory for the instance.</simpara>
1064               </listitem>
1065             </varlistentry>
1066             <varlistentry>
1067               <term>be/vcpus</term>
1068               <listitem>
1069                 <simpara>The configured number of VCPUs for the
1070                 instance.</simpara>
1071               </listitem>
1072             </varlistentry>
1073             <varlistentry>
1074               <term>be/auto_balance</term>
1075               <listitem>
1076                 <simpara>Whether the instance is considered in N+1
1077                 checks.</simpara>
1078               </listitem>
1079             </varlistentry>
1080           </variablelist>
1081         </para>
1082
1083         <para>
1084           If the value of the option starts with the character
1085           <constant>+</constant>, the new field(s) will be added to the
1086           default list. This allows to quickly see the default list
1087           plus a few other fields, instead of retyping the entire list
1088           of fields.
1089         </para>
1090
1091         <para>
1092           There is a subtle grouping about the available output
1093           fields: all fields except for <option>oper_state</option>,
1094           <option>oper_ram</option> and <option>status</option> are
1095           configuration value and not run-time values. So if you don't
1096           select any of the these fields, the query will be satisfied
1097           instantly from the cluster configuration, without having to
1098           ask the remote nodes for the data. This can be helpful for
1099           big clusters when you only want some data and it makes sense
1100           to specify a reduced set of output fields.
1101         </para>
1102
1103         <para>The default output field list is:
1104           <simplelist type="inline">
1105             <member>name</member>
1106             <member>os</member>
1107             <member>pnode</member>
1108             <member>admin_state</member>
1109             <member>oper_state</member>
1110             <member>oper_ram</member>
1111           </simplelist>.
1112         </para>
1113       </refsect3>
1114
1115       <refsect3>
1116         <title>INFO</title>
1117
1118         <cmdsynopsis>
1119           <command>info</command>
1120           <group>
1121             <arg>-s</arg>
1122             <arg>--static</arg>
1123           </group>
1124           <group choice="req">
1125             <arg>--all</arg>
1126             <arg rep="repeat"><replaceable>instance</replaceable></arg>
1127           </group>
1128         </cmdsynopsis>
1129
1130         <para>
1131           Show detailed information about the given instance(s). This is
1132           different from <command>list</command> as it shows detailed data
1133           about the instance's disks (especially useful for the drbd disk
1134           template).
1135         </para>
1136
1137         <para>
1138           If the option <option>-s</option> is used, only information
1139           available in the configuration file is returned, without
1140           querying nodes, making the operation faster.
1141         </para>
1142
1143         <para>
1144           Use the <option>--all</option> to get info about all instances,
1145           rather than explicitely passing the ones you're interested in.
1146         </para>
1147       </refsect3>
1148
1149       <refsect3>
1150         <title>MODIFY</title>
1151
1152         <cmdsynopsis>
1153           <command>modify</command>
1154           <sbr>
1155           <arg choice="opt">-H <replaceable>HYPERVISOR_PARAMETERS</replaceable></arg>
1156           <sbr>
1157           <arg choice="opt">-B <replaceable>BACKEND_PARAMETERS</replaceable></arg>
1158           <sbr>
1159           <group>
1160             <arg>--net add<replaceable><optional>:options</optional></replaceable></arg>
1161             <arg>--net remove</arg>
1162             <arg>--net <replaceable>N:options</replaceable></arg>
1163           </group>
1164           <sbr>
1165           <group>
1166             <arg>--disk add:size=<replaceable>SIZE</replaceable></arg>
1167             <arg>--disk remove</arg>
1168             <arg>--disk <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></arg>
1169           </group>
1170
1171           <sbr>
1172           <arg>--submit</arg>
1173           <sbr>
1174           <arg choice="req"><replaceable>instance</replaceable></arg>
1175         </cmdsynopsis>
1176
1177         <para>
1178           Modifies the memory size, number of vcpus, ip address, MAC
1179           address and/or bridge for an instance. It can also add and
1180           remove disks and NICs to/from the instance. Note that you
1181           need to give at least one of the arguments, otherwise the
1182           command complains.
1183         </para>
1184
1185         <para>
1186           The <option>-H</option> option specifies hypervisor options
1187           in the form of <userinput>name=value[,...]</userinput>. For details which options can be specified, see the <command>add</command> command.
1188         </para>
1189
1190         <para>
1191           The <option>--disk
1192           add:size=<replaceable>SIZE</replaceable></option> option
1193           adds a disk to the instance. The <option>--disk
1194           remove</option> will remove the last disk of the
1195           instance. The <option>--disk
1196           <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></option>
1197           option will change the mode of the Nth disk of the instance
1198           between read-only (<literal>ro</literal>) and read-write
1199           (<literal>rw</literal>).
1200         </para>
1201
1202         <para>
1203           The <option>--nic
1204           add:<replaceable>options</replaceable></option> option will
1205           add a new NIC to the instance. The available options are the
1206           same as in the <command>add</command> command (mac, ip,
1207           bridge). The <option>--nice remove</option> will remove the
1208           last NIC of the instance, while the <option>--nic
1209           <replaceable>N</replaceable>:<replaceable>options</replaceable></option>
1210           option will change the parameters of the Nth instance NIC.
1211         </para>
1212
1213         <para>
1214           The <option>--submit</option> option is used to send the job to
1215           the master daemon but not wait for its completion. The job
1216           ID will be shown so that it can be examined via
1217           <command>gnt-job info</command>.
1218         </para>
1219
1220         <para>
1221           All the changes take effect at the next restart. If the
1222           instance is running, there is no effect on the instance.
1223         </para>
1224       </refsect3>
1225
1226       <refsect3>
1227         <title>REINSTALL</title>
1228
1229         <cmdsynopsis>
1230           <command>reinstall</command>
1231           <arg choice="opt">-o <replaceable>os-type</replaceable></arg>
1232           <arg choice="opt">-f <replaceable>force</replaceable></arg>
1233           <arg>--select-os</arg>
1234           <arg>--submit</arg>
1235           <arg choice="req"><replaceable>instance</replaceable></arg>
1236         </cmdsynopsis>
1237
1238         <para>
1239           Reinstalls the operating system on the given instance. The
1240           instance must be stopped when running this command. If the
1241           <option>--os-type</option> is specified, the operating
1242           system is changed.
1243         </para>
1244
1245         <para>
1246           Since reinstall is potentially dangerous command, the user
1247           will be required to confirm this action, unless the
1248           <option>-f</option> flag is passed.
1249         </para>
1250
1251         <para>
1252           The <option>--select-os</option> option switches to an
1253           interactive OS reinstall. The user is prompted to select the OS
1254           template from the list of available OS templates.
1255         </para>
1256
1257         <para>
1258           The <option>--submit</option> option is used to send the job to
1259           the master daemon but not wait for its completion. The job
1260           ID will be shown so that it can be examined via
1261           <command>gnt-job info</command>.
1262         </para>
1263
1264
1265       </refsect3>
1266
1267       <refsect3>
1268         <title>RENAME</title>
1269
1270         <cmdsynopsis>
1271           <command>rename</command>
1272           <arg>--no-ip-check</arg>
1273           <arg>--submit</arg>
1274           <arg choice="req"><replaceable>instance</replaceable></arg>
1275           <arg choice="req"><replaceable>new_name</replaceable></arg>
1276         </cmdsynopsis>
1277
1278         <para>
1279           Renames the given instance. The instance must be stopped
1280           when running this command. The requirements for the new name
1281           are the same as for adding an instance: the new name must be
1282           resolvable and the IP it resolves to must not be reachable
1283           (in order to prevent duplicate IPs the next time the
1284           instance is started). The IP test can be skipped if the
1285           <option>--no-ip-check</option> option is passed.
1286         </para>
1287
1288         <para>
1289           The <option>--submit</option> option is used to send the job to
1290           the master daemon but not wait for its completion. The job
1291           ID will be shown so that it can be examined via
1292           <command>gnt-job info</command>.
1293         </para>
1294
1295       </refsect3>
1296
1297     </refsect2>
1298
1299     <refsect2>
1300       <title>Starting/stopping/connecting to console</title>
1301
1302       <refsect3>
1303         <title>STARTUP</title>
1304
1305         <cmdsynopsis>
1306           <command>startup</command>
1307           <sbr>
1308           <arg>--force</arg>
1309           <sbr>
1310           <arg>--force-multiple</arg>
1311           <sbr>
1312           <group choice="opt">
1313             <arg>--instance</arg>
1314             <arg>--node</arg>
1315             <arg>--primary</arg>
1316             <arg>--secondary</arg>
1317             <arg>--all</arg>
1318           </group>
1319           <sbr>
1320           <arg>--submit</arg>
1321           <sbr>
1322           <arg choice="opt"
1323           rep="repeat"><replaceable>name</replaceable></arg>
1324         </cmdsynopsis>
1325
1326         <para>
1327           Starts one or more instances, depending on the following
1328           options. The four available modes are:
1329           <variablelist>
1330             <varlistentry>
1331               <term><option>--instance</option></term>
1332               <listitem>
1333                 <simpara>will start the instances given as arguments
1334                 (at least one argument required); this is the default
1335                 selection</simpara>
1336               </listitem>
1337             </varlistentry>
1338             <varlistentry>
1339               <term>--node</term>
1340               <listitem>
1341                 <simpara>will start the instances who have the given
1342                 node as either primary or secondary</simpara>
1343               </listitem>
1344             </varlistentry>
1345             <varlistentry>
1346               <term><option>--primary</option></term>
1347               <listitem>
1348                 <simpara>will start all instances whose primary node
1349                 is in the list of nodes passed as arguments (at least
1350                 one node required)</simpara>
1351               </listitem>
1352             </varlistentry>
1353             <varlistentry>
1354               <term><option>--secondary</option></term>
1355               <listitem>
1356                 <simpara>will start all instances whose secondary node
1357                 is in the list of nodes passed as arguments (at least
1358                 one node required)</simpara>
1359               </listitem>
1360             </varlistentry>
1361             <varlistentry>
1362               <term>--all</term>
1363               <listitem>
1364                 <simpara>will start all instances in the cluster (no
1365                 arguments accepted)</simpara>
1366               </listitem>
1367             </varlistentry>
1368           </variablelist>
1369         </para>
1370
1371         <para>
1372           Note that although you can pass more than one selection
1373           option, the last one wins, so in order to guarantee the
1374           desired result, don't pass more than one such option.
1375         </para>
1376
1377         <para>
1378           Use <option>--force</option> to start even if secondary disks are
1379           failing.
1380         </para>
1381
1382         <para>
1383           The <option>--force-multiple</option> will skip the
1384           interactive confirmation in the case the more than one
1385           instance will be affected.
1386         </para>
1387
1388         <para>
1389           The <option>--submit</option> option is used to send the job to
1390           the master daemon but not wait for its completion. The job
1391           ID will be shown so that it can be examined via
1392           <command>gnt-job info</command>.
1393         </para>
1394
1395         <para>
1396           Example:
1397           <screen>
1398 # gnt-instance start instance1.example.com
1399 # gnt-instance start --node node1.example.com node2.example.com
1400 # gnt-instance start --all
1401           </screen>
1402         </para>
1403       </refsect3>
1404
1405       <refsect3>
1406         <title>SHUTDOWN</title>
1407
1408         <cmdsynopsis>
1409           <command>shutdown</command>
1410           <sbr>
1411           <arg>--force-multiple</arg>
1412           <sbr>
1413           <group choice="opt">
1414             <arg>--instance</arg>
1415             <arg>--node</arg>
1416             <arg>--primary</arg>
1417             <arg>--secondary</arg>
1418             <arg>--all</arg>
1419           </group>
1420           <sbr>
1421           <arg>--submit</arg>
1422           <sbr>
1423           <arg choice="opt"
1424           rep="repeat"><replaceable>name</replaceable></arg>
1425         </cmdsynopsis>
1426
1427         <para>
1428           Stops one or more instances. If the instance cannot be
1429           cleanly stopped during a hardcoded interval (currently 2
1430           minutes), it will forcibly stop the instance (equivalent to
1431           switching off the power on a physical machine).
1432         </para>
1433
1434         <para>
1435           The <option>--instance</option>, <option>--node</option>,
1436           <option>--primary</option>, <option>--secondary</option> and
1437           <option>--all</option> options are similar as for the
1438           <command>startup</command> command and they influence the
1439           actual instances being shutdown.
1440         </para>
1441
1442         <para>
1443           The <option>--submit</option> option is used to send the job to
1444           the master daemon but not wait for its completion. The job
1445           ID will be shown so that it can be examined via
1446           <command>gnt-job info</command>.
1447         </para>
1448
1449
1450         <para>
1451           Example:
1452           <screen>
1453 # gnt-instance shutdown instance1.example.com
1454 # gnt-instance shutdown --all
1455           </screen>
1456         </para>
1457       </refsect3>
1458
1459       <refsect3>
1460         <title>REBOOT</title>
1461
1462         <cmdsynopsis>
1463           <command>reboot</command>
1464           <sbr>
1465           <arg>--type=<replaceable>REBOOT-TYPE</replaceable></arg>
1466           <sbr>
1467           <arg>--ignore-secondaries</arg>
1468           <sbr>
1469           <arg>--force-multiple</arg>
1470           <sbr>
1471           <group choice="opt">
1472             <arg>--instance</arg>
1473             <arg>--node</arg>
1474             <arg>--primary</arg>
1475             <arg>--secondary</arg>
1476             <arg>--all</arg>
1477           </group>
1478           <sbr>
1479           <arg>--submit</arg>
1480           <sbr>
1481           <arg choice="opt"
1482           rep="repeat"><replaceable>name</replaceable></arg>
1483         </cmdsynopsis>
1484
1485         <para>
1486           Reboots one or more instances. The type of reboot depends on
1487           the value of <option>--type</option>. A soft reboot does a
1488           hypervisor reboot, a hard reboot does a instance stop,
1489           recreates the hypervisor config for the instance and
1490           starts the instance. A full reboot does the equivalent
1491           of <command>gnt-instance shutdown &amp;&amp; gnt-instance
1492           startup</command>. The default is hard reboot.
1493         </para>
1494
1495         <para>
1496           For the hard reboot the option
1497           <option>--ignore-secondaries</option> ignores errors for the
1498           secondary node while re-assembling the instance disks.
1499         </para>
1500
1501         <para>
1502           The <option>--instance</option>, <option>--node</option>,
1503           <option>--primary</option>, <option>--secondary</option> and
1504           <option>--all</option> options are similar as for the
1505           <command>startup</command> command and they influence the
1506           actual instances being rebooted.
1507         </para>
1508
1509         <para>
1510           The <option>--force-multiple</option> will skip the
1511           interactive confirmation in the case the more than one
1512           instance will be affected.
1513         </para>
1514
1515         <para>
1516           Example:
1517           <screen>
1518 # gnt-instance reboot instance1.example.com
1519 # gnt-instance reboot --type=full instance1.example.com
1520           </screen>
1521         </para>
1522       </refsect3>
1523
1524       <refsect3>
1525         <title>CONSOLE</title>
1526         <cmdsynopsis>
1527           <command>console</command>
1528           <arg choice="opt">--show-cmd</arg>
1529           <arg choice="req"><replaceable>instance</replaceable></arg>
1530         </cmdsynopsis>
1531
1532         <para>
1533           Connects to the console of the given instance. If the
1534           instance is not up, an error is returned. Use the
1535           <option>--show-cmd</option> option to display the command
1536           instead of executing it.
1537         </para>
1538
1539         <para>
1540           For HVM instances, this will attempt to connect to the
1541           serial console of the instance. To connect to the
1542           virtualized "physical" console of a HVM instance, use a VNC
1543           client with the connection info from the
1544           <command>info</command> command.
1545         </para>
1546
1547         <para>
1548           Example:
1549           <screen>
1550 # gnt-instance console instance1.example.com
1551           </screen>
1552         </para>
1553       </refsect3>
1554
1555     </refsect2>
1556
1557     <refsect2>
1558       <title>Disk management</title>
1559
1560       <refsect3>
1561         <title>REPLACE-DISKS</title>
1562
1563         <cmdsynopsis>
1564           <command>replace-disks</command>
1565           <arg>--submit</arg>
1566           <arg choice="req">-p</arg>
1567           <arg>--disks <replaceable>idx</replaceable></arg>
1568           <arg choice="req"><replaceable>instance</replaceable></arg>
1569         </cmdsynopsis>
1570
1571         <cmdsynopsis>
1572           <command>replace-disks</command>
1573           <arg>--submit</arg>
1574           <arg choice="req">-s</arg>
1575           <arg>--disks <replaceable>idx</replaceable></arg>
1576           <arg choice="req"><replaceable>instance</replaceable></arg>
1577         </cmdsynopsis>
1578
1579         <cmdsynopsis>
1580           <command>replace-disks</command>
1581           <arg>--submit</arg>
1582           <group choice="req">
1583             <arg>--iallocator <replaceable>name</replaceable></arg>
1584             <arg>--new-secondary <replaceable>NODE</replaceable></arg>
1585           </group>
1586
1587           <arg choice="req"><replaceable>instance</replaceable></arg>
1588         </cmdsynopsis>
1589
1590         <para>
1591           This command is a generalized form for replacing disks. It
1592           is currently only valid for the mirrored (DRBD) disk
1593           template.
1594         </para>
1595
1596         <para>
1597           The first form (when passing the <option>-p</option> option)
1598           will replace the disks on the primary, while the second form
1599           (when passing the <option>-s</option> option will replace
1600           the disks on the secondary node. For these two cases (as the
1601           node doesn't change), it is possible to only run the replace
1602           for a subset of the disks, using the option
1603           <option>--disks</option> which takes a list of
1604           comma-delimited disk indices (zero-based),
1605           e.g. <userinput>0,2</userinput> to replace only the first
1606           and third disks.
1607         </para>
1608
1609         <para>
1610           The third form (when passing either the
1611           <option>--iallocator</option> or the
1612           <option>--new-secondary</option> option) is designed to
1613           change secondary node of the instance.  Specifying
1614           <option>--iallocator</option> makes the new secondary be
1615           selected automatically by the specified allocator plugin,
1616           otherwise the new secondary node will be the one chosen
1617           manually via the <option>--new-secondary</option> option.
1618         </para>
1619
1620         <para>
1621           The <option>--submit</option> option is used to send the job to
1622           the master daemon but not wait for its completion. The job
1623           ID will be shown so that it can be examined via
1624           <command>gnt-job info</command>.
1625         </para>
1626
1627         <para>
1628           Note that it is not possible to select an offline or drained
1629           node as a new secondary.
1630         </para>
1631
1632       </refsect3>
1633
1634       <refsect3>
1635         <title>ACTIVATE-DISKS</title>
1636
1637         <cmdsynopsis>
1638           <command>activate-disks</command>
1639           <arg>--submit</arg>
1640           <arg choice="req"><replaceable>instance</replaceable></arg>
1641         </cmdsynopsis>
1642         <para>
1643           Activates the block devices of the given instance. If
1644           successful, the command will show the location and name of
1645           the block devices:
1646           <screen>
1647 node1.example.com:disk/0:/dev/drbd0
1648 node1.example.com:disk/1:/dev/drbd1
1649           </screen>
1650
1651           In this example, <emphasis>node1.example.com</emphasis> is
1652           the name of the node on which the devices have been
1653           activated. The <emphasis>disk/0</emphasis> and
1654           <emphasis>disk/1</emphasis> are the Ganeti-names of the
1655           instance disks; how they are visible inside the instance is
1656           hypervisor-specific. <emphasis>/dev/drbd0</emphasis> and
1657           <emphasis>/dev/drbd1</emphasis> are the actual block devices
1658           as visible on the node.
1659         </para>
1660
1661         <para>
1662           The <option>--submit</option> option is used to send the job to
1663           the master daemon but not wait for its completion. The job
1664           ID will be shown so that it can be examined via
1665           <command>gnt-job info</command>.
1666         </para>
1667
1668         <para>
1669           Note that it is safe to run this command while the instance
1670           is already running.
1671         </para>
1672       </refsect3>
1673
1674       <refsect3>
1675         <title>DEACTIVATE-DISKS</title>
1676
1677         <cmdsynopsis>
1678           <command>deactivate-disks</command>
1679           <arg>--submit</arg>
1680           <arg choice="req"><replaceable>instance</replaceable></arg>
1681         </cmdsynopsis>
1682         <para>
1683           De-activates the block devices of the given instance. Note
1684           that if you run this command for an instance with a drbd
1685           disk template, while it is running, it will not be able to
1686           shutdown the block devices on the primary node, but it will
1687           shutdown the block devices on the secondary nodes, thus
1688           breaking the replication.
1689         </para>
1690
1691         <para>
1692           The <option>--submit</option> option is used to send the job to
1693           the master daemon but not wait for its completion. The job
1694           ID will be shown so that it can be examined via
1695           <command>gnt-job info</command>.
1696         </para>
1697
1698       </refsect3>
1699
1700       <refsect3>
1701         <title>GROW-DISK</title>
1702         <cmdsynopsis>
1703           <command>grow-disk</command>
1704           <arg>--no-wait-for-sync</arg>
1705           <arg>--submit</arg>
1706           <arg choice="req"><replaceable>instance</replaceable></arg>
1707           <arg choice="req"><replaceable>disk</replaceable></arg>
1708           <arg choice="req"><replaceable>amount</replaceable></arg>
1709         </cmdsynopsis>
1710
1711         <para>
1712           Grows an instance's disk. This is only possible for
1713           instances having a <literal>plain</literal> or
1714           <literal>drbd</literal> disk template.
1715         </para>
1716
1717         <para>
1718           Note that this command only change the block device size; it
1719           will not grow the actual filesystems, partitions, etc. that
1720           live on that disk. Usually, you will need to:
1721           <orderedlist>
1722             <listitem>
1723               <simpara>use <command>gnt-instance grow-disk</command></simpara>
1724             </listitem>
1725             <listitem>
1726               <simpara>reboot the instance (later, at a convenient
1727               time)</simpara>
1728             </listitem>
1729             <listitem>
1730               <simpara>use a filesystem resizer, such as
1731               <citerefentry> <refentrytitle>ext2online</refentrytitle>
1732               <manvolnum>8</manvolnum> </citerefentry> or
1733               <citerefentry> <refentrytitle>xfs_growfs</refentrytitle>
1734               <manvolnum>8</manvolnum> </citerefentry> to resize the
1735               filesystem, or use <citerefentry>
1736               <refentrytitle>fdisk</refentrytitle>
1737               <manvolnum>8</manvolnum> </citerefentry> to change the
1738               partition table on the disk
1739               </simpara>
1740             </listitem>
1741           </orderedlist>
1742         </para>
1743
1744
1745         <para>
1746           The <replaceable>disk</replaceable> argument is the index of
1747           the instance disk to grow. The
1748           <replaceable>amount</replaceable> argument is given either
1749           as a number (and it represents the amount to increase the
1750           disk with in mebibytes) or can be given similar to the
1751           arguments in the create instance operation, with a suffix
1752           denoting the unit.
1753         </para>
1754
1755         <para>
1756           Note that the disk grow operation might complete on one node
1757           but fail on the other; this will leave the instance with
1758           different-sized LVs on the two nodes, but this will not
1759           create problems (except for unused space).
1760         </para>
1761
1762         <para>
1763           If you do not want gnt-instance to wait for the new disk
1764           region to be synced, use the
1765           <option>--no-wait-for-sync</option> option.
1766         </para>
1767
1768         <para>
1769           The <option>--submit</option> option is used to send the job to
1770           the master daemon but not wait for its completion. The job
1771           ID will be shown so that it can be examined via
1772           <command>gnt-job info</command>.
1773         </para>
1774
1775
1776         <para>Example (increase the first disk for instance1 by 16GiB):
1777           <screen>
1778 # gnt-instance grow-disk instance1.example.com 0 16g
1779           </screen>
1780         </para>
1781
1782         <para>
1783           Also note that disk shrinking is not supported; use
1784           <command>gnt-backup export</command> and then
1785           <command>gnt-backup import</command> to reduce the disk size
1786           of an instance.
1787         </para>
1788       </refsect3>
1789
1790     </refsect2>
1791
1792     <refsect2>
1793       <title>Recovery</title>
1794
1795       <refsect3>
1796         <title>FAILOVER</title>
1797
1798         <cmdsynopsis>
1799           <command>failover</command>
1800           <arg>-f</arg>
1801           <arg>--ignore-consistency</arg>
1802           <arg>--submit</arg>
1803           <arg choice="req"><replaceable>instance</replaceable></arg>
1804         </cmdsynopsis>
1805
1806         <para>
1807           Failover will fail the instance over its secondary
1808           node. This works only for instances having a drbd disk
1809           template.
1810         </para>
1811
1812         <para>
1813           Normally the failover will check the consistency of the
1814           disks before failing over the instance. If you are trying to
1815           migrate instances off a dead node, this will fail. Use the
1816           <option>--ignore-consistency</option> option for this
1817           purpose. Note that this option can be dangerous as errors in
1818           shutting down the instance will be ignored, resulting in
1819           possibly having the instance running on two machines in
1820           parallel (on disconnected DRBD drives).
1821         </para>
1822
1823         <para>
1824           The <option>--submit</option> option is used to send the job to
1825           the master daemon but not wait for its completion. The job
1826           ID will be shown so that it can be examined via
1827           <command>gnt-job info</command>.
1828         </para>
1829
1830         <para>
1831           Example:
1832           <screen>
1833 # gnt-instance failover instance1.example.com
1834           </screen>
1835         </para>
1836       </refsect3>
1837
1838       <refsect3>
1839         <title>MIGRATE</title>
1840
1841         <cmdsynopsis>
1842           <command>migrate</command>
1843           <arg>-f</arg>
1844           <arg choice="req">--cleanup</arg>
1845           <arg choice="req"><replaceable>instance</replaceable></arg>
1846         </cmdsynopsis>
1847
1848         <cmdsynopsis>
1849           <command>migrate</command>
1850           <arg>-f</arg>
1851           <arg>--non-live</arg>
1852           <arg choice="req"><replaceable>instance</replaceable></arg>
1853         </cmdsynopsis>
1854
1855         <para>
1856           Migrate will move the instance to its secondary node without
1857           shutdown. It only works for instances having the drbd8 disk
1858           template type.
1859         </para>
1860
1861         <para>
1862           The migration command needs a perfectly healthy instance, as
1863           we rely on the dual-master capability of drbd8 and the disks
1864           of the instance are not allowed to be degraded.
1865         </para>
1866
1867         <para>
1868           The <option>--non-live</option> option will switch (for the
1869           hypervisors that support it) between a "fully live"
1870           (i.e. the interruption is as minimal as possible) migration
1871           and one in which the instance is frozen, its state saved and
1872           transported to the remote node, and then resumed there. This
1873           all depends on the hypervisor support for two different
1874           methods. In any case, it is not an error to pass this
1875           parameter (it will just be ignored if the hypervisor doesn't
1876           support it).
1877         </para>
1878
1879         <para>
1880           If the <option>--cleanup</option> option is passed, the
1881           operation changes from migration to attempting recovery from
1882           a failed previous migration. In this mode, ganeti checks if
1883           the instance runs on the correct node (and updates its
1884           configuration if not) and ensures the instances's disks are
1885           configured correctly. In this mode, the
1886           <option>--non-live</option> option is ignored.
1887         </para>
1888
1889         <para>
1890           The option <option>-f</option> will skip the prompting for
1891           confirmation.
1892         </para>
1893         <para>
1894           Example (and expected output):
1895           <screen>
1896 # gnt-instance migrate instance1
1897 Migrate will happen to the instance instance1. Note that migration is
1898 **experimental** in this version. This might impact the instance if
1899 anything goes wrong. Continue?
1900 y/[n]/?: y
1901 * checking disk consistency between source and target
1902 * ensuring the target is in secondary mode
1903 * changing disks into dual-master mode
1904  - INFO: Waiting for instance instance1 to sync disks.
1905  - INFO: Instance instance1's disks are in sync.
1906 * migrating instance to node2.example.com
1907 * changing the instance's disks on source node to secondary
1908  - INFO: Waiting for instance instance1 to sync disks.
1909  - INFO: Instance instance1's disks are in sync.
1910 * changing the instance's disks to single-master
1911 #
1912           </screen>
1913         </para>
1914       </refsect3>
1915
1916     </refsect2>
1917
1918     <refsect2>
1919       <title>TAGS</title>
1920
1921     <refsect3>
1922         <title>ADD-TAGS</title>
1923
1924         <cmdsynopsis>
1925           <command>add-tags</command>
1926           <arg choice="opt">--from <replaceable>file</replaceable></arg>
1927           <arg choice="req"><replaceable>instancename</replaceable></arg>
1928           <arg choice="req"
1929             rep="repeat"><replaceable>tag</replaceable></arg>
1930         </cmdsynopsis>
1931
1932         <para>
1933           Add tags to the given instance. If any of the tags contains
1934           invalid characters, the entire operation will abort.
1935         </para>
1936         <para>
1937           If the <option>--from</option> option is given, the list of
1938           tags will be extended with the contents of that file (each
1939           line becomes a tag). In this case, there is not need to pass
1940           tags on the command line (if you do, both sources will be
1941           used). A file name of - will be interpreted as stdin.
1942         </para>
1943       </refsect3>
1944
1945       <refsect3>
1946         <title>LIST-TAGS</title>
1947
1948         <cmdsynopsis>
1949           <command>list-tags</command>
1950           <arg choice="req"><replaceable>instancename</replaceable></arg>
1951         </cmdsynopsis>
1952
1953         <para>List the tags of the given instance.</para>
1954       </refsect3>
1955
1956       <refsect3>
1957         <title>REMOVE-TAGS</title>
1958         <cmdsynopsis>
1959           <command>remove-tags</command>
1960           <arg choice="opt">--from <replaceable>file</replaceable></arg>
1961           <arg choice="req"><replaceable>instancename</replaceable></arg>
1962           <arg choice="req"
1963             rep="repeat"><replaceable>tag</replaceable></arg>
1964         </cmdsynopsis>
1965
1966         <para>
1967           Remove tags from the given instance. If any of the tags are
1968           not existing on the node, the entire operation will abort.
1969         </para>
1970
1971         <para>
1972           If the <option>--from</option> option is given, the list of
1973           tags will be extended with the contents of that file (each
1974           line becomes a tag). In this case, there is not need to pass
1975           tags on the command line (if you do, both sources will be
1976           used). A file name of - will be interpreted as stdin.
1977         </para>
1978       </refsect3>
1979
1980     </refsect2>
1981
1982   </refsect1>
1983
1984   &footer;
1985
1986 </refentry>
1987
1988 <!-- Keep this comment at the end of the file
1989 Local variables:
1990 mode: sgml
1991 sgml-omittag:t
1992 sgml-shorttag:t
1993 sgml-minimize-attributes:nil
1994 sgml-always-quote-attributes:t
1995 sgml-indent-step:2
1996 sgml-indent-data:t
1997 sgml-parent-document:nil
1998 sgml-default-dtd-file:nil
1999 sgml-exposed-tags:nil
2000 sgml-local-catalogs:nil
2001 sgml-local-ecat-files:nil
2002 End:
2003 -->