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>June 08, 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.2</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
 637                 to 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>use_chroot</term>
 663               <listitem>
 664                 <simpara>Valid for the KVM hypervisor.</simpara>
 665
 666                 <simpara>This boolean option determines wether to run the KVM
 667                 instance in a chroot directory.
 668                 </simpara>
 669                 <para>If it is set to <quote>true</quote>, an empty directory
 670                 is created before starting the instance and its path is passed via
 671                 the -chroot flag to kvm.
 672                 The directory is removed when the instance is stopped.
 673                 </para>
 674
 675                 <simpara>It is set to <quote>false</quote> by default.</simpara>
 676               </listitem>
 677             </varlistentry>
 678
 679             <varlistentry>
 680               <term>migration_downtime</term>
 681               <listitem>
 682                 <simpara>Valid for the KVM hypervisor.</simpara>
 683
 684                 <simpara>The maximum amount of time (in ms) a KVM instance is
 685                 allowed to be frozen during a live migration, in order to copy
 686                 dirty memory pages. Default value is 30ms, but you may need to
 687                 increase this value for busy instances.
 688                 </simpara>
 689
 690                 <simpara>This option is only effective with kvm versions >= 87
 691                 and qemu-kvm versions >= 0.11.0.
 692                 </simpara>
 693               </listitem>
 694             </varlistentry>
 695
 696             <varlistentry>
 697               <term>use_chroot</term>
 698               <listitem>
 699                 <simpara>Valid for the KVM hypervisor.</simpara>
 700
 701                 <simpara>This boolean option determines wether to run the KVM
 702                 instance in a chroot directory.
 703                 </simpara>
 704                 <para>If it is set to <quote>true</quote>, an empty directory
 705                 is created before starting the instance and its path is passed
 706                 via the <option>-chroot</option> flag to kvm.
 707                 The directory is removed when the instance is stopped.
 708                 </para>
 709
 710                 <simpara>It is set to <quote>false</quote> by default.</simpara>
 711               </listitem>
 712             </varlistentry>
 713
 714           </variablelist>
 715
 716         </para>
 717
 718         <para>
 719           The <option>--iallocator</option> option specifies the instance
 720           allocator plugin to use. If you pass in this option the allocator
 721           will select nodes for this instance automatically, so you don't need
 722           to pass them with the <option>-n</option> option. For more
 723           information please refer to the instance allocator documentation.
 724         </para>
 725
 726         <para>
 727           The <option>-t</option> options specifies the disk layout type for
 728           the instance. The available choices are:
 729           <variablelist>
 730             <varlistentry>
 731               <term>diskless</term>
 732               <listitem>
 733                 <para>
 734                   This creates an instance with no disks. Its useful for
 735                   testing only (or other special cases).
 736                 </para>
 737               </listitem>
 738             </varlistentry>
 739             <varlistentry>
 740               <term>file</term>
 741               <listitem>
 742                 <para>Disk devices will be regular files.</para>
 743               </listitem>
 744             </varlistentry>
 745             <varlistentry>
 746               <term>plain</term>
 747               <listitem>
 748                 <para>Disk devices will be logical volumes.</para>
 749               </listitem>
 750             </varlistentry>
 751             <varlistentry>
 752               <term>drbd</term>
 753               <listitem>
 754                 <para>
 755                   Disk devices will be drbd (version 8.x) on top of
 756                   lvm volumes.
 757                 </para>
 758               </listitem>
 759             </varlistentry>
 760           </variablelist>
 761         </para>
 762
 763         <para>
 764           The optional second value of the <option>--node</option> is used for
 765           the drbd template type and specifies the remote node.
 766         </para>
 767
 768         <para>
 769           If you do not want gnt-instance to wait for the disk mirror
 770           to be synced, use the <option>--no-wait-for-sync</option>
 771           option.
 772         </para>
 773
 774         <para>
 775           The <option>--file-storage-dir</option> specifies the relative path
 776           under the cluster-wide file storage directory to store file-based
 777           disks. It is useful for having different subdirectories for
 778           different instances. The full path of the directory where the disk
 779           files are stored will consist of cluster-wide file storage directory
 780           + optional subdirectory + instance name. Example:
 781           /srv/ganeti/file-storage/mysubdir/instance1.example.com. This option
 782           is only relevant for instances using the file storage backend.
 783         </para>
 784
 785         <para>
 786           The <option>--file-driver</option> specifies the driver to use for
 787           file-based disks. Note that currently these drivers work with the
 788           xen hypervisor only. This option is only relevant for instances using
 789           the file storage backend. The available choices are:
 790           <variablelist>
 791             <varlistentry>
 792               <term>loop</term>
 793               <listitem>
 794                 <para>
 795                   Kernel loopback driver. This driver uses loopback
 796                   devices to access the filesystem within the
 797                   file. However, running I/O intensive applications in
 798                   your instance using the loop driver might result in
 799                   slowdowns.  Furthermore, if you use the loopback
 800                   driver consider increasing the maximum amount of
 801                   loopback devices (on most systems it's 8) using the
 802                   max_loop param.
 803                 </para>
 804               </listitem>
 805             </varlistentry>
 806             <varlistentry>
 807               <term>blktap</term>
 808               <listitem>
 809                 <para>The blktap driver (for Xen hypervisors). In
 810                 order to be able to use the blktap driver you should
 811                 check if the 'blktapctrl' user space disk agent is
 812                 running (usually automatically started via xend). This
 813                 user-level disk I/O interface has the advantage of
 814                 better performance. Especially if you use a network
 815                 file system (e.g. NFS) to store your instances this is
 816                 the recommended choice.
 817                 </para>
 818               </listitem>
 819             </varlistentry>
 820           </variablelist>
 821         </para>
 822
 823         <para>
 824           The <option>--submit</option> option is used to send the job to
 825           the master daemon but not wait for its completion. The job
 826           ID will be shown so that it can be examined via
 827           <command>gnt-job info</command>.
 828         </para>
 829
 830         <para>
 831           Example:
 832           <screen>
 833 # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
 834   -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
 835 # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
 836   -n node1.example.com instance1.example.com
 837 # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
 838   -n node1.example.com:node2.example.com instance2.example.com
 839           </screen>
 840         </para>
 841       </refsect3>
 842
 843       <refsect3>
 844         <title>BATCH-CREATE</title>
 845         <cmdsynopsis>
 846           <command>batch-create</command>
 847           <arg choice="req">instances_file.json</arg>
 848         </cmdsynopsis>
 849
 850         <para>
 851           This command (similar to the Ganeti 1.2
 852           <command>batcher</command> tool) submits multiple instance
 853           creation jobs based on a definition file. The instance
 854           configurations do not encompass all the possible options for
 855           the <command>add</command> command, but only a subset.
 856         </para>
 857
 858         <para>
 859           The instance file should be a valid-formed JSON file,
 860           containing a dictionary with instance name and instance
 861           parameters. The accepted parameters are:
 862
 863           <variablelist>
 864             <varlistentry>
 865               <term>disk_size</term>
 866               <listitem>
 867                 <simpara>The size of the disks of the instance.</simpara>
 868               </listitem>
 869             </varlistentry>
 870             <varlistentry>
 871               <term>disk_template</term>
 872               <listitem>
 873                 <simpara>The disk template to use for the instance,
 874                 the same as in the <command>add</command>
 875                 command.</simpara>
 876               </listitem>
 877             </varlistentry>
 878             <varlistentry>
 879               <term>backend</term>
 880               <listitem>
 881                 <simpara>A dictionary of backend parameters.</simpara>
 882               </listitem>
 883             </varlistentry>
 884             <varlistentry>
 885               <term>hypervisor</term>
 886               <listitem>
 887                 <simpara>A dictionary with a single key (the
 888                 hypervisor name), and as value the hypervisor
 889                 options. If not passed, the default hypervisor and
 890                 hypervisor options will be inherited.</simpara>
 891               </listitem>
 892             </varlistentry>
 893             <varlistentry>
 894               <term>mac, ip, mode, link</term>
 895               <listitem>
 896                 <simpara>Specifications for the one NIC that will be
 897                 created for the instance. 'bridge' is also accepted
 898                 as a backwards compatibile key.</simpara>
 899               </listitem>
 900             </varlistentry>
 901             <varlistentry>
 902               <term>nics</term>
 903               <listitem>
 904                 <simpara>List of nics that will be created for the
 905                 instance. Each entry should be a dict, with mac, ip, mode
 906                 and link as possible keys. Please don't provide the "mac,
 907                 ip, mode, link" parent keys if you use this method for
 908                 specifying nics.</simpara>
 909               </listitem>
 910             </varlistentry>
 911             <varlistentry>
 912               <term>primary_node, secondary_node</term>
 913               <listitem>
 914                 <simpara>The primary and optionally the secondary node
 915                 to use for the instance (in case an iallocator script
 916                 is not used).</simpara>
 917               </listitem>
 918             </varlistentry>
 919             <varlistentry>
 920               <term>iallocator</term>
 921               <listitem>
 922                 <simpara>Instead of specifying the nodes, an
 923                 iallocator script can be used to automatically compute
 924                 them.</simpara>
 925               </listitem>
 926             </varlistentry>
 927             <varlistentry>
 928               <term>start</term>
 929               <listitem>
 930                 <simpara>whether to start the instance</simpara>
 931               </listitem>
 932             </varlistentry>
 933             <varlistentry>
 934               <term>ip_check</term>
 935               <listitem>
 936                 <simpara>Skip the check for already-in-use instance;
 937                 see the description in the <command>add</command>
 938                 command for details.</simpara>
 939               </listitem>
 940             </varlistentry>
 941             <varlistentry>
 942               <term>name_check</term>
 943               <listitem>
 944                 <simpara>Skip the name check for instances;
 945                 see the description in the <command>add</command>
 946                 command for details.</simpara>
 947               </listitem>
 948             </varlistentry>
 949             <varlistentry>
 950               <term>file_storage_dir, file_driver</term>
 951               <listitem>
 952                 <simpara>Configuration for the <literal>file</literal>
 953                 disk type, see the <command>add</command> command for
 954                 details.</simpara>
 955               </listitem>
 956             </varlistentry>
 957           </variablelist>
 958         </para>
 959
 960         <para>
 961           A simple definition for one instance can be (with most of
 962           the parameters taken from the cluster defaults):
 963           <screen>
 964 {
 965   "instance3": {
 966     "template": "drbd",
 967     "os": "debootstrap",
 968     "disk_size": ["25G"],
 969     "iallocator": "dumb"
 970   },
 971   "instance5": {
 972     "template": "drbd",
 973     "os": "debootstrap",
 974     "disk_size": ["25G"],
 975     "iallocator": "dumb",
 976     "hypervisor": "xen-hvm",
 977     "hvparams": {"acpi": true},
 978     "backend": {"memory": 512}
 979   }
 980 }
 981 </screen>
 982         </para>
 983
 984         <para>
 985           The command will display the job id for each submitted instance, as follows:
 986           <screen>
 987 # gnt-instance batch-create instances.json
 988 instance3: 11224
 989 instance5: 11225
 990 </screen>
 991         </para>
 992
 993       </refsect3>
 994
 995       <refsect3>
 996         <title>REMOVE</title>
 997
 998         <cmdsynopsis>
 999           <command>remove</command>
1000           <arg>--ignore-failures</arg>
1001           <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
1002           <arg>--submit</arg>
1003           <arg choice="req"><replaceable>instance</replaceable></arg>
1004         </cmdsynopsis>
1005
1006         <para>
1007           Remove an instance. This will remove all data from the
1008           instance and there is <emphasis>no way back</emphasis>. If
1009           you are not sure if you use an instance again, use
1010           <command>shutdown</command> first and leave it in the
1011           shutdown state for a while.
1012
1013         </para>
1014
1015         <para>
1016           The <option>--ignore-failures</option> option will cause the
1017           removal to proceed even in the presence of errors during the
1018           removal of the instance (e.g. during the shutdown or the
1019           disk removal). If this option is not given, the command will
1020           stop at the first error.
1021         </para>
1022
1023         <para>
1024           The <option>--shutdown-timeout</option> is used to specify how
1025           much time to wait before forcing the shutdown (xm destroy in xen,
1026           killing the kvm process, for kvm). By default two minutes are
1027           given to each instance to stop.
1028         </para>
1029
1030         <para>
1031           The <option>--submit</option> option is used to send the job to
1032           the master daemon but not wait for its completion. The job
1033           ID will be shown so that it can be examined via
1034           <command>gnt-job info</command>.
1035         </para>
1036
1037         <para>
1038           Example:
1039           <screen>
1040 # gnt-instance remove instance1.example.com
1041           </screen>
1042         </para>
1043       </refsect3>
1044
1045       <refsect3>
1046         <title>LIST</title>
1047
1048         <cmdsynopsis>
1049           <command>list</command>
1050           <arg>--no-headers</arg>
1051           <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
1052           <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
1053           <arg>--roman</arg>
1054           <arg rep="repeat">instance</arg>
1055         </cmdsynopsis>
1056
1057         <para>
1058           Shows the currently configured instances with memory usage,
1059           disk usage, the node they are running on, and their run
1060           status.
1061         </para>
1062
1063         <para>
1064           The <option>--no-headers</option> option will skip the
1065           initial header line. The <option>--separator</option> option
1066           takes an argument which denotes what will be used between
1067           the output fields. Both these options are to help scripting.
1068         </para>
1069
1070         <para>
1071           The <option>--roman</option> option allows latin people to better
1072           understand the cluster instances' status.
1073         </para>
1074
1075         <para>
1076           The <option>-o</option> option takes a comma-separated list
1077           of output fields. The available fields and their meaning
1078           are:
1079           <variablelist>
1080             <varlistentry>
1081               <term>name</term>
1082               <listitem>
1083                 <simpara>the instance name</simpara>
1084               </listitem>
1085             </varlistentry>
1086             <varlistentry>
1087               <term>os</term>
1088               <listitem>
1089                 <simpara>the OS of the instance</simpara>
1090               </listitem>
1091             </varlistentry>
1092             <varlistentry>
1093               <term>pnode</term>
1094               <listitem>
1095                 <simpara>the primary node of the instance</simpara>
1096               </listitem>
1097             </varlistentry>
1098             <varlistentry>
1099               <term>snodes</term>
1100               <listitem>
1101                 <simpara>comma-separated list of secondary nodes for the
1102                   instance; usually this will be just one node</simpara>
1103               </listitem>
1104             </varlistentry>
1105             <varlistentry>
1106               <term>admin_state</term>
1107               <listitem>
1108                 <simpara>the desired state of the instance (either "yes"
1109                   or "no" denoting the instance should run or
1110                   not)</simpara>
1111               </listitem>
1112             </varlistentry>
1113             <varlistentry>
1114               <term>disk_template</term>
1115               <listitem>
1116                 <simpara>the disk template of the instance</simpara>
1117               </listitem>
1118             </varlistentry>
1119             <varlistentry>
1120               <term>oper_state</term>
1121               <listitem>
1122                 <simpara>the actual state of the instance; can be
1123                 one of the values "running", "stopped", "(node
1124                 down)"</simpara>
1125               </listitem>
1126             </varlistentry>
1127             <varlistentry>
1128               <term>status</term>
1129               <listitem>
1130                 <simpara>combined form of admin_state and oper_stat;
1131                 this can be one of:
1132                 <computeroutput>ERROR_nodedown</computeroutput> if the
1133                 node of the instance is down,
1134                 <computeroutput>ERROR_down</computeroutput> if the
1135                 instance should run but is down,
1136                 <computeroutput>ERROR_up</computeroutput> if the
1137                 instance should be stopped but is actually running,
1138                 <computeroutput>ADMIN_down</computeroutput> if the
1139                 instance has been stopped (and is stopped) and
1140                 <computeroutput>running</computeroutput> if the
1141                 instance is set to be running (and is
1142                 running)</simpara>
1143               </listitem>
1144             </varlistentry>
1145             <varlistentry>
1146               <term>oper_ram</term>
1147               <listitem>
1148                 <simpara>the actual memory usage of the instance as seen
1149                   by the hypervisor</simpara>
1150               </listitem>
1151             </varlistentry>
1152             <varlistentry>
1153               <term>oper_vcpus</term>
1154               <listitem>
1155                 <simpara>the actual number of VCPUs the instance is using
1156                   as seen by the hypervisor</simpara>
1157               </listitem>
1158             </varlistentry>
1159             <varlistentry>
1160               <term>ip</term>
1161               <listitem>
1162                 <simpara>the ip address Ganeti recognizes as associated with
1163                 the first instance interface</simpara>
1164               </listitem>
1165             </varlistentry>
1166             <varlistentry>
1167               <term>mac</term>
1168               <listitem>
1169                 <simpara>the first instance interface MAC address</simpara>
1170               </listitem>
1171             </varlistentry>
1172
1173             <varlistentry>
1174               <term>nic_mode</term>
1175               <listitem>
1176                 <simpara>the mode of the first instance NIC
1177                 (routed or bridged)</simpara>
1178               </listitem>
1179             </varlistentry>
1180             <varlistentry>
1181               <term>nic_link</term>
1182               <listitem>
1183                 <simpara>the link of the first instance NIC
1184                 </simpara>
1185               </listitem>
1186             </varlistentry>
1187             <varlistentry>
1188               <term>sda_size</term>
1189               <listitem>
1190                 <simpara>the size of the instance's first disk</simpara>
1191               </listitem>
1192             </varlistentry>
1193             <varlistentry>
1194               <term>sdb_size</term>
1195               <listitem>
1196                 <simpara>the size of the instance's second disk, if
1197                 any</simpara>
1198               </listitem>
1199             </varlistentry>
1200             <varlistentry>
1201               <term>vcpus</term>
1202               <listitem>
1203                 <simpara>the number of VCPUs allocated to the
1204                 instance</simpara>
1205               </listitem>
1206             </varlistentry>
1207             <varlistentry>
1208               <term>tags</term>
1209               <listitem>
1210                 <simpara>comma-separated list of the instances's
1211                 tags</simpara>
1212               </listitem>
1213             </varlistentry>
1214             <varlistentry>
1215               <term>serial_no</term>
1216               <listitem>
1217                 <simpara>the so called 'serial number' of the
1218                 instance; this is a numeric field that is incremented
1219                 each time the instance is modified, and it can be used
1220                 to track modifications</simpara>
1221               </listitem>
1222             </varlistentry>
1223             <varlistentry>
1224               <term>ctime</term>
1225               <listitem>
1226                 <para>
1227                   the creation time of the instance; note that this
1228                   field contains spaces and as such it's harder to
1229                   parse
1230                 </para>
1231                 <para>
1232                   if this attribute is not present (e.g. when
1233                   upgrading from older versions), then "N/A" will be
1234                   shown instead
1235                 </para>
1236               </listitem>
1237             </varlistentry>
1238             <varlistentry>
1239               <term>mtime</term>
1240               <listitem>
1241                 <para>
1242                   the last modification time of the instance; note
1243                   that this field contains spaces and as such it's
1244                   harder to parse
1245                 </para>
1246                 <para>
1247                   if this attribute is not present (e.g. when
1248                   upgrading from older versions), then "N/A" will be
1249                   shown instead
1250                 </para>
1251               </listitem>
1252             </varlistentry>
1253
1254             <varlistentry>
1255               <term>uuid</term>
1256               <listitem>
1257                 <simpara>Show the UUID of the instance (generated
1258                 automatically by Ganeti)</simpara>
1259               </listitem>
1260             </varlistentry>
1261
1262             <varlistentry>
1263               <term>network_port</term>
1264               <listitem>
1265                 <simpara>If the instance has a network port assigned
1266                 to it (e.g. for VNC connections), this will be shown,
1267                 otherwise <literal>-</literal> will be
1268                 displayed.</simpara>
1269               </listitem>
1270             </varlistentry>
1271             <varlistentry>
1272               <term>beparams</term>
1273               <listitem>
1274                 <simpara>A text format of the entire beparams for the
1275                 instance. It's more useful to select individual fields
1276                 from this dictionary, see below.</simpara>
1277               </listitem>
1278             </varlistentry>
1279             <varlistentry>
1280               <term>disk.count</term>
1281               <listitem>
1282                 <simpara>The number of instance disks.</simpara>
1283               </listitem>
1284             </varlistentry>
1285             <varlistentry>
1286               <term>disk.size/N</term>
1287               <listitem>
1288                 <simpara>The size of the instance's Nth disk. This is
1289                 a more generic form of the <literal>sda_size</literal>
1290                 and <literal>sdb_size</literal> fields.</simpara>
1291               </listitem>
1292             </varlistentry>
1293             <varlistentry>
1294               <term>disk.sizes</term>
1295               <listitem>
1296                 <simpara>A comma-separated list of the disk sizes for
1297                 this instance.</simpara>
1298               </listitem>
1299             </varlistentry>
1300             <varlistentry>
1301               <term>disk_usage</term>
1302               <listitem>
1303                 <simpara>The total disk space used by this instance on
1304                 each of its nodes. This is not the instance-visible
1305                 disk size, but the actual disk "cost" of the
1306                 instance.</simpara>
1307               </listitem>
1308             </varlistentry>
1309             <varlistentry>
1310               <term>nic.mac/N</term>
1311               <listitem>
1312                 <simpara>The MAC of the Nth instance NIC.</simpara>
1313               </listitem>
1314             </varlistentry>
1315             <varlistentry>
1316               <term>nic.ip/N</term>
1317               <listitem>
1318                 <simpara>The IP address of the Nth instance NIC.</simpara>
1319               </listitem>
1320             </varlistentry>
1321             <varlistentry>
1322               <term>nic.mode/N</term>
1323               <listitem>
1324                 <simpara>The mode of the Nth instance NIC</simpara>
1325               </listitem>
1326             </varlistentry>
1327             <varlistentry>
1328               <term>nic.link/N</term>
1329               <listitem>
1330                 <simpara>The link of the Nth instance NIC</simpara>
1331               </listitem>
1332             </varlistentry>
1333             <varlistentry>
1334               <term>nic.macs</term>
1335               <listitem>
1336                 <simpara>A comma-separated list of all the MACs of the
1337                 instance's NICs.</simpara>
1338               </listitem>
1339             </varlistentry>
1340             <varlistentry>
1341               <term>nic.ips</term>
1342               <listitem>
1343                 <simpara>A comma-separated list of all the IP
1344                 addresses of the instance's NICs.</simpara>
1345               </listitem>
1346             </varlistentry>
1347             <varlistentry>
1348               <term>nic.modes</term>
1349               <listitem>
1350                 <simpara>A comma-separated list of all the modes of the
1351                 instance's NICs.</simpara>
1352               </listitem>
1353             </varlistentry>
1354             <varlistentry>
1355               <term>nic.links</term>
1356               <listitem>
1357                 <simpara>A comma-separated list of all the link parameters
1358                 of the instance's NICs.</simpara>
1359               </listitem>
1360             </varlistentry>
1361             <varlistentry>
1362               <term>nic.count</term>
1363               <listitem>
1364                 <simpara>The number of instance nics.</simpara>
1365               </listitem>
1366             </varlistentry>
1367             <varlistentry>
1368               <term>hv/<replaceable>NAME</replaceable></term>
1369               <listitem>
1370                 <simpara>The value of the hypervisor parameter called
1371                 <replaceable>NAME</replaceable>. For details of what
1372                 hypervisor parameters exist and their meaning, see the
1373                 <command>add</command> command.</simpara>
1374               </listitem>
1375             </varlistentry>
1376             <varlistentry>
1377               <term>be/memory</term>
1378               <listitem>
1379                 <simpara>The configured memory for the instance.</simpara>
1380               </listitem>
1381             </varlistentry>
1382             <varlistentry>
1383               <term>be/vcpus</term>
1384               <listitem>
1385                 <simpara>The configured number of VCPUs for the
1386                 instance.</simpara>
1387               </listitem>
1388             </varlistentry>
1389             <varlistentry>
1390               <term>be/auto_balance</term>
1391               <listitem>
1392                 <simpara>Whether the instance is considered in N+1
1393                 checks.</simpara>
1394               </listitem>
1395             </varlistentry>
1396           </variablelist>
1397         </para>
1398
1399         <para>
1400           If the value of the option starts with the character
1401           <constant>+</constant>, the new field(s) will be added to the
1402           default list. This allows to quickly see the default list
1403           plus a few other fields, instead of retyping the entire list
1404           of fields.
1405         </para>
1406
1407         <para>
1408           There is a subtle grouping about the available output
1409           fields: all fields except for <option>oper_state</option>,
1410           <option>oper_ram</option>, <option>oper_vcpus</option> and
1411           <option>status</option> are
1412           configuration value and not run-time values. So if you don't
1413           select any of the these fields, the query will be satisfied
1414           instantly from the cluster configuration, without having to
1415           ask the remote nodes for the data. This can be helpful for
1416           big clusters when you only want some data and it makes sense
1417           to specify a reduced set of output fields.
1418         </para>
1419
1420         <para>The default output field list is:
1421           <simplelist type="inline">
1422             <member>name</member>
1423             <member>os</member>
1424             <member>pnode</member>
1425             <member>admin_state</member>
1426             <member>oper_state</member>
1427             <member>oper_ram</member>
1428           </simplelist>.
1429         </para>
1430       </refsect3>
1431
1432       <refsect3>
1433         <title>INFO</title>
1434
1435         <cmdsynopsis>
1436           <command>info</command>
1437           <group>
1438             <arg>-s</arg>
1439             <arg>--static</arg>
1440           </group>
1441           <arg>--roman</arg>
1442           <group choice="req">
1443             <arg>--all</arg>
1444             <arg rep="repeat"><replaceable>instance</replaceable></arg>
1445           </group>
1446         </cmdsynopsis>
1447
1448         <para>
1449           Show detailed information about the given instance(s). This is
1450           different from <command>list</command> as it shows detailed data
1451           about the instance's disks (especially useful for the drbd disk
1452           template).
1453         </para>
1454
1455         <para>
1456           If the option <option>-s</option> is used, only information
1457           available in the configuration file is returned, without
1458           querying nodes, making the operation faster.
1459         </para>
1460
1461         <para>
1462           Use the <option>--all</option> to get info about all instances,
1463           rather than explicitly passing the ones you're interested in.
1464         </para>
1465
1466         <para>
1467           The <option>--roman</option> option can be used to cause envy among
1468           people who like ancient cultures, but are stuck with non-latin-friendly
1469           cluster virtualization technologies.
1470         </para>
1471
1472       </refsect3>
1473
1474       <refsect3>
1475         <title>MODIFY</title>
1476
1477         <cmdsynopsis>
1478           <command>modify</command>
1479           <sbr>
1480           <arg choice="opt">-H <replaceable>HYPERVISOR_PARAMETERS</replaceable></arg>
1481           <sbr>
1482           <arg choice="opt">-B <replaceable>BACKEND_PARAMETERS</replaceable></arg>
1483           <sbr>
1484           <group>
1485             <arg>--net add<replaceable><optional>:options</optional></replaceable></arg>
1486             <arg>--net remove</arg>
1487             <arg>--net <replaceable>N:options</replaceable></arg>
1488           </group>
1489           <sbr>
1490           <group>
1491             <arg>--disk add:size=<replaceable>SIZE</replaceable></arg>
1492             <arg>--disk remove</arg>
1493             <arg>--disk <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></arg>
1494           </group>
1495
1496           <sbr>
1497           <arg>-t<group choice="req">
1498               <arg>plain</arg>
1499               <arg>drbd</arg>
1500             </group></arg>
1501
1502           <sbr>
1503             <arg>--os-name=<replaceable>OS</replaceable> <arg>--force-variant</arg></arg>
1504
1505           <sbr>
1506           <arg>--submit</arg>
1507           <sbr>
1508           <arg choice="req"><replaceable>instance</replaceable></arg>
1509         </cmdsynopsis>
1510
1511         <para>
1512           Modifies the memory size, number of vcpus, ip address, MAC
1513           address and/or nic parameters for an instance. It can also
1514           add and remove disks and NICs to/from the instance. Note
1515           that you need to give at least one of the arguments, otherwise
1516           the command complains.
1517         </para>
1518
1519         <para>
1520           The <option>-H</option> option specifies hypervisor options
1521           in the form of <userinput>name=value[,...]</userinput>. For details which options can be specified, see the <command>add</command> command.
1522         </para>
1523
1524         <para>
1525           The <option>-t</option> option will change the disk template
1526           of the instance. Currently only conversions between the
1527           plain and drbd disk templates are supported, and the
1528           instance must be stopped before attempting the conversion.
1529         </para>
1530
1531         <para>
1532           The <option>--disk
1533           add:size=<replaceable>SIZE</replaceable></option> option
1534           adds a disk to the instance. The <option>--disk
1535           remove</option> will remove the last disk of the
1536           instance. The <option>--disk
1537           <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></option>
1538           option will change the mode of the Nth disk of the instance
1539           between read-only (<literal>ro</literal>) and read-write
1540           (<literal>rw</literal>).
1541         </para>
1542
1543         <para>
1544           The <option>--net
1545           add:<replaceable>options</replaceable></option> option will
1546           add a new NIC to the instance. The available options are the
1547           same as in the <command>add</command> command (mac, ip, link,
1548           mode). The <option>--net remove</option> will remove the
1549           last NIC of the instance, while the <option>--net
1550           <replaceable>N</replaceable>:<replaceable>options</replaceable></option>
1551           option will change the parameters of the Nth instance NIC.
1552         </para>
1553
1554         <para>
1555           The option <option>--os-name</option> will change the OS
1556           name for the instance (without reinstallation). In case an
1557           OS variant is specified that is not found, then by default
1558           the modification is refused,
1559           unless <option>--force-variant</option> is passed. An
1560           invalid OS will also be refused, unless
1561           the <option>--force</option> option is given.
1562         </para>
1563
1564         <para>
1565           The <option>--submit</option> option is used to send the job to
1566           the master daemon but not wait for its completion. The job
1567           ID will be shown so that it can be examined via
1568           <command>gnt-job info</command>.
1569         </para>
1570
1571         <para>
1572           All the changes take effect at the next restart. If the
1573           instance is running, there is no effect on the instance.
1574         </para>
1575       </refsect3>
1576
1577       <refsect3>
1578         <title>REINSTALL</title>
1579
1580         <cmdsynopsis>
1581           <command>reinstall</command>
1582           <arg choice="opt">-o <replaceable>os-type</replaceable></arg>
1583           <arg>--select-os</arg>
1584           <arg choice="opt">-f <replaceable>force</replaceable></arg>
1585           <arg>--force-multiple</arg>
1586           <sbr>
1587           <group choice="opt">
1588             <arg>--instance</arg>
1589             <arg>--node</arg>
1590             <arg>--primary</arg>
1591             <arg>--secondary</arg>
1592             <arg>--all</arg>
1593           </group>
1594           <arg>--submit</arg>
1595           <arg choice="opt" rep="repeat"><replaceable>instance</replaceable></arg>
1596         </cmdsynopsis>
1597
1598         <para>
1599           Reinstalls the operating system on the given instance(s). The
1600           instance(s) must be stopped when running this command. If the
1601           <option>--os-type</option> is specified, the operating
1602           system is changed.
1603         </para>
1604
1605         <para>
1606           The <option>--select-os</option> option switches to an
1607           interactive OS reinstall. The user is prompted to select the OS
1608           template from the list of available OS templates.
1609         </para>
1610
1611         <para>
1612           Since this is a potentially dangerous command, the user will
1613           be required to confirm this action, unless the
1614           <option>-f</option> flag is passed. When multiple instances
1615           are selected (either by passing multiple arguments or by
1616           using the <option>--node</option>,
1617           <option>--primary</option>, <option>--secondary</option> or
1618           <option>--all</option> options), the user must pass both the
1619           <option>--force</option> and
1620           <option>--force-multiple</option> options to skip the
1621           interactive confirmation.
1622         </para>
1623
1624         <para>
1625           The <option>--submit</option> option is used to send the job to
1626           the master daemon but not wait for its completion. The job
1627           ID will be shown so that it can be examined via
1628           <command>gnt-job info</command>.
1629         </para>
1630
1631
1632       </refsect3>
1633
1634       <refsect3>
1635         <title>RENAME</title>
1636
1637         <cmdsynopsis>
1638           <command>rename</command>
1639           <arg>--no-ip-check</arg>
1640           <arg>--submit</arg>
1641           <arg choice="req"><replaceable>instance</replaceable></arg>
1642           <arg choice="req"><replaceable>new_name</replaceable></arg>
1643         </cmdsynopsis>
1644
1645         <para>
1646           Renames the given instance. The instance must be stopped
1647           when running this command. The requirements for the new name
1648           are the same as for adding an instance: the new name must be
1649           resolvable and the IP it resolves to must not be reachable
1650           (in order to prevent duplicate IPs the next time the
1651           instance is started). The IP test can be skipped if the
1652           <option>--no-ip-check</option> option is passed.
1653         </para>
1654
1655         <para>
1656           The <option>--submit</option> option is used to send the job to
1657           the master daemon but not wait for its completion. The job
1658           ID will be shown so that it can be examined via
1659           <command>gnt-job info</command>.
1660         </para>
1661
1662       </refsect3>
1663
1664     </refsect2>
1665
1666     <refsect2>
1667       <title>Starting/stopping/connecting to console</title>
1668
1669       <refsect3>
1670         <title>STARTUP</title>
1671
1672         <cmdsynopsis>
1673           <command>startup</command>
1674           <sbr>
1675           <arg>--force</arg>
1676           <sbr>
1677           <arg>--force-multiple</arg>
1678           <sbr>
1679           <group choice="opt">
1680             <arg>--instance</arg>
1681             <arg>--node</arg>
1682             <arg>--primary</arg>
1683             <arg>--secondary</arg>
1684             <arg>--all</arg>
1685             <arg>--tags</arg>
1686             <arg>--node-tags</arg>
1687             <arg>--pri-node-tags</arg>
1688             <arg>--sec-node-tags</arg>
1689           </group>
1690           <sbr>
1691           <arg>-H <option>key=value...</option></arg>
1692           <arg>-B <option>key=value...</option></arg>
1693           <sbr>
1694           <arg>--submit</arg>
1695           <sbr>
1696           <arg choice="opt"
1697           rep="repeat"><replaceable>name</replaceable></arg>
1698         </cmdsynopsis>
1699
1700         <para>
1701           Starts one or more instances, depending on the following
1702           options. The four available modes are:
1703           <variablelist>
1704             <varlistentry>
1705               <term><option>--instance</option></term>
1706               <listitem>
1707                 <simpara>will start the instances given as arguments
1708                 (at least one argument required); this is the default
1709                 selection</simpara>
1710               </listitem>
1711             </varlistentry>
1712             <varlistentry>
1713               <term>--node</term>
1714               <listitem>
1715                 <simpara>will start the instances who have the given
1716                 node as either primary or secondary</simpara>
1717               </listitem>
1718             </varlistentry>
1719             <varlistentry>
1720               <term><option>--primary</option></term>
1721               <listitem>
1722                 <simpara>will start all instances whose primary node
1723                 is in the list of nodes passed as arguments (at least
1724                 one node required)</simpara>
1725               </listitem>
1726             </varlistentry>
1727             <varlistentry>
1728               <term><option>--secondary</option></term>
1729               <listitem>
1730                 <simpara>will start all instances whose secondary node
1731                 is in the list of nodes passed as arguments (at least
1732                 one node required)</simpara>
1733               </listitem>
1734             </varlistentry>
1735             <varlistentry>
1736               <term>--all</term>
1737               <listitem>
1738                 <simpara>will start all instances in the cluster (no
1739                 arguments accepted)</simpara>
1740               </listitem>
1741             </varlistentry>
1742             <varlistentry>
1743               <term>--tags</term>
1744               <listitem>
1745                 <simpara>will start all instances in the cluster with
1746                 the tags given as arguments</simpara>
1747               </listitem>
1748             </varlistentry>
1749             <varlistentry>
1750               <term>--node-tags</term>
1751               <listitem>
1752                 <simpara>will start all instances in the cluster on
1753                 nodes with the tags given as arguments</simpara>
1754               </listitem>
1755             </varlistentry>
1756             <varlistentry>
1757               <term>--pri-node-tags</term>
1758               <listitem>
1759                 <simpara>will start all instances in the cluster on
1760                 primary nodes with the tags given as
1761                 arguments</simpara>
1762               </listitem>
1763             </varlistentry>
1764             <varlistentry>
1765               <term>--sec-node-tags</term>
1766               <listitem>
1767                 <simpara>will start all instances in the cluster on
1768                 secondary nodes with the tags given as
1769                 arguments</simpara>
1770               </listitem>
1771             </varlistentry>
1772           </variablelist>
1773         </para>
1774
1775         <para>
1776           Note that although you can pass more than one selection
1777           option, the last one wins, so in order to guarantee the
1778           desired result, don't pass more than one such option.
1779         </para>
1780
1781         <para>
1782           Use <option>--force</option> to start even if secondary disks are
1783           failing.
1784         </para>
1785
1786         <para>
1787           The <option>--force-multiple</option> will skip the
1788           interactive confirmation in the case the more than one
1789           instance will be affected.
1790         </para>
1791
1792         <para>
1793           The <option>-H</option> and <option>-B</option> options
1794           specify temporary hypervisor and backend parameters that can
1795           be used to start an instance with modified parameters. They
1796           can be useful for quick testing without having to modify an
1797           instance back and forth, e.g.:
1798           <screen>
1799 # gnt-instance start -H root_args="single" instance1
1800 # gnt-instance start -B memory=2048 instance2
1801           </screen>
1802           The first form will start the instance
1803           <userinput>instance1</userinput> in single-user mode, and
1804           the instance <userinput>instance2</userinput> with 2GB of
1805           RAM (this time only, unless that is the actual instance
1806           memory size already). Note that the values override the
1807           instance parameters (and not extend them): an instance with
1808           "root_args=ro" when started with <userinput>-H
1809           root_args=single</userinput> will result in "single", not
1810           "ro single".
1811         </para>
1812
1813         <para>
1814           The <option>--submit</option> option is used to send the job to
1815           the master daemon but not wait for its completion. The job
1816           ID will be shown so that it can be examined via
1817           <command>gnt-job info</command>.
1818         </para>
1819
1820         <para>
1821           Example:
1822           <screen>
1823 # gnt-instance start instance1.example.com
1824 # gnt-instance start --node node1.example.com node2.example.com
1825 # gnt-instance start --all
1826           </screen>
1827         </para>
1828       </refsect3>
1829
1830       <refsect3>
1831         <title>SHUTDOWN</title>
1832
1833         <cmdsynopsis>
1834           <command>shutdown</command>
1835           <sbr>
1836           <arg>--timeout=<replaceable>N</replaceable></arg>
1837           <sbr>
1838           <arg>--force-multiple</arg>
1839           <sbr>
1840           <group choice="opt">
1841             <arg>--instance</arg>
1842             <arg>--node</arg>
1843             <arg>--primary</arg>
1844             <arg>--secondary</arg>
1845             <arg>--all</arg>
1846             <arg>--tags</arg>
1847             <arg>--node-tags</arg>
1848             <arg>--pri-node-tags</arg>
1849             <arg>--sec-node-tags</arg>
1850           </group>
1851           <sbr>
1852           <arg>--submit</arg>
1853           <sbr>
1854           <arg choice="opt"
1855           rep="repeat"><replaceable>name</replaceable></arg>
1856         </cmdsynopsis>
1857
1858         <para>
1859           Stops one or more instances. If the instance cannot be
1860           cleanly stopped during a hardcoded interval (currently 2
1861           minutes), it will forcibly stop the instance (equivalent to
1862           switching off the power on a physical machine).
1863         </para>
1864
1865         <para>
1866           The <option>--timeout</option> is used to specify how much time to
1867           wait before forcing the shutdown (xm destroy in xen, killing the kvm
1868           process, for kvm). By default two minutes are given to each instance
1869           to stop.
1870         </para>
1871
1872         <para>
1873           The <option>--instance</option>, <option>--node</option>,
1874           <option>--primary</option>, <option>--secondary</option>,
1875           <option>--all</option>, <option>--tags</option>,
1876           <option>--node-tags</option>, <option>--pri-node-tags</option> and
1877           <option>--sec-node-tags</option> options are similar as for the
1878           <command>startup</command> command and they influence the
1879           actual instances being shutdown.
1880         </para>
1881
1882         <para>
1883           The <option>--submit</option> option is used to send the job to
1884           the master daemon but not wait for its completion. The job
1885           ID will be shown so that it can be examined via
1886           <command>gnt-job info</command>.
1887         </para>
1888
1889
1890         <para>
1891           Example:
1892           <screen>
1893 # gnt-instance shutdown instance1.example.com
1894 # gnt-instance shutdown --all
1895           </screen>
1896         </para>
1897       </refsect3>
1898
1899       <refsect3>
1900         <title>REBOOT</title>
1901
1902         <cmdsynopsis>
1903           <command>reboot</command>
1904           <sbr>
1905           <arg>--type=<replaceable>REBOOT-TYPE</replaceable></arg>
1906           <sbr>
1907           <arg>--ignore-secondaries</arg>
1908           <sbr>
1909           <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
1910           <sbr>
1911           <arg>--force-multiple</arg>
1912           <sbr>
1913           <group choice="opt">
1914             <arg>--instance</arg>
1915             <arg>--node</arg>
1916             <arg>--primary</arg>
1917             <arg>--secondary</arg>
1918             <arg>--all</arg>
1919             <arg>--tags</arg>
1920             <arg>--node-tags</arg>
1921             <arg>--pri-node-tags</arg>
1922             <arg>--sec-node-tags</arg>
1923           </group>
1924           <sbr>
1925           <arg>--submit</arg>
1926           <sbr>
1927           <arg choice="opt"
1928           rep="repeat"><replaceable>name</replaceable></arg>
1929         </cmdsynopsis>
1930
1931         <para>
1932           Reboots one or more instances. The type of reboot depends on
1933           the value of <option>--type</option>. A soft reboot does a
1934           hypervisor reboot, a hard reboot does a instance stop,
1935           recreates the hypervisor config for the instance and
1936           starts the instance. A full reboot does the equivalent
1937           of <command>gnt-instance shutdown &amp;&amp; gnt-instance
1938           startup</command>. The default is hard reboot.
1939         </para>
1940
1941         <para>
1942           For the hard reboot the option
1943           <option>--ignore-secondaries</option> ignores errors for the
1944           secondary node while re-assembling the instance disks.
1945         </para>
1946
1947         <para>
1948           The <option>--instance</option>, <option>--node</option>,
1949           <option>--primary</option>, <option>--secondary</option>,
1950           <option>--all</option>, <option>--tags</option>,
1951           <option>--node-tags</option>, <option>--pri-node-tags</option> and
1952           <option>--sec-node-tags</option> options are similar as for the
1953           <command>startup</command> command and they influence the
1954           actual instances being rebooted.
1955         </para>
1956
1957         <para>
1958           The <option>--shutdown-timeout</option> is used to specify how
1959           much time to wait before forcing the shutdown (xm destroy in xen,
1960           killing the kvm process, for kvm). By default two minutes are
1961           given to each instance to stop.
1962         </para>
1963
1964         <para>
1965           The <option>--force-multiple</option> will skip the
1966           interactive confirmation in the case the more than one
1967           instance will be affected.
1968         </para>
1969
1970         <para>
1971           Example:
1972           <screen>
1973 # gnt-instance reboot instance1.example.com
1974 # gnt-instance reboot --type=full instance1.example.com
1975           </screen>
1976         </para>
1977       </refsect3>
1978
1979       <refsect3>
1980         <title>CONSOLE</title>
1981         <cmdsynopsis>
1982           <command>console</command>
1983           <arg choice="opt">--show-cmd</arg>
1984           <arg choice="req"><replaceable>instance</replaceable></arg>
1985         </cmdsynopsis>
1986
1987         <para>
1988           Connects to the console of the given instance. If the
1989           instance is not up, an error is returned. Use the
1990           <option>--show-cmd</option> option to display the command
1991           instead of executing it.
1992         </para>
1993
1994         <para>
1995           For HVM instances, this will attempt to connect to the
1996           serial console of the instance. To connect to the
1997           virtualized "physical" console of a HVM instance, use a VNC
1998           client with the connection info from the
1999           <command>info</command> command.
2000         </para>
2001
2002         <para>
2003           Example:
2004           <screen>
2005 # gnt-instance console instance1.example.com
2006           </screen>
2007         </para>
2008       </refsect3>
2009
2010     </refsect2>
2011
2012     <refsect2>
2013       <title>Disk management</title>
2014
2015       <refsect3>
2016         <title>REPLACE-DISKS</title>
2017
2018         <cmdsynopsis>
2019           <command>replace-disks</command>
2020           <arg>--submit</arg>
2021           <arg>--early-release</arg>
2022           <arg choice="req">-p</arg>
2023           <arg>--disks <replaceable>idx</replaceable></arg>
2024           <arg choice="req"><replaceable>instance</replaceable></arg>
2025         </cmdsynopsis>
2026
2027         <cmdsynopsis>
2028           <command>replace-disks</command>
2029           <arg>--submit</arg>
2030           <arg>--early-release</arg>
2031           <arg choice="req">-s</arg>
2032           <arg>--disks <replaceable>idx</replaceable></arg>
2033           <arg choice="req"><replaceable>instance</replaceable></arg>
2034         </cmdsynopsis>
2035
2036         <cmdsynopsis>
2037           <command>replace-disks</command>
2038           <arg>--submit</arg>
2039           <arg>--early-release</arg>
2040           <group choice="req">
2041             <arg>--iallocator <replaceable>name</replaceable></arg>
2042             <arg>--new-secondary <replaceable>NODE</replaceable></arg>
2043           </group>
2044
2045           <arg choice="req"><replaceable>instance</replaceable></arg>
2046         </cmdsynopsis>
2047
2048         <cmdsynopsis>
2049           <command>replace-disks</command>
2050           <arg>--submit</arg>
2051           <arg>--early-release</arg>
2052           <arg choice="req">--auto</arg>
2053           <arg choice="req"><replaceable>instance</replaceable></arg>
2054         </cmdsynopsis>
2055
2056         <para>
2057           This command is a generalized form for replacing disks. It
2058           is currently only valid for the mirrored (DRBD) disk
2059           template.
2060         </para>
2061
2062         <para>
2063           The first form (when passing the <option>-p</option> option)
2064           will replace the disks on the primary, while the second form
2065           (when passing the <option>-s</option> option will replace
2066           the disks on the secondary node. For these two cases (as the
2067           node doesn't change), it is possible to only run the replace
2068           for a subset of the disks, using the option
2069           <option>--disks</option> which takes a list of
2070           comma-delimited disk indices (zero-based),
2071           e.g. <userinput>0,2</userinput> to replace only the first
2072           and third disks.
2073         </para>
2074
2075         <para>
2076           The third form (when passing either the
2077           <option>--iallocator</option> or the
2078           <option>--new-secondary</option> option) is designed to
2079           change secondary node of the instance.  Specifying
2080           <option>--iallocator</option> makes the new secondary be
2081           selected automatically by the specified allocator plugin,
2082           otherwise the new secondary node will be the one chosen
2083           manually via the <option>--new-secondary</option> option.
2084         </para>
2085
2086         <para>
2087           The fourth form (when using <option>--auto</option>) will
2088           automatically determine which disks of an instance are faulty and
2089           replace them within the same node. The <option>--auto</option>
2090           option works only when an instance has only faulty disks on
2091           either the primary or secondary node; it doesn't work when
2092           both sides have faulty disks.
2093         </para>
2094
2095         <para>
2096           The <option>--submit</option> option is used to send the job to
2097           the master daemon but not wait for its completion. The job
2098           ID will be shown so that it can be examined via
2099           <command>gnt-job info</command>.
2100         </para>
2101
2102         <para>
2103           The <option>--early-release</option> changes the code so
2104           that the old storage on secondary node(s) is removed early
2105           (before the resync is completed) and the internal Ganeti
2106           locks for the current (and new, if any) secondary node are
2107           also released, thus allowing more parallelism in the cluster
2108           operation. This should be used only when recovering from a
2109           disk failure on the current secondary (thus the old storage
2110           is already broken) or when the storage on the primary node
2111           is known to be fine (thus we won't need the old storage for
2112           potential recovery).
2113         </para>
2114
2115         <para>
2116           Note that it is not possible to select an offline or drained
2117           node as a new secondary.
2118         </para>
2119
2120       </refsect3>
2121
2122       <refsect3>
2123         <title>ACTIVATE-DISKS</title>
2124
2125         <cmdsynopsis>
2126           <command>activate-disks</command>
2127           <arg>--submit</arg>
2128           <arg>--ignore-size</arg>
2129           <arg choice="req"><replaceable>instance</replaceable></arg>
2130         </cmdsynopsis>
2131         <para>
2132           Activates the block devices of the given instance. If
2133           successful, the command will show the location and name of
2134           the block devices:
2135           <screen>
2136 node1.example.com:disk/0:/dev/drbd0
2137 node1.example.com:disk/1:/dev/drbd1
2138           </screen>
2139
2140           In this example, <emphasis>node1.example.com</emphasis> is
2141           the name of the node on which the devices have been
2142           activated. The <emphasis>disk/0</emphasis> and
2143           <emphasis>disk/1</emphasis> are the Ganeti-names of the
2144           instance disks; how they are visible inside the instance is
2145           hypervisor-specific. <emphasis>/dev/drbd0</emphasis> and
2146           <emphasis>/dev/drbd1</emphasis> are the actual block devices
2147           as visible on the node.
2148         </para>
2149
2150         <para>
2151           The <option>--submit</option> option is used to send the job to
2152           the master daemon but not wait for its completion. The job
2153           ID will be shown so that it can be examined via
2154           <command>gnt-job info</command>.
2155         </para>
2156
2157         <para>
2158           The <option>--ignore-size</option> option can be used to
2159           activate disks ignoring the currently configured size in
2160           Ganeti. This can be used in cases where the configuration
2161           has gotten out of sync with the real-world (e.g. after a
2162           partially-failed grow-disk operation or due to rounding in
2163           LVM devices). This should not be used in normal cases, but
2164           only when activate-disks fails without it.
2165         </para>
2166
2167         <para>
2168           Note that it is safe to run this command while the instance
2169           is already running.
2170         </para>
2171       </refsect3>
2172
2173       <refsect3>
2174         <title>DEACTIVATE-DISKS</title>
2175
2176         <cmdsynopsis>
2177           <command>deactivate-disks</command>
2178           <arg>--submit</arg>
2179           <arg choice="req"><replaceable>instance</replaceable></arg>
2180         </cmdsynopsis>
2181         <para>
2182           De-activates the block devices of the given instance. Note
2183           that if you run this command for an instance with a drbd
2184           disk template, while it is running, it will not be able to
2185           shutdown the block devices on the primary node, but it will
2186           shutdown the block devices on the secondary nodes, thus
2187           breaking the replication.
2188         </para>
2189
2190         <para>
2191           The <option>--submit</option> option is used to send the job to
2192           the master daemon but not wait for its completion. The job
2193           ID will be shown so that it can be examined via
2194           <command>gnt-job info</command>.
2195         </para>
2196
2197       </refsect3>
2198
2199       <refsect3>
2200         <title>GROW-DISK</title>
2201         <cmdsynopsis>
2202           <command>grow-disk</command>
2203           <arg>--no-wait-for-sync</arg>
2204           <arg>--submit</arg>
2205           <arg choice="req"><replaceable>instance</replaceable></arg>
2206           <arg choice="req"><replaceable>disk</replaceable></arg>
2207           <arg choice="req"><replaceable>amount</replaceable></arg>
2208         </cmdsynopsis>
2209
2210         <para>
2211           Grows an instance's disk. This is only possible for
2212           instances having a <literal>plain</literal> or
2213           <literal>drbd</literal> disk template.
2214         </para>
2215
2216         <para>
2217           Note that this command only change the block device size; it
2218           will not grow the actual filesystems, partitions, etc. that
2219           live on that disk. Usually, you will need to:
2220           <orderedlist>
2221             <listitem>
2222               <simpara>use <command>gnt-instance grow-disk</command></simpara>
2223             </listitem>
2224             <listitem>
2225               <simpara>reboot the instance (later, at a convenient
2226               time)</simpara>
2227             </listitem>
2228             <listitem>
2229               <simpara>use a filesystem resizer, such as
2230               <citerefentry> <refentrytitle>ext2online</refentrytitle>
2231               <manvolnum>8</manvolnum> </citerefentry> or
2232               <citerefentry> <refentrytitle>xfs_growfs</refentrytitle>
2233               <manvolnum>8</manvolnum> </citerefentry> to resize the
2234               filesystem, or use <citerefentry>
2235               <refentrytitle>fdisk</refentrytitle>
2236               <manvolnum>8</manvolnum> </citerefentry> to change the
2237               partition table on the disk
2238               </simpara>
2239             </listitem>
2240           </orderedlist>
2241         </para>
2242
2243
2244         <para>
2245           The <replaceable>disk</replaceable> argument is the index of
2246           the instance disk to grow. The
2247           <replaceable>amount</replaceable> argument is given either
2248           as a number (and it represents the amount to increase the
2249           disk with in mebibytes) or can be given similar to the
2250           arguments in the create instance operation, with a suffix
2251           denoting the unit.
2252         </para>
2253
2254         <para>
2255           Note that the disk grow operation might complete on one node
2256           but fail on the other; this will leave the instance with
2257           different-sized LVs on the two nodes, but this will not
2258           create problems (except for unused space).
2259         </para>
2260
2261         <para>
2262           If you do not want gnt-instance to wait for the new disk
2263           region to be synced, use the
2264           <option>--no-wait-for-sync</option> option.
2265         </para>
2266
2267         <para>
2268           The <option>--submit</option> option is used to send the job to
2269           the master daemon but not wait for its completion. The job
2270           ID will be shown so that it can be examined via
2271           <command>gnt-job info</command>.
2272         </para>
2273
2274
2275         <para>Example (increase the first disk for instance1 by 16GiB):
2276           <screen>
2277 # gnt-instance grow-disk instance1.example.com 0 16g
2278           </screen>
2279         </para>
2280
2281         <para>
2282           Also note that disk shrinking is not supported; use
2283           <command>gnt-backup export</command> and then
2284           <command>gnt-backup import</command> to reduce the disk size
2285           of an instance.
2286         </para>
2287       </refsect3>
2288
2289       <refsect3>
2290         <title>RECREATE-DISKS</title>
2291
2292         <cmdsynopsis>
2293           <command>recreate-disks</command>
2294           <arg>--submit</arg>
2295           <arg>--disks=<option>indices</option></arg>
2296           <arg choice="req"><replaceable>instance</replaceable></arg>
2297         </cmdsynopsis>
2298         <para>
2299           Recreates the disks of the given instance, or only a subset
2300           of the disks (if the option <option>disks</option> is
2301           passed, which must be a comma-separated list of disk
2302           indices, starting from zero).
2303         </para>
2304
2305         <para>
2306           Note that this functionality should only be used for missing
2307           disks; if any of the given disks already exists, the
2308           operation will fail. While this is suboptimal,
2309           recreate-disks should hopefully not be needed in normal
2310           operation and as such the impact of this is low.
2311         </para>
2312
2313         <para>
2314           The <option>--submit</option> option is used to send the job to
2315           the master daemon but not wait for its completion. The job
2316           ID will be shown so that it can be examined via
2317           <command>gnt-job info</command>.
2318         </para>
2319
2320       </refsect3>
2321
2322     </refsect2>
2323
2324     <refsect2>
2325       <title>Recovery</title>
2326
2327       <refsect3>
2328         <title>FAILOVER</title>
2329
2330         <cmdsynopsis>
2331           <command>failover</command>
2332           <arg>-f</arg>
2333           <arg>--ignore-consistency</arg>
2334           <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
2335           <arg>--submit</arg>
2336           <arg choice="req"><replaceable>instance</replaceable></arg>
2337         </cmdsynopsis>
2338
2339         <para>
2340           Failover will fail the instance over its secondary
2341           node. This works only for instances having a drbd disk
2342           template.
2343         </para>
2344
2345         <para>
2346           Normally the failover will check the consistency of the
2347           disks before failing over the instance. If you are trying to
2348           migrate instances off a dead node, this will fail. Use the
2349           <option>--ignore-consistency</option> option for this
2350           purpose. Note that this option can be dangerous as errors in
2351           shutting down the instance will be ignored, resulting in
2352           possibly having the instance running on two machines in
2353           parallel (on disconnected DRBD drives).
2354         </para>
2355
2356         <para>
2357           The <option>--shutdown-timeout</option> is used to specify how
2358           much time to wait before forcing the shutdown (xm destroy in xen,
2359           killing the kvm process, for kvm). By default two minutes are
2360           given to each instance to stop.
2361         </para>
2362
2363         <para>
2364           The <option>--submit</option> option is used to send the job to
2365           the master daemon but not wait for its completion. The job
2366           ID will be shown so that it can be examined via
2367           <command>gnt-job info</command>.
2368         </para>
2369
2370         <para>
2371           Example:
2372           <screen>
2373 # gnt-instance failover instance1.example.com
2374           </screen>
2375         </para>
2376       </refsect3>
2377
2378       <refsect3>
2379         <title>MIGRATE</title>
2380
2381         <cmdsynopsis>
2382           <command>migrate</command>
2383           <arg>-f</arg>
2384           <arg choice="req">--cleanup</arg>
2385           <arg choice="req"><replaceable>instance</replaceable></arg>
2386         </cmdsynopsis>
2387
2388         <cmdsynopsis>
2389           <command>migrate</command>
2390           <arg>-f</arg>
2391           <arg>--non-live</arg>
2392           <arg choice="req"><replaceable>instance</replaceable></arg>
2393         </cmdsynopsis>
2394
2395         <para>
2396           Migrate will move the instance to its secondary node without
2397           shutdown. It only works for instances having the drbd8 disk
2398           template type.
2399         </para>
2400
2401         <para>
2402           The migration command needs a perfectly healthy instance, as
2403           we rely on the dual-master capability of drbd8 and the disks
2404           of the instance are not allowed to be degraded.
2405         </para>
2406
2407         <para>
2408           The <option>--non-live</option> option will switch (for the
2409           hypervisors that support it) between a "fully live"
2410           (i.e. the interruption is as minimal as possible) migration
2411           and one in which the instance is frozen, its state saved and
2412           transported to the remote node, and then resumed there. This
2413           all depends on the hypervisor support for two different
2414           methods. In any case, it is not an error to pass this
2415           parameter (it will just be ignored if the hypervisor doesn't
2416           support it).
2417         </para>
2418
2419         <para>
2420           If the <option>--cleanup</option> option is passed, the
2421           operation changes from migration to attempting recovery from
2422           a failed previous migration. In this mode, Ganeti checks if
2423           the instance runs on the correct node (and updates its
2424           configuration if not) and ensures the instances's disks are
2425           configured correctly. In this mode, the
2426           <option>--non-live</option> option is ignored.
2427         </para>
2428
2429         <para>
2430           The option <option>-f</option> will skip the prompting for
2431           confirmation.
2432         </para>
2433         <para>
2434           Example (and expected output):
2435           <screen>
2436 # gnt-instance migrate instance1
2437 Migrate will happen to the instance instance1. Note that migration is
2438 **experimental** in this version. This might impact the instance if
2439 anything goes wrong. Continue?
2440 y/[n]/?: y
2441 * checking disk consistency between source and target
2442 * ensuring the target is in secondary mode
2443 * changing disks into dual-master mode
2444  - INFO: Waiting for instance instance1 to sync disks.
2445  - INFO: Instance instance1's disks are in sync.
2446 * migrating instance to node2.example.com
2447 * changing the instance's disks on source node to secondary
2448  - INFO: Waiting for instance instance1 to sync disks.
2449  - INFO: Instance instance1's disks are in sync.
2450 * changing the instance's disks to single-master
2451 #
2452           </screen>
2453         </para>
2454       </refsect3>
2455
2456       <refsect3>
2457         <title>MOVE</title>
2458
2459         <cmdsynopsis>
2460           <command>move</command>
2461           <arg>-f</arg>
2462           <arg>-n <replaceable>node</replaceable></arg>
2463           <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
2464           <arg>--submit</arg>
2465           <arg choice="req"><replaceable>instance</replaceable></arg>
2466         </cmdsynopsis>
2467
2468         <para>
2469           Move will move the instance to an arbitrary node in the
2470           cluster. This works only for instances having a plain or
2471           file disk template.
2472         </para>
2473
2474         <para>
2475           Note that since this operation is done via data copy, it
2476           will take a long time for big disks (similar to
2477           replace-disks for a drbd instance).
2478         </para>
2479
2480         <para>
2481           The <option>--shutdown-timeout</option> is used to specify how
2482           much time to wait before forcing the shutdown (xm destroy in xen,
2483           killing the kvm process, for kvm). By default two minutes are
2484           given to each instance to stop.
2485         </para>
2486
2487         <para>
2488           The <option>--submit</option> option is used to send the job to
2489           the master daemon but not wait for its completion. The job
2490           ID will be shown so that it can be examined via
2491           <command>gnt-job info</command>.
2492         </para>
2493
2494         <para>
2495           Example:
2496           <screen>
2497 # gnt-instance move -n node3.example.com instance1.example.com
2498           </screen>
2499         </para>
2500       </refsect3>
2501
2502     </refsect2>
2503
2504     <refsect2>
2505       <title>TAGS</title>
2506
2507     <refsect3>
2508         <title>ADD-TAGS</title>
2509
2510         <cmdsynopsis>
2511           <command>add-tags</command>
2512           <arg choice="opt">--from <replaceable>file</replaceable></arg>
2513           <arg choice="req"><replaceable>instancename</replaceable></arg>
2514           <arg choice="req"
2515             rep="repeat"><replaceable>tag</replaceable></arg>
2516         </cmdsynopsis>
2517
2518         <para>
2519           Add tags to the given instance. If any of the tags contains
2520           invalid characters, the entire operation will abort.
2521         </para>
2522         <para>
2523           If the <option>--from</option> option is given, the list of
2524           tags will be extended with the contents of that file (each
2525           line becomes a tag). In this case, there is not need to pass
2526           tags on the command line (if you do, both sources will be
2527           used). A file name of - will be interpreted as stdin.
2528         </para>
2529       </refsect3>
2530
2531       <refsect3>
2532         <title>LIST-TAGS</title>
2533
2534         <cmdsynopsis>
2535           <command>list-tags</command>
2536           <arg choice="req"><replaceable>instancename</replaceable></arg>
2537         </cmdsynopsis>
2538
2539         <para>List the tags of the given instance.</para>
2540       </refsect3>
2541
2542       <refsect3>
2543         <title>REMOVE-TAGS</title>
2544         <cmdsynopsis>
2545           <command>remove-tags</command>
2546           <arg choice="opt">--from <replaceable>file</replaceable></arg>
2547           <arg choice="req"><replaceable>instancename</replaceable></arg>
2548           <arg choice="req"
2549             rep="repeat"><replaceable>tag</replaceable></arg>
2550         </cmdsynopsis>
2551
2552         <para>
2553           Remove tags from the given instance. If any of the tags are
2554           not existing on the node, the entire operation will abort.
2555         </para>
2556
2557         <para>
2558           If the <option>--from</option> option is given, the list of
2559           tags will be extended with the contents of that file (each
2560           line becomes a tag). In this case, there is not need to pass
2561           tags on the command line (if you do, both sources will be
2562           used). A file name of - will be interpreted as stdin.
2563         </para>
2564       </refsect3>
2565
2566     </refsect2>
2567
2568   </refsect1>
2569
2570   &footer;
2571
2572 </refentry>
2573
2574 <!-- Keep this comment at the end of the file
2575 Local variables:
2576 mode: sgml
2577 sgml-omittag:t
2578 sgml-shorttag:t
2579 sgml-minimize-attributes:nil
2580 sgml-always-quote-attributes:t
2581 sgml-indent-step:2
2582 sgml-indent-data:t
2583 sgml-parent-document:nil
2584 sgml-default-dtd-file:nil
2585 sgml-exposed-tags:nil
2586 sgml-local-catalogs:nil
2587 sgml-local-ecat-files:nil
2588 End:
2589 -->