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>January 22, 2010</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       <year>2010</year>
  26       <holder>Google Inc.</holder>
  27     </copyright>
  28     &dhdate;
  29   </refentryinfo>
  30   <refmeta>
  31     &dhucpackage;
  32
  33     &dhsection;
  34     <refmiscinfo>ganeti 2.0</refmiscinfo>
  35   </refmeta>
  36   <refnamediv>
  37     <refname>&dhpackage;</refname>
  38
  39     <refpurpose>ganeti instance administration</refpurpose>
  40   </refnamediv>
  41   <refsynopsisdiv>
  42     <cmdsynopsis>
  43       <command>&dhpackage; </command>
  44
  45       <arg choice="req">command</arg>
  46       <arg>arguments...</arg>
  47     </cmdsynopsis>
  48   </refsynopsisdiv>
  49   <refsect1>
  50     <title>DESCRIPTION</title>
  51
  52     <para>
  53       The <command>&dhpackage;</command> is used for instance
  54       administration in the ganeti system.
  55     </para>
  56
  57   </refsect1>
  58   <refsect1>
  59     <title>COMMANDS</title>
  60
  61     <refsect2>
  62       <title>Creation/removal/querying</title>
  63
  64       <refsect3>
  65         <title>ADD</title>
  66         <cmdsynopsis>
  67           <command>add</command>
  68           <sbr>
  69           <arg choice="req">-t<group choice="req">
  70               <arg>diskless</arg>
  71               <arg>file</arg>
  72               <arg>plain</arg>
  73               <arg>drbd</arg>
  74             </group></arg>
  75           <sbr>
  76
  77           <group choice="req">
  78             <arg rep="repeat">--disk=<replaceable>N</replaceable>:<group choice="req">
  79                 <arg>size=<replaceable>VAL</replaceable></arg>
  80                 <arg>adopt=<replaceable>LV</replaceable></arg>
  81               </group>,mode=<replaceable>ro|rw</replaceable></arg>
  82             <arg>-s <replaceable>SIZE</replaceable></arg>
  83           </group>
  84           <sbr>
  85           <arg>--no-ip-check</arg>
  86           <arg>--no-name-check</arg>
  87           <arg>--no-start</arg>
  88           <arg>--no-install</arg>
  89           <sbr>
  90           <group>
  91             <arg rep="repeat">--net=<replaceable>N</replaceable><arg rep="repeat">:options</arg></arg>
  92             <arg>--no-nics</arg>
  93           </group>
  94           <sbr>
  95           <arg>-B <replaceable>BEPARAMS</replaceable></arg>
  96           <sbr>
  97
  98           <arg>-H <replaceable>HYPERVISOR</replaceable><arg>:<arg choice="plain" rep="repeat">option=<replaceable>value</replaceable></arg></arg></arg>
  99           <sbr>
 100
 101           <arg>--file-storage-dir <replaceable>dir_path</replaceable></arg>
 102           <arg>--file-driver<group choice="req">
 103               <arg>loop</arg>
 104               <arg>blktap</arg>
 105             </group></arg>
 106           <sbr>
 107
 108           <group choice="req">
 109             <arg>-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
 110             <arg>--iallocator <replaceable>name</replaceable></arg>
 111           </group>
 112           <sbr>
 113
 114           <arg choice="req">-o <replaceable>os-type</replaceable></arg>
 115           <sbr>
 116           <arg>--submit</arg>
 117           <sbr>
 118
 119           <arg choice="req"><replaceable>instance</replaceable></arg>
 120         </cmdsynopsis>
 121
 122         <para>
 123           Creates a new instance on the specified host. The
 124           <replaceable>instance</replaceable> argument must be in DNS,
 125           but depending on the bridge/routing setup, need not be in
 126           the same network as the nodes in the cluster.
 127         </para>
 128
 129         <para>
 130           The <option>disk</option> option specifies the parameters
 131           for the disks of the instance. The numbering of disks starts
 132           at zero, and at least one disk needs to be passed. For each
 133           disk, either the size or the adoption source needs to be
 134           given, and optionally the access mode (read-only or the
 135           default of read-write) can also be specified.  The size is
 136           interpreted (when no unit is given) in mebibytes. You can
 137           also use one of the suffixes
 138           <literal>m</literal>, <literal>g</literal> or
 139           <literal>t</literal> to specificy the exact the units used;
 140           these suffixes map to mebibytes, gibibytes and tebibytes.
 141         </para>
 142
 143         <para>
 144           When using the <option>adopt</option> key in the disk
 145           definition, Ganeti will reuse those volumes (instead of
 146           creating new ones) as the instance's disks. Ganeti will
 147           rename these volumes to the standard format, and (without
 148           installing the OS) will use them as-is for the
 149           instance. This allows migrating instances from non-managed
 150           mode (e.q. plain KVM with LVM) to being managed via
 151           Ganeti. Note that this works only for the `plain' disk
 152           template (see below for template details).
 153         </para>
 154
 155         <para>
 156           Alternatively, a single-disk instance can be created via the
 157           <option>-s</option> option which takes a single argument,
 158           the size of the disk. This is similar to the Ganeti 1.2
 159           version (but will only create one disk).
 160         </para>
 161
 162         <para>
 163           The minimum disk specification is therefore
 164           <userinput>--disk 0:size=20G</userinput> (or <userinput>-s
 165           20G</userinput> when using the <option>-s</option> option),
 166           and a three-disk instance can be specified as
 167           <userinput>--disk 0:size=20G --disk 1:size=4G --disk
 168           2:size=100G</userinput>.
 169         </para>
 170
 171         <para>
 172           The <option>--no-ip-check</option> skips the checks that are
 173           done to see if the instance's IP is not already alive
 174           (i.e. reachable from the master node).
 175         </para>
 176
 177         <para>
 178           The <option>--no-name-check</option> skips the check for the
 179           instance name via the resolver (e.g. in DNS or /etc/hosts,
 180           depending on your setup). Since the name check is used to
 181           compute the IP address, if you pass this option you must
 182           also pass the <option>--no-ip-check</option> option.
 183         </para>
 184
 185         <para>
 186           If you don't wat the instance to automatically start after
 187           creation, this is possible via the
 188           <option>--no-start</option> option. This will leave the
 189           instance down until a subsequent <command>gnt-instance
 190           start</command> command.
 191         </para>
 192
 193         <para>
 194           The NICs of the instances can be specified via the
 195           <option>--net</option> option. By default, one NIC is
 196           created for the instance, with a random MAC, and set
 197           up according the the cluster level nic parameters.
 198           Each NIC can take these parameters (all optional):
 199           <variablelist>
 200             <varlistentry>
 201               <term>mac</term>
 202               <listitem>
 203                 <simpara>either a value or <constant>GENERATE</constant>
 204                   to generate a new unique MAC</simpara>
 205               </listitem>
 206             </varlistentry>
 207             <varlistentry>
 208               <term>ip</term>
 209               <listitem>
 210                 <simpara>specifies the IP address assigned to the
 211                   instance from the Ganeti side (this is not necessarily
 212                   what the instance will use, but what the node expects
 213                   the instance to use)</simpara>
 214               </listitem>
 215             </varlistentry>
 216             <varlistentry>
 217               <term>mode</term>
 218               <listitem>
 219                 <simpara>specifies the connection mode for this nic:
 220                   routed or bridged.</simpara>
 221               </listitem>
 222             </varlistentry>
 223             <varlistentry>
 224               <term>link</term>
 225               <listitem>
 226                 <simpara>in bridged mode specifies the bridge to attach
 227                   this NIC to, in routed mode it's intended to
 228                   differentiate between different routing tables/instance
 229                   groups (but the meaning is dependent on the network
 230                   script, see gnt-cluster(8) for more details)</simpara>
 231               </listitem>
 232             </varlistentry>
 233           </variablelist>
 234           Of these "mode" and "link" are nic parameters, and inherit their
 235           default at cluster level.
 236         </para>
 237
 238         <para>
 239           Alternatively, if no network is desired for the instance, you
 240           can prevent the default of one NIC with the
 241           <option>--no-nics</option> option.
 242         </para>
 243
 244         <para>
 245           The <option>-o</option> options specifies the operating
 246           system to be installed. The available operating systems can
 247           be listed with <command>gnt-os
 248           list</command>. Passing <option>--no-install</option> will
 249           however skip the OS installation, allowing a manual import
 250           if so desired. Note that the no-installation mode will
 251           automatically disable the start-up of the instance (without
 252           an OS, it most likely won't be able to start-up
 253           successfully).
 254         </para>
 255
 256         <para>
 257           The <option>-B</option> option specifies the backend
 258           parameters for the instance. If no such parameters are
 259           specified, the values are inherited from the cluster. Possible
 260           parameters are:
 261           <variablelist>
 262             <varlistentry>
 263               <term>memory</term>
 264               <listitem>
 265                 <simpara>the memory size of the instance; as usual,
 266                   suffixes can be used to denote the unit, otherwise the
 267                   value is taken in mebibites</simpara>
 268               </listitem>
 269             </varlistentry>
 270             <varlistentry>
 271               <term>vcpus</term>
 272               <listitem>
 273                 <simpara>the number of VCPUs to assign to the instance
 274                   (if this value makes sense for the hypervisor)</simpara>
 275               </listitem>
 276             </varlistentry>
 277             <varlistentry>
 278               <term>auto_balance</term>
 279               <listitem>
 280                 <simpara>whether the instance is considered in the N+1
 281                   cluster checks (enough redundancy in the cluster to
 282                   survive a node failure)</simpara>
 283               </listitem>
 284             </varlistentry>
 285           </variablelist>
 286         </para>
 287
 288         <para>
 289           The <option>-H</option> option specified the hypervisor to
 290           use for the instance (must be one of the enabled hypervisors
 291           on the cluster) and optionally custom parameters for this
 292           instance. If not other options are used (i.e. the invocation
 293           is just <userinput>-H
 294           <replaceable>NAME</replaceable></userinput>) the instance
 295           will inherit the cluster options. The defaults below show
 296           the cluster defaults at cluster creation time.
 297         </para>
 298
 299         <para>
 300           The possible hypervisor options are as follows:
 301           <variablelist>
 302             <varlistentry>
 303               <term>boot_order</term>
 304               <listitem>
 305                 <simpara>Valid for the Xen HVM and KVM
 306                 hypervisors.</simpara>
 307
 308                 <simpara>A string value denoting the boot order. This
 309                 has different meaning for the Xen HVM hypervisor and
 310                 for the KVM one.</simpara>
 311
 312                 <simpara>
 313                   For Xen HVM, The boot order is a string of letters
 314                   listing the boot devices, with valid device letters
 315                   being:
 316                 </simpara>
 317                   <variablelist>
 318                     <varlistentry>
 319                       <term>a</term>
 320                       <listitem>
 321                         <para>
 322                           floppy drive
 323                         </para>
 324                       </listitem>
 325                     </varlistentry>
 326                     <varlistentry>
 327                       <term>c</term>
 328                       <listitem>
 329                         <para>
 330                           hard disk
 331                         </para>
 332                       </listitem>
 333                     </varlistentry>
 334                     <varlistentry>
 335                       <term>d</term>
 336                       <listitem>
 337                         <para>
 338                           CDROM drive
 339                         </para>
 340                       </listitem>
 341                     </varlistentry>
 342                     <varlistentry>
 343                       <term>n</term>
 344                       <listitem>
 345                         <para>
 346                           network boot (PXE)
 347                         </para>
 348                       </listitem>
 349                     </varlistentry>
 350                   </variablelist>
 351                 <simpara>
 352                   The default is not to set an HVM boot order which is
 353                   interpreted as 'dc'.
 354                 </simpara>
 355
 356                 <simpara>
 357                   For KVM the boot order is either
 358                   <quote>cdrom</quote>, <quote>disk</quote> or
 359                   <quote>network</quote>. Please note that older
 360                   versions of KVM couldn't netboot from virtio
 361                   interfaces. This has been fixed in more recent
 362                   versions and is confirmed to work at least with
 363                   qemu-kvm 0.11.1.
 364                 </simpara>
 365
 366               </listitem>
 367             </varlistentry>
 368             <varlistentry>
 369               <term>cdrom_image_path</term>
 370               <listitem>
 371                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 372
 373                 <simpara>The path to a CDROM image to attach to the
 374                 instance.</simpara>
 375
 376               </listitem>
 377             </varlistentry>
 378             <varlistentry>
 379               <term>nic_type</term>
 380               <listitem>
 381                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 382
 383                 <para>
 384                   This parameter determines the way the network cards
 385                   are presented to the instance. The possible options are:
 386                   <simplelist>
 387                     <member>rtl8139 (default for Xen HVM) (HVM & KVM)</member>
 388                     <member>ne2k_isa (HVM & KVM)</member>
 389                     <member>ne2k_pci (HVM & KVM)</member>
 390                     <member>i82551 (KVM)</member>
 391                     <member>i82557b (KVM)</member>
 392                     <member>i82559er (KVM)</member>
 393                     <member>pcnet (KVM)</member>
 394                     <member>e1000 (KVM)</member>
 395                     <member>paravirtual (default for KVM) (HVM & KVM)</member>
 396                   </simplelist>
 397                 </para>
 398               </listitem>
 399             </varlistentry>
 400             <varlistentry>
 401               <term>disk_type</term>
 402               <listitem>
 403                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 404
 405                 <para>
 406                   This parameter determines the way the disks are
 407                   presented to the instance. The possible options are:
 408                   <simplelist>
 409                     <member>ioemu (default for HVM & KVM) (HVM & KVM)</member>
 410                     <member>ide (HVM & KVM)</member>
 411                     <member>scsi (KVM)</member>
 412                     <member>sd (KVM)</member>
 413                     <member>mtd (KVM)</member>
 414                     <member>pflash (KVM)</member>
 415                   </simplelist>
 416                 </para>
 417               </listitem>
 418             </varlistentry>
 419             <varlistentry>
 420               <term>vnc_bind_address</term>
 421               <listitem>
 422                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 423
 424                 <para>Specifies the address that the VNC listener for
 425                 this instance should bind to. Valid values are IPv4
 426                 addresses. Use the address 0.0.0.0 to bind to all
 427                 available interfaces (this is the default) or specify
 428                 the address of one of the interfaces on the node to
 429                 restrict listening to that interface.</para>
 430               </listitem>
 431             </varlistentry>
 432
 433             <varlistentry>
 434               <term>vnc_tls</term>
 435               <listitem>
 436                 <simpara>Valid for the KVM hypervisor.</simpara>
 437
 438                 <simpara>A boolean option that controls whether the
 439                 VNC connection is secured with TLS.</simpara>
 440               </listitem>
 441             </varlistentry>
 442
 443             <varlistentry>
 444               <term>vnc_x509_path</term>
 445               <listitem>
 446                 <simpara>Valid for the KVM hypervisor.</simpara>
 447
 448                 <para>If <option>vnc_tls</option> is enabled, this
 449                 options specifies the path to the x509 certificate to
 450                 use.</para>
 451               </listitem>
 452             </varlistentry>
 453
 454             <varlistentry>
 455               <term>vnc_x509_verify</term>
 456               <listitem>
 457                 <simpara>Valid for the KVM hypervisor.</simpara>
 458               </listitem>
 459             </varlistentry>
 460
 461             <varlistentry>
 462               <term>acpi</term>
 463               <listitem>
 464                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 465
 466                 <para>
 467                   A boolean option that specifies if the hypervisor
 468                   should enable ACPI support for this instance. By
 469                   default, ACPI is disabled.
 470                 </para>
 471               </listitem>
 472             </varlistentry>
 473
 474             <varlistentry>
 475               <term>pae</term>
 476               <listitem>
 477                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 478
 479                 <para>
 480                   A boolean option that specifies if the hypervisor
 481                   should enabled PAE support for this instance. The
 482                   default is false, disabling PAE support.
 483                 </para>
 484               </listitem>
 485             </varlistentry>
 486
 487             <varlistentry>
 488               <term>use_localtime</term>
 489               <listitem>
 490                 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
 491
 492                 <para>
 493                   A boolean option that specifies if the instance
 494                   should be started with its clock set to the
 495                   localtime of the machine (when true) or to the UTC
 496                   (When false). The default is false, which is useful
 497                   for Linux/Unix machines; for Windows OSes, it is
 498                   recommended to enable this parameter.
 499                 </para>
 500               </listitem>
 501             </varlistentry>
 502
 503             <varlistentry>
 504               <term>kernel_path</term>
 505               <listitem>
 506                 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
 507
 508                 <para>
 509                   This option specifies the path (on the node) to the
 510                   kernel to boot the instance with. Xen PVM instances
 511                   always require this, while for KVM if this option is
 512                   empty, it will cause the machine to load the kernel
 513                   from its disks.
 514                 </para>
 515               </listitem>
 516             </varlistentry>
 517
 518             <varlistentry>
 519               <term>kernel_args</term>
 520               <listitem>
 521                 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
 522
 523                 <para>
 524                   This options specifies extra arguments to the kernel
 525                   that will be loaded.  device. This is always used
 526                   for Xen PVM, while for KVM it is only used if the
 527                   <option>kernel_path</option> option is also
 528                   specified.
 529                 </para>
 530
 531                 <para>
 532                   The default setting for this value is simply
 533                   <constant>"ro"</constant>, which mounts the root
 534                   disk (initially) in read-only one. For example,
 535                   setting this to <userinput>single</userinput> will
 536                   cause the instance to start in single-user mode.
 537                 </para>
 538               </listitem>
 539             </varlistentry>
 540
 541             <varlistentry>
 542               <term>initrd_path</term>
 543               <listitem>
 544                 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
 545
 546                 <para>
 547                   This option specifies the path (on the node) to the
 548                   initrd to boot the instance with. Xen PVM instances
 549                   can use this always, while for KVM if this option is
 550                   only used if the <option>kernel_path</option> option
 551                   is also specified. You can pass here either an
 552                   absolute filename (the path to the initrd) if you
 553                   want to use an initrd, or use the format
 554                   <userinput>no_initrd_path</userinput> for no initrd.
 555                 </para>
 556               </listitem>
 557             </varlistentry>
 558
 559             <varlistentry>
 560               <term>root_path</term>
 561               <listitem>
 562                 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
 563
 564                 <para>
 565                   This options specifies the name of the root
 566                   device. This is always needed for Xen PVM, while for
 567                   KVM it is only used if the
 568                   <option>kernel_path</option> option is also
 569                   specified.
 570                 </para>
 571               </listitem>
 572             </varlistentry>
 573
 574             <varlistentry>
 575               <term>serial_console</term>
 576               <listitem>
 577                 <simpara>Valid for the KVM hypervisor.</simpara>
 578
 579                 <simpara>This boolean option specifies whether to
 580                 emulate a serial console for the instance.</simpara>
 581               </listitem>
 582             </varlistentry>
 583
 584             <varlistentry>
 585               <term>disk_cache</term>
 586               <listitem>
 587                 <simpara>Valid for the KVM hypervisor.</simpara>
 588
 589                 <simpara>The disk cache mode. It can be either
 590                 <userinput>default</userinput> to not pass any cache
 591                 option to KVM, or one of the KVM cache modes: none
 592                 (for direct I/O), writethrough (to use the host cache
 593                 but report completion to the guest only when the host
 594                 has committed the changes to disk) or writeback (to
 595                 use the host cache and report completion as soon as
 596                 the data is in the host cache). Note that there are
 597                 special considerations for the cache mode depending on
 598                 version of KVM used and disk type (always raw file
 599                 under Ganeti), please refer to the KVM documentation
 600                 for more details.
 601                 </simpara>
 602               </listitem>
 603             </varlistentry>
 604
 605             <varlistentry>
 606               <term>security_model</term>
 607               <listitem>
 608                 <simpara>Valid for the KVM hypervisor.</simpara>
 609
 610                 <simpara>The security model for kvm. Currently one of
 611                 <quote>none</quote>, <quote>user</quote> or
 612                 <quote>pool</quote>. Under <quote>none</quote>, the
 613                 default, nothing is done and instances are run as
 614                 the ganeti daemon user (normally root).
 615                 </simpara>
 616
 617                 <simpara>Under <quote>user</quote> kvm will drop
 618                 privileges and become the user specified by the
 619                 security_domain parameter.
 620                 </simpara>
 621
 622                 <simpara>Under <quote>pool</quote> a global cluster
 623                 pool of users will be used, making sure no two
 624                 instances share the same user on the same node.
 625                 (this mode is not implemented yet)
 626                 </simpara>
 627
 628               </listitem>
 629             </varlistentry>
 630
 631             <varlistentry>
 632               <term>security_domain</term>
 633               <listitem>
 634                 <simpara>Valid for the KVM hypervisor.</simpara>
 635
 636                 <simpara>Under security model <quote>user</quote> the username to
 637                 run the instance under. It must be a valid username
 638                 existing on the host.
 639                 </simpara>
 640                 <simpara>Cannot be set under security model <quote>none</quote>
 641                 or <quote>pool</quote>.
 642                 </simpara>
 643
 644               </listitem>
 645             </varlistentry>
 646
 647             <varlistentry>
 648               <term>kvm_flag</term>
 649               <listitem>
 650                 <simpara>Valid for the KVM hypervisor.</simpara>
 651
 652                 <simpara>If <quote>enabled</quote> the -enable-kvm flag is
 653                 passed to kvm. If <quote>disabled</quote> -disable-kvm is
 654                 passed. If unset no flag is passed, and the default running
 655                 mode for your kvm binary will be used.
 656                 </simpara>
 657
 658               </listitem>
 659             </varlistentry>
 660
 661             <varlistentry>
 662               <term>migration_downtime</term>
 663               <listitem>
 664                 <simpara>Valid for the KVM hypervisor.</simpara>
 665
 666                 <simpara>The maximum amount of time (in ms) a KVM instance is
 667                 allowed to be frozen during a live migration, in order to copy
 668                 dirty memory pages. Default value is 30ms, but you may need to
 669                 increase this value for busy instances.
 670                 </simpara>
 671
 672                 <simpara>This option is only effective with kvm versions >= 87
 673                 and qemu-kvm versions >= 0.11.0.
 674                 </simpara>
 675
 676               </listitem>
 677             </varlistentry>
 678
 679           </variablelist>
 680
 681         </para>
 682
 683         <para>
 684           The <option>--iallocator</option> option specifies the instance
 685           allocator plugin to use. If you pass in this option the allocator
 686           will select nodes for this instance automatically, so you don't need
 687           to pass them with the <option>-n</option> option. For more
 688           information please refer to the instance allocator documentation.
 689         </para>
 690
 691         <para>
 692           The <option>-t</option> options specifies the disk layout type for
 693           the instance. The available choices are:
 694           <variablelist>
 695             <varlistentry>
 696               <term>diskless</term>
 697               <listitem>
 698                 <para>
 699                   This creates an instance with no disks. Its useful for
 700                   testing only (or other special cases).
 701                 </para>
 702               </listitem>
 703             </varlistentry>
 704             <varlistentry>
 705               <term>file</term>
 706               <listitem>
 707                 <para>Disk devices will be regular files.</para>
 708               </listitem>
 709             </varlistentry>
 710             <varlistentry>
 711               <term>plain</term>
 712               <listitem>
 713                 <para>Disk devices will be logical volumes.</para>
 714               </listitem>
 715             </varlistentry>
 716             <varlistentry>
 717               <term>drbd</term>
 718               <listitem>
 719                 <para>
 720                   Disk devices will be drbd (version 8.x) on top of
 721                   lvm volumes.
 722                 </para>
 723               </listitem>
 724             </varlistentry>
 725           </variablelist>
 726         </para>
 727
 728         <para>
 729           The optional second value of the <option>--node</option> is used for
 730           the drbd template type and specifies the remote node.
 731         </para>
 732
 733         <para>
 734           If you do not want gnt-instance to wait for the disk mirror
 735           to be synced, use the <option>--no-wait-for-sync</option>
 736           option.
 737         </para>
 738
 739         <para>
 740           The <option>--file-storage-dir</option> specifies the relative path
 741           under the cluster-wide file storage directory to store file-based
 742           disks. It is useful for having different subdirectories for
 743           different instances. The full path of the directory where the disk
 744           files are stored will consist of cluster-wide file storage directory
 745           + optional subdirectory + instance name. Example:
 746           /srv/ganeti/file-storage/mysubdir/instance1.example.com. This option
 747           is only relevant for instances using the file storage backend.
 748         </para>
 749
 750         <para>
 751           The <option>--file-driver</option> specifies the driver to use for
 752           file-based disks. Note that currently these drivers work with the
 753           xen hypervisor only. This option is only relevant for instances using
 754           the file storage backend. The available choices are:
 755           <variablelist>
 756             <varlistentry>
 757               <term>loop</term>
 758               <listitem>
 759                 <para>
 760                   Kernel loopback driver. This driver uses loopback
 761                   devices to access the filesystem within the
 762                   file. However, running I/O intensive applications in
 763                   your instance using the loop driver might result in
 764                   slowdowns.  Furthermore, if you use the loopback
 765                   driver consider increasing the maximum amount of
 766                   loopback devices (on most systems it's 8) using the
 767                   max_loop param.
 768                 </para>
 769               </listitem>
 770             </varlistentry>
 771             <varlistentry>
 772               <term>blktap</term>
 773               <listitem>
 774                 <para>The blktap driver (for Xen hypervisors). In
 775                 order to be able to use the blktap driver you should
 776                 check if the 'blktapctrl' user space disk agent is
 777                 running (usually automatically started via xend). This
 778                 user-level disk I/O interface has the advantage of
 779                 better performance. Especially if you use a network
 780                 file system (e.g. NFS) to store your instances this is
 781                 the recommended choice.
 782                 </para>
 783               </listitem>
 784             </varlistentry>
 785           </variablelist>
 786         </para>
 787
 788         <para>
 789           The <option>--submit</option> option is used to send the job to
 790           the master daemon but not wait for its completion. The job
 791           ID will be shown so that it can be examined via
 792           <command>gnt-job info</command>.
 793         </para>
 794
 795         <para>
 796           Example:
 797           <screen>
 798 # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
 799   -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
 800 # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
 801   -n node1.example.com instance1.example.com
 802 # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
 803   -n node1.example.com:node2.example.com instance2.example.com
 804           </screen>
 805         </para>
 806       </refsect3>
 807
 808       <refsect3>
 809         <title>BATCH-CREATE</title>
 810         <cmdsynopsis>
 811           <command>batch-create</command>
 812           <arg choice="req">instances_file.json</arg>
 813         </cmdsynopsis>
 814
 815         <para>
 816           This command (similar to the Ganeti 1.2
 817           <command>batcher</command> tool) submits multiple instance
 818           creation jobs based on a definition file. The instance
 819           configurations do not encompass all the possible options for
 820           the <command>add</command> command, but only a subset.
 821         </para>
 822
 823         <para>
 824           The instance file should be a valid-formed JSON file,
 825           containing a dictionary with instance name and instance
 826           parameters. The accepted parameters are:
 827
 828           <variablelist>
 829             <varlistentry>
 830               <term>disk_size</term>
 831               <listitem>
 832                 <simpara>The size of the disks of the instance.</simpara>
 833               </listitem>
 834             </varlistentry>
 835             <varlistentry>
 836               <term>disk_templace</term>
 837               <listitem>
 838                 <simpara>The disk template to use for the instance,
 839                 the same as in the <command>add</command>
 840                 command.</simpara>
 841               </listitem>
 842             </varlistentry>
 843             <varlistentry>
 844               <term>backend</term>
 845               <listitem>
 846                 <simpara>A dictionary of backend parameters.</simpara>
 847               </listitem>
 848             </varlistentry>
 849             <varlistentry>
 850               <term>hypervisor</term>
 851               <listitem>
 852                 <simpara>A dictionary with a single key (the
 853                 hypervisor name), and as value the hypervisor
 854                 options. If not passed, the default hypervisor and
 855                 hypervisor options will be inherited.</simpara>
 856               </listitem>
 857             </varlistentry>
 858             <varlistentry>
 859               <term>mac, ip, mode, link</term>
 860               <listitem>
 861                 <simpara>Specifications for the one NIC that will be
 862                 created for the instance. 'bridge' is also accepted
 863                 as a backwards compatibile key.</simpara>
 864               </listitem>
 865             </varlistentry>
 866             <varlistentry>
 867               <term>nics</term>
 868               <listitem>
 869                 <simpara>List of nics that will be created for the
 870                 instance. Each entry should be a dict, with mac, ip, mode
 871                 and link as possible keys. Please don't provide the "mac,
 872                 ip, mode, link" parent keys if you use this method for
 873                 specifying nics.</simpara>
 874               </listitem>
 875             </varlistentry>
 876             <varlistentry>
 877               <term>primary_node, secondary_node</term>
 878               <listitem>
 879                 <simpara>The primary and optionally the secondary node
 880                 to use for the instance (in case an iallocator script
 881                 is not used).</simpara>
 882               </listitem>
 883             </varlistentry>
 884             <varlistentry>
 885               <term>iallocator</term>
 886               <listitem>
 887                 <simpara>Instead of specifying the nodes, an
 888                 iallocator script can be used to automatically compute
 889                 them.</simpara>
 890               </listitem>
 891             </varlistentry>
 892             <varlistentry>
 893               <term>start</term>
 894               <listitem>
 895                 <simpara>whether to start the instance</simpara>
 896               </listitem>
 897             </varlistentry>
 898             <varlistentry>
 899               <term>ip_check</term>
 900               <listitem>
 901                 <simpara>Skip the check for already-in-use instance;
 902                 see the description in the <command>add</command>
 903                 command for details.</simpara>
 904               </listitem>
 905             </varlistentry>
 906             <varlistentry>
 907               <term>name_check</term>
 908               <listitem>
 909                 <simpara>Skip the name check for instances;
 910                 see the description in the <command>add</command>
 911                 command for details.</simpara>
 912               </listitem>
 913             </varlistentry>
 914             <varlistentry>
 915               <term>file_storage_dir, file_driver</term>
 916               <listitem>
 917                 <simpara>Configuration for the <literal>file</literal>
 918                 disk type, see the <command>add</command> command for
 919                 details.</simpara>
 920               </listitem>
 921             </varlistentry>
 922           </variablelist>
 923         </para>
 924
 925         <para>
 926           A simple definition for one instance can be (with most of
 927           the parameters taken from the cluster defaults):
 928           <screen>
 929 {
 930   "instance3": {
 931     "template": "drbd",
 932     "os": "debootstrap",
 933     "disk_size": ["25G"],
 934     "iallocator": "dumb"
 935   },
 936   "instance5": {
 937     "template": "drbd",
 938     "os": "debootstrap",
 939     "disk_size": ["25G"],
 940     "iallocator": "dumb",
 941     "hypervisor": "xen-hvm",
 942     "hvparams": {"acpi": true},
 943     "backend": {"memory": 512}
 944   }
 945 }
 946 </screen>
 947         </para>
 948
 949         <para>
 950           The command will display the job id for each submitted instance, as follows:
 951           <screen>
 952 # gnt-instance batch-create instances.json
 953 instance3: 11224
 954 instance5: 11225
 955 </screen>
 956         </para>
 957
 958       </refsect3>
 959
 960       <refsect3>
 961         <title>REMOVE</title>
 962
 963         <cmdsynopsis>
 964           <command>remove</command>
 965           <arg>--ignore-failures</arg>
 966           <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
 967           <arg>--submit</arg>
 968           <arg choice="req"><replaceable>instance</replaceable></arg>
 969         </cmdsynopsis>
 970
 971         <para>
 972           Remove an instance. This will remove all data from the
 973           instance and there is <emphasis>no way back</emphasis>. If
 974           you are not sure if you use an instance again, use
 975           <command>shutdown</command> first and leave it in the
 976           shutdown state for a while.
 977
 978         </para>
 979
 980         <para>
 981           The <option>--ignore-failures</option> option will cause the
 982           removal to proceed even in the presence of errors during the
 983           removal of the instance (e.g. during the shutdown or the
 984           disk removal). If this option is not given, the command will
 985           stop at the first error.
 986         </para>
 987
 988         <para>
 989           The <option>--shutdown-timeout</option> is used to specify how
 990           much time to wait before forcing the shutdown (xm destroy in xen,
 991           killing the kvm process, for kvm). By default two minutes are
 992           given to each instance to stop.
 993         </para>
 994
 995         <para>
 996           The <option>--submit</option> option is used to send the job to
 997           the master daemon but not wait for its completion. The job
 998           ID will be shown so that it can be examined via
 999           <command>gnt-job info</command>.
1000         </para>
1001
1002         <para>
1003           Example:
1004           <screen>
1005 # gnt-instance remove instance1.example.com
1006           </screen>
1007         </para>
1008       </refsect3>
1009
1010       <refsect3>
1011         <title>LIST</title>
1012
1013         <cmdsynopsis>
1014           <command>list</command>
1015           <arg>--no-headers</arg>
1016           <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
1017           <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
1018           <arg>--roman</arg>
1019           <arg rep="repeat">instance</arg>
1020         </cmdsynopsis>
1021
1022         <para>
1023           Shows the currently configured instances with memory usage,
1024           disk usage, the node they are running on, and their run
1025           status.
1026         </para>
1027
1028         <para>
1029           The <option>--no-headers</option> option will skip the
1030           initial header line. The <option>--separator</option> option
1031           takes an argument which denotes what will be used between
1032           the output fields. Both these options are to help scripting.
1033         </para>
1034
1035         <para>
1036           The <option>--roman</option> option allows latin people to better
1037           understand the cluster instances' status.
1038         </para>
1039
1040         <para>
1041           The <option>-o</option> option takes a comma-separated list
1042           of output fields. The available fields and their meaning
1043           are:
1044           <variablelist>
1045             <varlistentry>
1046               <term>name</term>
1047               <listitem>
1048                 <simpara>the instance name</simpara>
1049               </listitem>
1050             </varlistentry>
1051             <varlistentry>
1052               <term>os</term>
1053               <listitem>
1054                 <simpara>the OS of the instance</simpara>
1055               </listitem>
1056             </varlistentry>
1057             <varlistentry>
1058               <term>pnode</term>
1059               <listitem>
1060                 <simpara>the primary node of the instance</simpara>
1061               </listitem>
1062             </varlistentry>
1063             <varlistentry>
1064               <term>snodes</term>
1065               <listitem>
1066                 <simpara>comma-separated list of secondary nodes for the
1067                   instance; usually this will be just one node</simpara>
1068               </listitem>
1069             </varlistentry>
1070             <varlistentry>
1071               <term>admin_state</term>
1072               <listitem>
1073                 <simpara>the desired state of the instance (either "yes"
1074                   or "no" denoting the instance should run or
1075                   not)</simpara>
1076               </listitem>
1077             </varlistentry>
1078             <varlistentry>
1079               <term>disk_template</term>
1080               <listitem>
1081                 <simpara>the disk template of the instance</simpara>
1082               </listitem>
1083             </varlistentry>
1084             <varlistentry>
1085               <term>oper_state</term>
1086               <listitem>
1087                 <simpara>the actual state of the instance; can be
1088                 one of the values "running", "stopped", "(node
1089                 down)"</simpara>
1090               </listitem>
1091             </varlistentry>
1092             <varlistentry>
1093               <term>status</term>
1094               <listitem>
1095                 <simpara>combined form of admin_state and oper_stat;
1096                 this can be one of:
1097                 <computeroutput>ERROR_nodedown</computeroutput> if the
1098                 node of the instance is down,
1099                 <computeroutput>ERROR_down</computeroutput> if the
1100                 instance should run but is down,
1101                 <computeroutput>ERROR_up</computeroutput> if the
1102                 instance should be stopped but is actually running,
1103                 <computeroutput>ADMIN_down</computeroutput> if the
1104                 instance has been stopped (and is stopped) and
1105                 <computeroutput>running</computeroutput> if the
1106                 instance is set to be running (and is
1107                 running)</simpara>
1108               </listitem>
1109             </varlistentry>
1110             <varlistentry>
1111               <term>oper_ram</term>
1112               <listitem>
1113                 <simpara>the actual memory usage of the instance as seen
1114                   by the hypervisor</simpara>
1115               </listitem>
1116             </varlistentry>
1117             <varlistentry>
1118               <term>ip</term>
1119               <listitem>
1120                 <simpara>the ip address ganeti recognizes as associated with
1121                 the first instance interface</simpara>
1122               </listitem>
1123             </varlistentry>
1124             <varlistentry>
1125               <term>mac</term>
1126               <listitem>
1127                 <simpara>the first instance interface MAC address</simpara>
1128               </listitem>
1129             </varlistentry>
1130
1131             <varlistentry>
1132               <term>nic_mode</term>
1133               <listitem>
1134                 <simpara>the mode of the first instance NIC
1135                 (routed or bridged)</simpara>
1136               </listitem>
1137             </varlistentry>
1138             <varlistentry>
1139               <term>nic_link</term>
1140               <listitem>
1141                 <simpara>the link of the first instance NIC
1142                 </simpara>
1143               </listitem>
1144             </varlistentry>
1145             <varlistentry>
1146               <term>sda_size</term>
1147               <listitem>
1148                 <simpara>the size of the instance's first disk</simpara>
1149               </listitem>
1150             </varlistentry>
1151             <varlistentry>
1152               <term>sdb_size</term>
1153               <listitem>
1154                 <simpara>the size of the instance's second disk, if
1155                 any</simpara>
1156               </listitem>
1157             </varlistentry>
1158             <varlistentry>
1159               <term>vcpus</term>
1160               <listitem>
1161                 <simpara>the number of VCPUs allocated to the
1162                 instance</simpara>
1163               </listitem>
1164             </varlistentry>
1165             <varlistentry>
1166               <term>tags</term>
1167               <listitem>
1168                 <simpara>comma-separated list of the instances's
1169                 tags</simpara>
1170               </listitem>
1171             </varlistentry>
1172             <varlistentry>
1173               <term>serial_no</term>
1174               <listitem>
1175                 <simpara>the so called 'serial number' of the
1176                 instance; this is a numeric field that is incremented
1177                 each time the instance is modified, and it can be used
1178                 to track modifications</simpara>
1179               </listitem>
1180             </varlistentry>
1181             <varlistentry>
1182               <term>ctime</term>
1183               <listitem>
1184                 <para>
1185                   the creation time of the instance; note that this
1186                   field contains spaces and as such it's harder to
1187                   parse
1188                 </para>
1189                 <para>
1190                   if this attribute is not present (e.g. when
1191                   upgrading from older versions), then "N/A" will be
1192                   shown instead
1193                 </para>
1194               </listitem>
1195             </varlistentry>
1196             <varlistentry>
1197               <term>mtime</term>
1198               <listitem>
1199                 <para>
1200                   the last modification time of the instance; note
1201                   that this field contains spaces and as such it's
1202                   harder to parse
1203                 </para>
1204                 <para>
1205                   if this attribute is not present (e.g. when
1206                   upgrading from older versions), then "N/A" will be
1207                   shown instead
1208                 </para>
1209               </listitem>
1210             </varlistentry>
1211
1212             <varlistentry>
1213               <term>uuid</term>
1214               <listitem>
1215                 <simpara>Show the UUID of the instance (generated
1216                 automatically by Ganeti)</simpara>
1217               </listitem>
1218             </varlistentry>
1219
1220             <varlistentry>
1221               <term>network_port</term>
1222               <listitem>
1223                 <simpara>If the instance has a network port assigned
1224                 to it (e.g. for VNC connections), this will be shown,
1225                 otherwise <literal>-</literal> will be
1226                 displayed.</simpara>
1227               </listitem>
1228             </varlistentry>
1229             <varlistentry>
1230               <term>beparams</term>
1231               <listitem>
1232                 <simpara>A text format of the entire beparams for the
1233                 instance. It's more useful to select individual fields
1234                 from this dictionary, see below.</simpara>
1235               </listitem>
1236             </varlistentry>
1237             <varlistentry>
1238               <term>disk.count</term>
1239               <listitem>
1240                 <simpara>The number of instance disks.</simpara>
1241               </listitem>
1242             </varlistentry>
1243             <varlistentry>
1244               <term>disk.size/N</term>
1245               <listitem>
1246                 <simpara>The size of the instance's Nth disk. This is
1247                 a more generic form of the <literal>sda_size</literal>
1248                 and <literal>sdb_size</literal> fields.</simpara>
1249               </listitem>
1250             </varlistentry>
1251             <varlistentry>
1252               <term>disk.sizes</term>
1253               <listitem>
1254                 <simpara>A comma-separated list of the disk sizes for
1255                 this instance.</simpara>
1256               </listitem>
1257             </varlistentry>
1258             <varlistentry>
1259               <term>disk_usage</term>
1260               <listitem>
1261                 <simpara>The total disk space used by this instance on
1262                 each of its nodes. This is not the instance-visible
1263                 disk size, but the actual disk "cost" of the
1264                 instance.</simpara>
1265               </listitem>
1266             </varlistentry>
1267             <varlistentry>
1268               <term>nic.mac/N</term>
1269               <listitem>
1270                 <simpara>The MAC of the Nth instance NIC.</simpara>
1271               </listitem>
1272             </varlistentry>
1273             <varlistentry>
1274               <term>nic.ip/N</term>
1275               <listitem>
1276                 <simpara>The IP address of the Nth instance NIC.</simpara>
1277               </listitem>
1278             </varlistentry>
1279             <varlistentry>
1280               <term>nic.mode/N</term>
1281               <listitem>
1282                 <simpara>The mode of the Nth instance NIC</simpara>
1283               </listitem>
1284             </varlistentry>
1285             <varlistentry>
1286               <term>nic.link/N</term>
1287               <listitem>
1288                 <simpara>The link of the Nth instance NIC</simpara>
1289               </listitem>
1290             </varlistentry>
1291             <varlistentry>
1292               <term>nic.macs</term>
1293               <listitem>
1294                 <simpara>A comma-separated list of all the MACs of the
1295                 instance's NICs.</simpara>
1296               </listitem>
1297             </varlistentry>
1298             <varlistentry>
1299               <term>nic.ips</term>
1300               <listitem>
1301                 <simpara>A comma-separated list of all the IP
1302                 addresses of the instance's NICs.</simpara>
1303               </listitem>
1304             </varlistentry>
1305             <varlistentry>
1306               <term>nic.modes</term>
1307               <listitem>
1308                 <simpara>A comma-separated list of all the modes of the
1309                 instance's NICs.</simpara>
1310               </listitem>
1311             </varlistentry>
1312             <varlistentry>
1313               <term>nic.links</term>
1314               <listitem>
1315                 <simpara>A comma-separated list of all the link parameters
1316                 of the instance's NICs.</simpara>
1317               </listitem>
1318             </varlistentry>
1319             <varlistentry>
1320               <term>nic.count</term>
1321               <listitem>
1322                 <simpara>The number of instance nics.</simpara>
1323               </listitem>
1324             </varlistentry>
1325             <varlistentry>
1326               <term>hv/<replaceable>NAME</replaceable></term>
1327               <listitem>
1328                 <simpara>The value of the hypervisor parameter called
1329                 <replaceable>NAME</replaceable>. For details of what
1330                 hypervisor parameters exist and their meaning, see the
1331                 <command>add</command> command.</simpara>
1332               </listitem>
1333             </varlistentry>
1334             <varlistentry>
1335               <term>be/memory</term>
1336               <listitem>
1337                 <simpara>The configured memory for the instance.</simpara>
1338               </listitem>
1339             </varlistentry>
1340             <varlistentry>
1341               <term>be/vcpus</term>
1342               <listitem>
1343                 <simpara>The configured number of VCPUs for the
1344                 instance.</simpara>
1345               </listitem>
1346             </varlistentry>
1347             <varlistentry>
1348               <term>be/auto_balance</term>
1349               <listitem>
1350                 <simpara>Whether the instance is considered in N+1
1351                 checks.</simpara>
1352               </listitem>
1353             </varlistentry>
1354           </variablelist>
1355         </para>
1356
1357         <para>
1358           If the value of the option starts with the character
1359           <constant>+</constant>, the new field(s) will be added to the
1360           default list. This allows to quickly see the default list
1361           plus a few other fields, instead of retyping the entire list
1362           of fields.
1363         </para>
1364
1365         <para>
1366           There is a subtle grouping about the available output
1367           fields: all fields except for <option>oper_state</option>,
1368           <option>oper_ram</option> and <option>status</option> are
1369           configuration value and not run-time values. So if you don't
1370           select any of the these fields, the query will be satisfied
1371           instantly from the cluster configuration, without having to
1372           ask the remote nodes for the data. This can be helpful for
1373           big clusters when you only want some data and it makes sense
1374           to specify a reduced set of output fields.
1375         </para>
1376
1377         <para>The default output field list is:
1378           <simplelist type="inline">
1379             <member>name</member>
1380             <member>os</member>
1381             <member>pnode</member>
1382             <member>admin_state</member>
1383             <member>oper_state</member>
1384             <member>oper_ram</member>
1385           </simplelist>.
1386         </para>
1387       </refsect3>
1388
1389       <refsect3>
1390         <title>INFO</title>
1391
1392         <cmdsynopsis>
1393           <command>info</command>
1394           <group>
1395             <arg>-s</arg>
1396             <arg>--static</arg>
1397           </group>
1398           <arg>--roman</arg>
1399           <group choice="req">
1400             <arg>--all</arg>
1401             <arg rep="repeat"><replaceable>instance</replaceable></arg>
1402           </group>
1403         </cmdsynopsis>
1404
1405         <para>
1406           Show detailed information about the given instance(s). This is
1407           different from <command>list</command> as it shows detailed data
1408           about the instance's disks (especially useful for the drbd disk
1409           template).
1410         </para>
1411
1412         <para>
1413           If the option <option>-s</option> is used, only information
1414           available in the configuration file is returned, without
1415           querying nodes, making the operation faster.
1416         </para>
1417
1418         <para>
1419           Use the <option>--all</option> to get info about all instances,
1420           rather than explicitly passing the ones you're interested in.
1421         </para>
1422
1423         <para>
1424           The <option>--roman</option> option can be used to cause envy among
1425           people who like ancient cultures, but are stuck with non-latin-friendly
1426           cluster virtualization technologies.
1427         </para>
1428
1429       </refsect3>
1430
1431       <refsect3>
1432         <title>MODIFY</title>
1433
1434         <cmdsynopsis>
1435           <command>modify</command>
1436           <sbr>
1437           <arg choice="opt">-H <replaceable>HYPERVISOR_PARAMETERS</replaceable></arg>
1438           <sbr>
1439           <arg choice="opt">-B <replaceable>BACKEND_PARAMETERS</replaceable></arg>
1440           <sbr>
1441           <group>
1442             <arg>--net add<replaceable><optional>:options</optional></replaceable></arg>
1443             <arg>--net remove</arg>
1444             <arg>--net <replaceable>N:options</replaceable></arg>
1445           </group>
1446           <sbr>
1447           <group>
1448             <arg>--disk add:size=<replaceable>SIZE</replaceable></arg>
1449             <arg>--disk remove</arg>
1450             <arg>--disk <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></arg>
1451           </group>
1452
1453           <sbr>
1454           <arg>-t<group choice="req">
1455               <arg>plain</arg>
1456               <arg>drbd</arg>
1457             </group></arg>
1458
1459           <sbr>
1460             <arg>--os-name=<replaceable>OS</replaceable> <arg>--force-variant</arg></arg>
1461
1462           <sbr>
1463           <arg>--submit</arg>
1464           <sbr>
1465           <arg choice="req"><replaceable>instance</replaceable></arg>
1466         </cmdsynopsis>
1467
1468         <para>
1469           Modifies the memory size, number of vcpus, ip address, MAC
1470           address and/or nic parameters for an instance. It can also
1471           add and remove disks and NICs to/from the instance. Note
1472           that you need to give at least one of the arguments, otherwise
1473           the command complains.
1474         </para>
1475
1476         <para>
1477           The <option>-H</option> option specifies hypervisor options
1478           in the form of <userinput>name=value[,...]</userinput>. For details which options can be specified, see the <command>add</command> command.
1479         </para>
1480
1481         <para>
1482           The <option>-t</option> option will change the disk template
1483           of the instance. Currently only conversions between the
1484           plain and drbd disk templates are supported, and the
1485           instance must be stopped before attempting the conversion.
1486         </para>
1487
1488         <para>
1489           The <option>--disk
1490           add:size=<replaceable>SIZE</replaceable></option> option
1491           adds a disk to the instance. The <option>--disk
1492           remove</option> will remove the last disk of the
1493           instance. The <option>--disk
1494           <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></option>
1495           option will change the mode of the Nth disk of the instance
1496           between read-only (<literal>ro</literal>) and read-write
1497           (<literal>rw</literal>).
1498         </para>
1499
1500         <para>
1501           The <option>--net
1502           add:<replaceable>options</replaceable></option> option will
1503           add a new NIC to the instance. The available options are the
1504           same as in the <command>add</command> command (mac, ip, link,
1505           mode). The <option>--net remove</option> will remove the
1506           last NIC of the instance, while the <option>--net
1507           <replaceable>N</replaceable>:<replaceable>options</replaceable></option>
1508           option will change the parameters of the Nth instance NIC.
1509         </para>
1510
1511         <para>
1512           The option <option>--os-name</option> will change the OS
1513           name for the instance (without reinstallation). In case an
1514           OS variant is specified that is not found, then by default
1515           the modification is refused,
1516           unless <option>--force-variant</option> is passed. An
1517           invalid OS will also be refused, unless
1518           the <option>--force</option> option is given.
1519         </para>
1520
1521         <para>
1522           The <option>--submit</option> option is used to send the job to
1523           the master daemon but not wait for its completion. The job
1524           ID will be shown so that it can be examined via
1525           <command>gnt-job info</command>.
1526         </para>
1527
1528         <para>
1529           All the changes take effect at the next restart. If the
1530           instance is running, there is no effect on the instance.
1531         </para>
1532       </refsect3>
1533
1534       <refsect3>
1535         <title>REINSTALL</title>
1536
1537         <cmdsynopsis>
1538           <command>reinstall</command>
1539           <arg choice="opt">-o <replaceable>os-type</replaceable></arg>
1540           <arg>--select-os</arg>
1541           <arg choice="opt">-f <replaceable>force</replaceable></arg>
1542           <arg>--force-multiple</arg>
1543           <sbr>
1544           <group choice="opt">
1545             <arg>--instance</arg>
1546             <arg>--node</arg>
1547             <arg>--primary</arg>
1548             <arg>--secondary</arg>
1549             <arg>--all</arg>
1550           </group>
1551           <arg>--submit</arg>
1552           <arg choice="opt" rep="repeat"><replaceable>instance</replaceable></arg>
1553         </cmdsynopsis>
1554
1555         <para>
1556           Reinstalls the operating system on the given instance(s). The
1557           instance(s) must be stopped when running this command. If the
1558           <option>--os-type</option> is specified, the operating
1559           system is changed.
1560         </para>
1561
1562         <para>
1563           The <option>--select-os</option> option switches to an
1564           interactive OS reinstall. The user is prompted to select the OS
1565           template from the list of available OS templates.
1566         </para>
1567
1568         <para>
1569           Since this is a potentially dangerous command, the user will
1570           be required to confirm this action, unless the
1571           <option>-f</option> flag is passed. When multiple instances
1572           are selected (either by passing multiple arguments or by
1573           using the <option>--node</option>,
1574           <option>--primary</option>, <option>--secondary</option> or
1575           <option>--all</option> options), the user must pass both the
1576           <option>--force</option> and
1577           <option>--force-multiple</option> options to skip the
1578           interactive confirmation.
1579         </para>
1580
1581         <para>
1582           The <option>--submit</option> option is used to send the job to
1583           the master daemon but not wait for its completion. The job
1584           ID will be shown so that it can be examined via
1585           <command>gnt-job info</command>.
1586         </para>
1587
1588
1589       </refsect3>
1590
1591       <refsect3>
1592         <title>RENAME</title>
1593
1594         <cmdsynopsis>
1595           <command>rename</command>
1596           <arg>--no-ip-check</arg>
1597           <arg>--submit</arg>
1598           <arg choice="req"><replaceable>instance</replaceable></arg>
1599           <arg choice="req"><replaceable>new_name</replaceable></arg>
1600         </cmdsynopsis>
1601
1602         <para>
1603           Renames the given instance. The instance must be stopped
1604           when running this command. The requirements for the new name
1605           are the same as for adding an instance: the new name must be
1606           resolvable and the IP it resolves to must not be reachable
1607           (in order to prevent duplicate IPs the next time the
1608           instance is started). The IP test can be skipped if the
1609           <option>--no-ip-check</option> option is passed.
1610         </para>
1611
1612         <para>
1613           The <option>--submit</option> option is used to send the job to
1614           the master daemon but not wait for its completion. The job
1615           ID will be shown so that it can be examined via
1616           <command>gnt-job info</command>.
1617         </para>
1618
1619       </refsect3>
1620
1621     </refsect2>
1622
1623     <refsect2>
1624       <title>Starting/stopping/connecting to console</title>
1625
1626       <refsect3>
1627         <title>STARTUP</title>
1628
1629         <cmdsynopsis>
1630           <command>startup</command>
1631           <sbr>
1632           <arg>--force</arg>
1633           <sbr>
1634           <arg>--force-multiple</arg>
1635           <sbr>
1636           <group choice="opt">
1637             <arg>--instance</arg>
1638             <arg>--node</arg>
1639             <arg>--primary</arg>
1640             <arg>--secondary</arg>
1641             <arg>--all</arg>
1642             <arg>--tags</arg>
1643             <arg>--node-tags</arg>
1644             <arg>--pri-node-tags</arg>
1645             <arg>--sec-node-tags</arg>
1646           </group>
1647           <sbr>
1648           <arg>-H <option>key=value...</option></arg>
1649           <arg>-B <option>key=value...</option></arg>
1650           <sbr>
1651           <arg>--submit</arg>
1652           <sbr>
1653           <arg choice="opt"
1654           rep="repeat"><replaceable>name</replaceable></arg>
1655         </cmdsynopsis>
1656
1657         <para>
1658           Starts one or more instances, depending on the following
1659           options. The four available modes are:
1660           <variablelist>
1661             <varlistentry>
1662               <term><option>--instance</option></term>
1663               <listitem>
1664                 <simpara>will start the instances given as arguments
1665                 (at least one argument required); this is the default
1666                 selection</simpara>
1667               </listitem>
1668             </varlistentry>
1669             <varlistentry>
1670               <term>--node</term>
1671               <listitem>
1672                 <simpara>will start the instances who have the given
1673                 node as either primary or secondary</simpara>
1674               </listitem>
1675             </varlistentry>
1676             <varlistentry>
1677               <term><option>--primary</option></term>
1678               <listitem>
1679                 <simpara>will start all instances whose primary node
1680                 is in the list of nodes passed as arguments (at least
1681                 one node required)</simpara>
1682               </listitem>
1683             </varlistentry>
1684             <varlistentry>
1685               <term><option>--secondary</option></term>
1686               <listitem>
1687                 <simpara>will start all instances whose secondary node
1688                 is in the list of nodes passed as arguments (at least
1689                 one node required)</simpara>
1690               </listitem>
1691             </varlistentry>
1692             <varlistentry>
1693               <term>--all</term>
1694               <listitem>
1695                 <simpara>will start all instances in the cluster (no
1696                 arguments accepted)</simpara>
1697               </listitem>
1698             </varlistentry>
1699             <varlistentry>
1700               <term>--tags</term>
1701               <listitem>
1702                 <simpara>will start all instances in the cluster with
1703                 the tags given as arguments</simpara>
1704               </listitem>
1705             </varlistentry>
1706             <varlistentry>
1707               <term>--node-tags</term>
1708               <listitem>
1709                 <simpara>will start all instances in the cluster on
1710                 nodes with the tags given as arguments</simpara>
1711               </listitem>
1712             </varlistentry>
1713             <varlistentry>
1714               <term>--pri-node-tags</term>
1715               <listitem>
1716                 <simpara>will start all instances in the cluster on
1717                 primary nodes with the tags given as
1718                 arguments</simpara>
1719               </listitem>
1720             </varlistentry>
1721             <varlistentry>
1722               <term>--sec-node-tags</term>
1723               <listitem>
1724                 <simpara>will start all instances in the cluster on
1725                 secondary nodes with the tags given as
1726                 arguments</simpara>
1727               </listitem>
1728             </varlistentry>
1729           </variablelist>
1730         </para>
1731
1732         <para>
1733           Note that although you can pass more than one selection
1734           option, the last one wins, so in order to guarantee the
1735           desired result, don't pass more than one such option.
1736         </para>
1737
1738         <para>
1739           Use <option>--force</option> to start even if secondary disks are
1740           failing.
1741         </para>
1742
1743         <para>
1744           The <option>--force-multiple</option> will skip the
1745           interactive confirmation in the case the more than one
1746           instance will be affected.
1747         </para>
1748
1749         <para>
1750           The <option>-H</option> and <option>-B</option> options
1751           specify temporary hypervisor and backend parameters that can
1752           be used to start an instance with modified parameters. They
1753           can be useful for quick testing without having to modify an
1754           instance back and forth, e.g.:
1755           <screen>
1756 # gnt-instance start -H root_args="single" instance1
1757 # gnt-instance start -B memory=2048 instance2
1758           </screen>
1759           The first form will start the instance
1760           <userinput>instance1</userinput> in single-user mode, and
1761           the instance <userinput>instance2</userinput> with 2GB of
1762           RAM (this time only, unless that is the actual instance
1763           memory size already). Note that the values override the
1764           instance parameters (and not extend them): an instance with
1765           "root_args=ro" when started with <userinput>-H
1766           root_args=single</userinput> will result in "single", not
1767           "ro single".
1768         </para>
1769
1770         <para>
1771           The <option>--submit</option> option is used to send the job to
1772           the master daemon but not wait for its completion. The job
1773           ID will be shown so that it can be examined via
1774           <command>gnt-job info</command>.
1775         </para>
1776
1777         <para>
1778           Example:
1779           <screen>
1780 # gnt-instance start instance1.example.com
1781 # gnt-instance start --node node1.example.com node2.example.com
1782 # gnt-instance start --all
1783           </screen>
1784         </para>
1785       </refsect3>
1786
1787       <refsect3>
1788         <title>SHUTDOWN</title>
1789
1790         <cmdsynopsis>
1791           <command>shutdown</command>
1792           <sbr>
1793           <arg>--timeout=<replaceable>N</replaceable></arg>
1794           <sbr>
1795           <arg>--force-multiple</arg>
1796           <sbr>
1797           <group choice="opt">
1798             <arg>--instance</arg>
1799             <arg>--node</arg>
1800             <arg>--primary</arg>
1801             <arg>--secondary</arg>
1802             <arg>--all</arg>
1803             <arg>--tags</arg>
1804             <arg>--node-tags</arg>
1805             <arg>--pri-node-tags</arg>
1806             <arg>--sec-node-tags</arg>
1807           </group>
1808           <sbr>
1809           <arg>--submit</arg>
1810           <sbr>
1811           <arg choice="opt"
1812           rep="repeat"><replaceable>name</replaceable></arg>
1813         </cmdsynopsis>
1814
1815         <para>
1816           Stops one or more instances. If the instance cannot be
1817           cleanly stopped during a hardcoded interval (currently 2
1818           minutes), it will forcibly stop the instance (equivalent to
1819           switching off the power on a physical machine).
1820         </para>
1821
1822         <para>
1823           The <option>--timeout</option> is used to specify how much time to
1824           wait before forcing the shutdown (xm destroy in xen, killing the kvm
1825           process, for kvm). By default two minutes are given to each instance
1826           to stop.
1827         </para>
1828
1829         <para>
1830           The <option>--instance</option>, <option>--node</option>,
1831           <option>--primary</option>, <option>--secondary</option>,
1832           <option>--all</option>, <option>--tags</option>,
1833           <option>--node-tags</option>, <option>--pri-node-tags</option> and
1834           <option>--sec-node-tags</option> options are similar as for the
1835           <command>startup</command> command and they influence the
1836           actual instances being shutdown.
1837         </para>
1838
1839         <para>
1840           The <option>--submit</option> option is used to send the job to
1841           the master daemon but not wait for its completion. The job
1842           ID will be shown so that it can be examined via
1843           <command>gnt-job info</command>.
1844         </para>
1845
1846
1847         <para>
1848           Example:
1849           <screen>
1850 # gnt-instance shutdown instance1.example.com
1851 # gnt-instance shutdown --all
1852           </screen>
1853         </para>
1854       </refsect3>
1855
1856       <refsect3>
1857         <title>REBOOT</title>
1858
1859         <cmdsynopsis>
1860           <command>reboot</command>
1861           <sbr>
1862           <arg>--type=<replaceable>REBOOT-TYPE</replaceable></arg>
1863           <sbr>
1864           <arg>--ignore-secondaries</arg>
1865           <sbr>
1866           <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
1867           <sbr>
1868           <arg>--force-multiple</arg>
1869           <sbr>
1870           <group choice="opt">
1871             <arg>--instance</arg>
1872             <arg>--node</arg>
1873             <arg>--primary</arg>
1874             <arg>--secondary</arg>
1875             <arg>--all</arg>
1876             <arg>--tags</arg>
1877             <arg>--node-tags</arg>
1878             <arg>--pri-node-tags</arg>
1879             <arg>--sec-node-tags</arg>
1880           </group>
1881           <sbr>
1882           <arg>--submit</arg>
1883           <sbr>
1884           <arg choice="opt"
1885           rep="repeat"><replaceable>name</replaceable></arg>
1886         </cmdsynopsis>
1887
1888         <para>
1889           Reboots one or more instances. The type of reboot depends on
1890           the value of <option>--type</option>. A soft reboot does a
1891           hypervisor reboot, a hard reboot does a instance stop,
1892           recreates the hypervisor config for the instance and
1893           starts the instance. A full reboot does the equivalent
1894           of <command>gnt-instance shutdown &amp;&amp; gnt-instance
1895           startup</command>. The default is hard reboot.
1896         </para>
1897
1898         <para>
1899           For the hard reboot the option
1900           <option>--ignore-secondaries</option> ignores errors for the
1901           secondary node while re-assembling the instance disks.
1902         </para>
1903
1904         <para>
1905           The <option>--instance</option>, <option>--node</option>,
1906           <option>--primary</option>, <option>--secondary</option>,
1907           <option>--all</option>, <option>--tags</option>,
1908           <option>--node-tags</option>, <option>--pri-node-tags</option> and
1909           <option>--sec-node-tags</option> options are similar as for the
1910           <command>startup</command> command and they influence the
1911           actual instances being rebooted.
1912         </para>
1913
1914         <para>
1915           The <option>--shutdown-timeout</option> is used to specify how
1916           much time to wait before forcing the shutdown (xm destroy in xen,
1917           killing the kvm process, for kvm). By default two minutes are
1918           given to each instance to stop.
1919         </para>
1920
1921         <para>
1922           The <option>--force-multiple</option> will skip the
1923           interactive confirmation in the case the more than one
1924           instance will be affected.
1925         </para>
1926
1927         <para>
1928           Example:
1929           <screen>
1930 # gnt-instance reboot instance1.example.com
1931 # gnt-instance reboot --type=full instance1.example.com
1932           </screen>
1933         </para>
1934       </refsect3>
1935
1936       <refsect3>
1937         <title>CONSOLE</title>
1938         <cmdsynopsis>
1939           <command>console</command>
1940           <arg choice="opt">--show-cmd</arg>
1941           <arg choice="req"><replaceable>instance</replaceable></arg>
1942         </cmdsynopsis>
1943
1944         <para>
1945           Connects to the console of the given instance. If the
1946           instance is not up, an error is returned. Use the
1947           <option>--show-cmd</option> option to display the command
1948           instead of executing it.
1949         </para>
1950
1951         <para>
1952           For HVM instances, this will attempt to connect to the
1953           serial console of the instance. To connect to the
1954           virtualized "physical" console of a HVM instance, use a VNC
1955           client with the connection info from the
1956           <command>info</command> command.
1957         </para>
1958
1959         <para>
1960           Example:
1961           <screen>
1962 # gnt-instance console instance1.example.com
1963           </screen>
1964         </para>
1965       </refsect3>
1966
1967     </refsect2>
1968
1969     <refsect2>
1970       <title>Disk management</title>
1971
1972       <refsect3>
1973         <title>REPLACE-DISKS</title>
1974
1975         <cmdsynopsis>
1976           <command>replace-disks</command>
1977           <arg>--submit</arg>
1978           <arg>--early-release</arg>
1979           <arg choice="req">-p</arg>
1980           <arg>--disks <replaceable>idx</replaceable></arg>
1981           <arg choice="req"><replaceable>instance</replaceable></arg>
1982         </cmdsynopsis>
1983
1984         <cmdsynopsis>
1985           <command>replace-disks</command>
1986           <arg>--submit</arg>
1987           <arg>--early-release</arg>
1988           <arg choice="req">-s</arg>
1989           <arg>--disks <replaceable>idx</replaceable></arg>
1990           <arg choice="req"><replaceable>instance</replaceable></arg>
1991         </cmdsynopsis>
1992
1993         <cmdsynopsis>
1994           <command>replace-disks</command>
1995           <arg>--submit</arg>
1996           <arg>--early-release</arg>
1997           <group choice="req">
1998             <arg>--iallocator <replaceable>name</replaceable></arg>
1999             <arg>--new-secondary <replaceable>NODE</replaceable></arg>
2000           </group>
2001
2002           <arg choice="req"><replaceable>instance</replaceable></arg>
2003         </cmdsynopsis>
2004
2005         <cmdsynopsis>
2006           <command>replace-disks</command>
2007           <arg>--submit</arg>
2008           <arg>--early-release</arg>
2009           <arg choice="req">--auto</arg>
2010           <arg choice="req"><replaceable>instance</replaceable></arg>
2011         </cmdsynopsis>
2012
2013         <para>
2014           This command is a generalized form for replacing disks. It
2015           is currently only valid for the mirrored (DRBD) disk
2016           template.
2017         </para>
2018
2019         <para>
2020           The first form (when passing the <option>-p</option> option)
2021           will replace the disks on the primary, while the second form
2022           (when passing the <option>-s</option> option will replace
2023           the disks on the secondary node. For these two cases (as the
2024           node doesn't change), it is possible to only run the replace
2025           for a subset of the disks, using the option
2026           <option>--disks</option> which takes a list of
2027           comma-delimited disk indices (zero-based),
2028           e.g. <userinput>0,2</userinput> to replace only the first
2029           and third disks.
2030         </para>
2031
2032         <para>
2033           The third form (when passing either the
2034           <option>--iallocator</option> or the
2035           <option>--new-secondary</option> option) is designed to
2036           change secondary node of the instance.  Specifying
2037           <option>--iallocator</option> makes the new secondary be
2038           selected automatically by the specified allocator plugin,
2039           otherwise the new secondary node will be the one chosen
2040           manually via the <option>--new-secondary</option> option.
2041         </para>
2042
2043         <para>
2044           The fourth form (when using <option>--auto</option>) will
2045           automatically determine which disks of an instance are faulty and
2046           replace them within the same node. The <option>--auto</option>
2047           option works only when an instance has only faulty disks on
2048           either the primary or secondary node; it doesn't work when
2049           both sides have faulty disks.
2050         </para>
2051
2052         <para>
2053           The <option>--submit</option> option is used to send the job to
2054           the master daemon but not wait for its completion. The job
2055           ID will be shown so that it can be examined via
2056           <command>gnt-job info</command>.
2057         </para>
2058
2059         <para>
2060           The <option>--early-release</option> changes the code so
2061           that the old storage on secondary node(s) is removed early
2062           (before the resync is completed) and the internal Ganeti
2063           locks for the current (and new, if any) secondary node are
2064           also released, thus allowing more parallelism in the cluster
2065           operation. This should be used only when recovering from a
2066           disk failure on the current secondary (thus the old storage
2067           is already broken) or when the storage on the primary node
2068           is known to be fine (thus we won't need the old storage for
2069           potential recovery).
2070         </para>
2071
2072         <para>
2073           Note that it is not possible to select an offline or drained
2074           node as a new secondary.
2075         </para>
2076
2077       </refsect3>
2078
2079       <refsect3>
2080         <title>ACTIVATE-DISKS</title>
2081
2082         <cmdsynopsis>
2083           <command>activate-disks</command>
2084           <arg>--submit</arg>
2085           <arg>--ignore-size</arg>
2086           <arg choice="req"><replaceable>instance</replaceable></arg>
2087         </cmdsynopsis>
2088         <para>
2089           Activates the block devices of the given instance. If
2090           successful, the command will show the location and name of
2091           the block devices:
2092           <screen>
2093 node1.example.com:disk/0:/dev/drbd0
2094 node1.example.com:disk/1:/dev/drbd1
2095           </screen>
2096
2097           In this example, <emphasis>node1.example.com</emphasis> is
2098           the name of the node on which the devices have been
2099           activated. The <emphasis>disk/0</emphasis> and
2100           <emphasis>disk/1</emphasis> are the Ganeti-names of the
2101           instance disks; how they are visible inside the instance is
2102           hypervisor-specific. <emphasis>/dev/drbd0</emphasis> and
2103           <emphasis>/dev/drbd1</emphasis> are the actual block devices
2104           as visible on the node.
2105         </para>
2106
2107         <para>
2108           The <option>--submit</option> option is used to send the job to
2109           the master daemon but not wait for its completion. The job
2110           ID will be shown so that it can be examined via
2111           <command>gnt-job info</command>.
2112         </para>
2113
2114         <para>
2115           The <option>--ignore-size</option> option can be used to
2116           activate disks ignoring the currently configured size in
2117           Ganeti. This can be used in cases where the configuration
2118           has gotten out of sync with the real-world (e.g. after a
2119           partially-failed grow-disk operation or due to rounding in
2120           LVM devices). This should not be used in normal cases, but
2121           only when activate-disks fails without it.
2122         </para>
2123
2124         <para>
2125           Note that it is safe to run this command while the instance
2126           is already running.
2127         </para>
2128       </refsect3>
2129
2130       <refsect3>
2131         <title>DEACTIVATE-DISKS</title>
2132
2133         <cmdsynopsis>
2134           <command>deactivate-disks</command>
2135           <arg>--submit</arg>
2136           <arg choice="req"><replaceable>instance</replaceable></arg>
2137         </cmdsynopsis>
2138         <para>
2139           De-activates the block devices of the given instance. Note
2140           that if you run this command for an instance with a drbd
2141           disk template, while it is running, it will not be able to
2142           shutdown the block devices on the primary node, but it will
2143           shutdown the block devices on the secondary nodes, thus
2144           breaking the replication.
2145         </para>
2146
2147         <para>
2148           The <option>--submit</option> option is used to send the job to
2149           the master daemon but not wait for its completion. The job
2150           ID will be shown so that it can be examined via
2151           <command>gnt-job info</command>.
2152         </para>
2153
2154       </refsect3>
2155
2156       <refsect3>
2157         <title>GROW-DISK</title>
2158         <cmdsynopsis>
2159           <command>grow-disk</command>
2160           <arg>--no-wait-for-sync</arg>
2161           <arg>--submit</arg>
2162           <arg choice="req"><replaceable>instance</replaceable></arg>
2163           <arg choice="req"><replaceable>disk</replaceable></arg>
2164           <arg choice="req"><replaceable>amount</replaceable></arg>
2165         </cmdsynopsis>
2166
2167         <para>
2168           Grows an instance's disk. This is only possible for
2169           instances having a <literal>plain</literal> or
2170           <literal>drbd</literal> disk template.
2171         </para>
2172
2173         <para>
2174           Note that this command only change the block device size; it
2175           will not grow the actual filesystems, partitions, etc. that
2176           live on that disk. Usually, you will need to:
2177           <orderedlist>
2178             <listitem>
2179               <simpara>use <command>gnt-instance grow-disk</command></simpara>
2180             </listitem>
2181             <listitem>
2182               <simpara>reboot the instance (later, at a convenient
2183               time)</simpara>
2184             </listitem>
2185             <listitem>
2186               <simpara>use a filesystem resizer, such as
2187               <citerefentry> <refentrytitle>ext2online</refentrytitle>
2188               <manvolnum>8</manvolnum> </citerefentry> or
2189               <citerefentry> <refentrytitle>xfs_growfs</refentrytitle>
2190               <manvolnum>8</manvolnum> </citerefentry> to resize the
2191               filesystem, or use <citerefentry>
2192               <refentrytitle>fdisk</refentrytitle>
2193               <manvolnum>8</manvolnum> </citerefentry> to change the
2194               partition table on the disk
2195               </simpara>
2196             </listitem>
2197           </orderedlist>
2198         </para>
2199
2200
2201         <para>
2202           The <replaceable>disk</replaceable> argument is the index of
2203           the instance disk to grow. The
2204           <replaceable>amount</replaceable> argument is given either
2205           as a number (and it represents the amount to increase the
2206           disk with in mebibytes) or can be given similar to the
2207           arguments in the create instance operation, with a suffix
2208           denoting the unit.
2209         </para>
2210
2211         <para>
2212           Note that the disk grow operation might complete on one node
2213           but fail on the other; this will leave the instance with
2214           different-sized LVs on the two nodes, but this will not
2215           create problems (except for unused space).
2216         </para>
2217
2218         <para>
2219           If you do not want gnt-instance to wait for the new disk
2220           region to be synced, use the
2221           <option>--no-wait-for-sync</option> option.
2222         </para>
2223
2224         <para>
2225           The <option>--submit</option> option is used to send the job to
2226           the master daemon but not wait for its completion. The job
2227           ID will be shown so that it can be examined via
2228           <command>gnt-job info</command>.
2229         </para>
2230
2231
2232         <para>Example (increase the first disk for instance1 by 16GiB):
2233           <screen>
2234 # gnt-instance grow-disk instance1.example.com 0 16g
2235           </screen>
2236         </para>
2237
2238         <para>
2239           Also note that disk shrinking is not supported; use
2240           <command>gnt-backup export</command> and then
2241           <command>gnt-backup import</command> to reduce the disk size
2242           of an instance.
2243         </para>
2244       </refsect3>
2245
2246       <refsect3>
2247         <title>RECREATE-DISKS</title>
2248
2249         <cmdsynopsis>
2250           <command>recreate-disks</command>
2251           <arg>--submit</arg>
2252           <arg>--disks=<option>indices</option></arg>
2253           <arg choice="req"><replaceable>instance</replaceable></arg>
2254         </cmdsynopsis>
2255         <para>
2256           Recreates the disks of the given instance, or only a subset
2257           of the disks (if the option <option>disks</option> is
2258           passed, which must be a comma-separated list of disk
2259           indices, starting from zero).
2260         </para>
2261
2262         <para>
2263           Note that this functionality should only be used for missing
2264           disks; if any of the given disks already exists, the
2265           operation will fail. While this is suboptimal,
2266           recreate-disks should hopefully not be needed in normal
2267           operation and as such the impact of this is low.
2268         </para>
2269
2270         <para>
2271           The <option>--submit</option> option is used to send the job to
2272           the master daemon but not wait for its completion. The job
2273           ID will be shown so that it can be examined via
2274           <command>gnt-job info</command>.
2275         </para>
2276
2277       </refsect3>
2278
2279     </refsect2>
2280
2281     <refsect2>
2282       <title>Recovery</title>
2283
2284       <refsect3>
2285         <title>FAILOVER</title>
2286
2287         <cmdsynopsis>
2288           <command>failover</command>
2289           <arg>-f</arg>
2290           <arg>--ignore-consistency</arg>
2291           <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
2292           <arg>--submit</arg>
2293           <arg choice="req"><replaceable>instance</replaceable></arg>
2294         </cmdsynopsis>
2295
2296         <para>
2297           Failover will fail the instance over its secondary
2298           node. This works only for instances having a drbd disk
2299           template.
2300         </para>
2301
2302         <para>
2303           Normally the failover will check the consistency of the
2304           disks before failing over the instance. If you are trying to
2305           migrate instances off a dead node, this will fail. Use the
2306           <option>--ignore-consistency</option> option for this
2307           purpose. Note that this option can be dangerous as errors in
2308           shutting down the instance will be ignored, resulting in
2309           possibly having the instance running on two machines in
2310           parallel (on disconnected DRBD drives).
2311         </para>
2312
2313         <para>
2314           The <option>--shutdown-timeout</option> is used to specify how
2315           much time to wait before forcing the shutdown (xm destroy in xen,
2316           killing the kvm process, for kvm). By default two minutes are
2317           given to each instance to stop.
2318         </para>
2319
2320         <para>
2321           The <option>--submit</option> option is used to send the job to
2322           the master daemon but not wait for its completion. The job
2323           ID will be shown so that it can be examined via
2324           <command>gnt-job info</command>.
2325         </para>
2326
2327         <para>
2328           Example:
2329           <screen>
2330 # gnt-instance failover instance1.example.com
2331           </screen>
2332         </para>
2333       </refsect3>
2334
2335       <refsect3>
2336         <title>MIGRATE</title>
2337
2338         <cmdsynopsis>
2339           <command>migrate</command>
2340           <arg>-f</arg>
2341           <arg choice="req">--cleanup</arg>
2342           <arg choice="req"><replaceable>instance</replaceable></arg>
2343         </cmdsynopsis>
2344
2345         <cmdsynopsis>
2346           <command>migrate</command>
2347           <arg>-f</arg>
2348           <arg>--non-live</arg>
2349           <arg choice="req"><replaceable>instance</replaceable></arg>
2350         </cmdsynopsis>
2351
2352         <para>
2353           Migrate will move the instance to its secondary node without
2354           shutdown. It only works for instances having the drbd8 disk
2355           template type.
2356         </para>
2357
2358         <para>
2359           The migration command needs a perfectly healthy instance, as
2360           we rely on the dual-master capability of drbd8 and the disks
2361           of the instance are not allowed to be degraded.
2362         </para>
2363
2364         <para>
2365           The <option>--non-live</option> option will switch (for the
2366           hypervisors that support it) between a "fully live"
2367           (i.e. the interruption is as minimal as possible) migration
2368           and one in which the instance is frozen, its state saved and
2369           transported to the remote node, and then resumed there. This
2370           all depends on the hypervisor support for two different
2371           methods. In any case, it is not an error to pass this
2372           parameter (it will just be ignored if the hypervisor doesn't
2373           support it).
2374         </para>
2375
2376         <para>
2377           If the <option>--cleanup</option> option is passed, the
2378           operation changes from migration to attempting recovery from
2379           a failed previous migration. In this mode, ganeti checks if
2380           the instance runs on the correct node (and updates its
2381           configuration if not) and ensures the instances's disks are
2382           configured correctly. In this mode, the
2383           <option>--non-live</option> option is ignored.
2384         </para>
2385
2386         <para>
2387           The option <option>-f</option> will skip the prompting for
2388           confirmation.
2389         </para>
2390         <para>
2391           Example (and expected output):
2392           <screen>
2393 # gnt-instance migrate instance1
2394 Migrate will happen to the instance instance1. Note that migration is
2395 **experimental** in this version. This might impact the instance if
2396 anything goes wrong. Continue?
2397 y/[n]/?: y
2398 * checking disk consistency between source and target
2399 * ensuring the target is in secondary mode
2400 * changing disks into dual-master mode
2401  - INFO: Waiting for instance instance1 to sync disks.
2402  - INFO: Instance instance1's disks are in sync.
2403 * migrating instance to node2.example.com
2404 * changing the instance's disks on source node to secondary
2405  - INFO: Waiting for instance instance1 to sync disks.
2406  - INFO: Instance instance1's disks are in sync.
2407 * changing the instance's disks to single-master
2408 #
2409           </screen>
2410         </para>
2411       </refsect3>
2412
2413       <refsect3>
2414         <title>MOVE</title>
2415
2416         <cmdsynopsis>
2417           <command>move</command>
2418           <arg>-f</arg>
2419           <arg>-n <replaceable>node</replaceable></arg>
2420           <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
2421           <arg>--submit</arg>
2422           <arg choice="req"><replaceable>instance</replaceable></arg>
2423         </cmdsynopsis>
2424
2425         <para>
2426           Move will move the instance to an arbitrary node in the
2427           cluster. This works only for instances having a plain or
2428           file disk template.
2429         </para>
2430
2431         <para>
2432           Note that since this operation is done via data copy, it
2433           will take a long time for big disks (similar to
2434           replace-disks for a drbd instance).
2435         </para>
2436
2437         <para>
2438           The <option>--shutdown-timeout</option> is used to specify how
2439           much time to wait before forcing the shutdown (xm destroy in xen,
2440           killing the kvm process, for kvm). By default two minutes are
2441           given to each instance to stop.
2442         </para>
2443
2444         <para>
2445           The <option>--submit</option> option is used to send the job to
2446           the master daemon but not wait for its completion. The job
2447           ID will be shown so that it can be examined via
2448           <command>gnt-job info</command>.
2449         </para>
2450
2451         <para>
2452           Example:
2453           <screen>
2454 # gnt-instance move -n node3.example.com instance1.example.com
2455           </screen>
2456         </para>
2457       </refsect3>
2458
2459     </refsect2>
2460
2461     <refsect2>
2462       <title>TAGS</title>
2463
2464     <refsect3>
2465         <title>ADD-TAGS</title>
2466
2467         <cmdsynopsis>
2468           <command>add-tags</command>
2469           <arg choice="opt">--from <replaceable>file</replaceable></arg>
2470           <arg choice="req"><replaceable>instancename</replaceable></arg>
2471           <arg choice="req"
2472             rep="repeat"><replaceable>tag</replaceable></arg>
2473         </cmdsynopsis>
2474
2475         <para>
2476           Add tags to the given instance. If any of the tags contains
2477           invalid characters, the entire operation will abort.
2478         </para>
2479         <para>
2480           If the <option>--from</option> option is given, the list of
2481           tags will be extended with the contents of that file (each
2482           line becomes a tag). In this case, there is not need to pass
2483           tags on the command line (if you do, both sources will be
2484           used). A file name of - will be interpreted as stdin.
2485         </para>
2486       </refsect3>
2487
2488       <refsect3>
2489         <title>LIST-TAGS</title>
2490
2491         <cmdsynopsis>
2492           <command>list-tags</command>
2493           <arg choice="req"><replaceable>instancename</replaceable></arg>
2494         </cmdsynopsis>
2495
2496         <para>List the tags of the given instance.</para>
2497       </refsect3>
2498
2499       <refsect3>
2500         <title>REMOVE-TAGS</title>
2501         <cmdsynopsis>
2502           <command>remove-tags</command>
2503           <arg choice="opt">--from <replaceable>file</replaceable></arg>
2504           <arg choice="req"><replaceable>instancename</replaceable></arg>
2505           <arg choice="req"
2506             rep="repeat"><replaceable>tag</replaceable></arg>
2507         </cmdsynopsis>
2508
2509         <para>
2510           Remove tags from the given instance. If any of the tags are
2511           not existing on the node, the entire operation will abort.
2512         </para>
2513
2514         <para>
2515           If the <option>--from</option> option is given, the list of
2516           tags will be extended with the contents of that file (each
2517           line becomes a tag). In this case, there is not need to pass
2518           tags on the command line (if you do, both sources will be
2519           used). A file name of - will be interpreted as stdin.
2520         </para>
2521       </refsect3>
2522
2523     </refsect2>
2524
2525   </refsect1>
2526
2527   &footer;
2528
2529 </refentry>
2530
2531 <!-- Keep this comment at the end of the file
2532 Local variables:
2533 mode: sgml
2534 sgml-omittag:t
2535 sgml-shorttag:t
2536 sgml-minimize-attributes:nil
2537 sgml-always-quote-attributes:t
2538 sgml-indent-step:2
2539 sgml-indent-data:t
2540 sgml-parent-document:nil
2541 sgml-default-dtd-file:nil
2542 sgml-exposed-tags:nil
2543 sgml-local-catalogs:nil
2544 sgml-local-ecat-files:nil
2545 End:
2546 -->