code.grnet.gr Git - ganeti-local/blob - man/gnt-node.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-node</refentrytitle>">
  10   <!ENTITY dhpackage   "gnt-node">
  11
  12   <!ENTITY debian      "<productname>Debian</productname>">
  13   <!ENTITY gnu         "<acronym>GNU</acronym>">
  14   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  15   <!ENTITY footer SYSTEM "footer.sgml">
  16 ]>
  17
  18 <refentry>
  19   <refentryinfo>
  20     <copyright>
  21       <year>2006</year>
  22       <year>2007</year>
  23       <year>2008</year>
  24       <year>2009</year>
  25       <holder>Google Inc.</holder>
  26     </copyright>
  27     &dhdate;
  28   </refentryinfo>
  29   <refmeta>
  30     &dhucpackage;
  31
  32     &dhsection;
  33     <refmiscinfo>Ganeti 2.2</refmiscinfo>
  34   </refmeta>
  35   <refnamediv>
  36     <refname>&dhpackage;</refname>
  37
  38     <refpurpose>Node administration</refpurpose>
  39   </refnamediv>
  40   <refsynopsisdiv>
  41     <cmdsynopsis>
  42       <command>&dhpackage; </command>
  43
  44       <arg choice="req">command</arg>
  45       <arg>arguments...</arg>
  46     </cmdsynopsis>
  47   </refsynopsisdiv>
  48   <refsect1>
  49     <title>DESCRIPTION</title>
  50
  51     <para>
  52       The <command>&dhpackage;</command> is used for managing the
  53       (physical) nodes in the Ganeti system.
  54     </para>
  55
  56   </refsect1>
  57   <refsect1>
  58     <title>COMMANDS</title>
  59
  60     <refsect2>
  61       <title>ADD</title>
  62
  63       <cmdsynopsis>
  64         <command>add</command>
  65         <arg>--readd</arg>
  66         <arg>-s <replaceable>secondary_ip</replaceable></arg>
  67         <arg>-g <replaceable>nodegroup</replaceable></arg>
  68         <arg>--master-capable=<option>yes|no</option></arg>
  69         <arg>--vm-capable=<option>yes|no</option></arg>
  70         <arg choice="req"><replaceable>nodename</replaceable></arg>
  71       </cmdsynopsis>
  72
  73       <para>
  74         Adds the given node to the cluster.
  75       </para>
  76
  77       <para>
  78         This command is used to join a new node to the cluster. You
  79         will have to provide the password for root of the node to be
  80         able to add the node in the cluster. The command needs to be
  81         run on the Ganeti master.
  82       </para>
  83
  84       <para>
  85         Note that the command is potentially destructive, as it will
  86         forcibly join the specified host the cluster, not paying
  87         attention to its current status (it could be already in a
  88         cluster, etc.)
  89       </para>
  90
  91       <para>
  92         The <option>-s</option> is used in dual-home clusters and
  93         specifies the new node's IP in the secondary network. See the
  94         discussion in <citerefentry>
  95         <refentrytitle>gnt-cluster</refentrytitle>
  96         <manvolnum>8</manvolnum> </citerefentry> for more
  97         information.
  98       </para>
  99
 100       <para>
 101         In case you're readding a node after hardware failure, you can
 102         use the <option>--readd</option> parameter. In this case, you
 103         don't need to pass the secondary IP again, it will reused from
 104         the cluster. Also, the <literal>drained</literal> and
 105         <literal>offline</literal> flags of the node will be cleared
 106         before re-adding it.
 107       </para>
 108
 109       <para>
 110         The <option>-g</option> is used to add the new node into a specific
 111         node group, specified by uuid or name. If only one node group exists
 112         you can skip this option, otherwise it's mandatory.
 113       </para>
 114
 115       <para>
 116         The <option>vm_capable</option>
 117         and <option>master_capable</option> options are described
 118         in <citerefentry><refentrytitle>ganeti</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 119         and are used to set the properties of the new node.
 120       </para>
 121
 122       <para>
 123         Example:
 124         <screen>
 125 # gnt-node add node5.example.com
 126 # gnt-node add -s 192.0.2.5 node5.example.com
 127 # gnt-node add -g group2 -s 192.0.2.9 node9.group2.example.com
 128         </screen>
 129       </para>
 130     </refsect2>
 131
 132     <refsect2>
 133       <title>ADD-TAGS</title>
 134
 135       <cmdsynopsis>
 136         <command>add-tags</command>
 137         <arg choice="opt">--from <replaceable>file</replaceable></arg>
 138         <arg choice="req"><replaceable>nodename</replaceable></arg>
 139         <arg choice="req"
 140         rep="repeat"><replaceable>tag</replaceable></arg>
 141       </cmdsynopsis>
 142
 143       <para>
 144         Add tags to the given node. If any of the tags contains
 145         invalid characters, the entire operation will abort.
 146       </para>
 147
 148       <para>
 149         If the <option>--from</option> option is given, the list of
 150         tags will be extended with the contents of that file (each
 151         line becomes a tag). In this case, there is not need to pass
 152         tags on the command line (if you do, both sources will be
 153         used). A file name of - will be interpreted as stdin.
 154       </para>
 155     </refsect2>
 156
 157     <refsect2>
 158       <title>EVACUATE</title>
 159
 160       <cmdsynopsis>
 161         <command>evacuate</command>
 162         <arg>-f</arg>
 163         <arg>--early-release</arg>
 164         <group>
 165           <arg>--iallocator <replaceable>NAME</replaceable></arg>
 166           <arg>--new-secondary <replaceable>destination_node</replaceable></arg>
 167         </group>
 168         <arg choice="req" rep="repeat"><replaceable>node</replaceable></arg>
 169       </cmdsynopsis>
 170
 171       <para>
 172         This command will move all secondary instances away from the
 173         given node(s). It works only for instances having a drbd disk
 174         template.
 175       </para>
 176
 177       <para>
 178         The new location for the instances can be specified in two ways:
 179         <itemizedlist>
 180           <listitem>
 181             <simpara>as a single node for all instances, via the
 182             <option>--new-secondary</option> option</simpara>
 183           </listitem>
 184           <listitem>
 185             <simpara>or via the <option>--iallocator</option> option,
 186             giving a script name as parameter, so each instance will
 187             be in turn placed on the (per the script) optimal
 188             node</simpara>
 189           </listitem>
 190         </itemizedlist>
 191       </para>
 192
 193       <para>
 194         The <option>--early-release</option> changes the code so that
 195         the old storage on node being evacuated is removed early
 196         (before the resync is completed) and the internal Ganeti locks
 197         are also released for both the current secondary and the new
 198         secondary, thus allowing more parallelism in the cluster
 199         operation. This should be used only when recovering from a
 200         disk failure on the current secondary (thus the old storage is
 201         already broken) or when the storage on the primary node is
 202         known to be fine (thus we won't need the old storage for
 203         potential recovery).
 204       </para>
 205
 206       <para>
 207         Example:
 208         <screen>
 209           # gnt-node evacuate -I dumb node3.example.com
 210         </screen>
 211       </para>
 212     </refsect2>
 213
 214     <refsect2>
 215       <title>FAILOVER</title>
 216
 217       <cmdsynopsis>
 218         <command>failover</command>
 219         <arg>-f</arg>
 220         <arg>--ignore-consistency</arg>
 221         <arg choice="req"><replaceable>node</replaceable></arg>
 222       </cmdsynopsis>
 223
 224       <para>
 225         This command will fail over all instances having the given
 226         node as primary to their secondary nodes. This works only for
 227         instances having a drbd disk template.
 228       </para>
 229
 230       <para>
 231         Normally the failover will check the consistency of the disks
 232         before failing over the instance. If you are trying to migrate
 233         instances off a dead node, this will fail. Use the
 234         <option>--ignore-consistency</option> option for this purpose.
 235       </para>
 236
 237       <para>
 238         Example:
 239         <screen>
 240           # gnt-node failover node1.example.com
 241         </screen>
 242       </para>
 243     </refsect2>
 244
 245     <refsect2>
 246       <title>INFO</title>
 247
 248       <cmdsynopsis>
 249         <command>info</command>
 250         <arg rep="repeat"><replaceable>node</replaceable></arg>
 251       </cmdsynopsis>
 252
 253       <para>
 254         Show detailed information about the nodes in the cluster. If you
 255         don't give any arguments, all nodes will be shows, otherwise the
 256         output will be restricted to the given names.
 257       </para>
 258     </refsect2>
 259
 260     <refsect2>
 261       <title>LIST</title>
 262
 263       <cmdsynopsis>
 264         <command>list</command>
 265         <arg>--sync</arg>
 266         <sbr>
 267         <arg>--no-headers</arg>
 268         <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
 269         <sbr>
 270         <arg>--units=<replaceable>UNITS</replaceable></arg>
 271         <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
 272         <sbr>
 273         <arg>--roman</arg>
 274         <sbr>
 275         <arg rep="repeat">node</arg>
 276       </cmdsynopsis>
 277
 278       <para>
 279         Lists the nodes in the cluster.
 280       </para>
 281
 282       <para>
 283         The <option>--no-headers</option> option will skip the initial
 284         header line. The <option>--separator</option> option takes an
 285         argument which denotes what will be used between the output
 286         fields. Both these options are to help scripting.
 287       </para>
 288
 289       <para>
 290         The units used to display the numeric values in the output
 291         varies, depending on the options given. By default, the values
 292         will be formatted in the most appropriate unit. If the
 293         <option>--separator</option> option is given, then the values
 294         are shown in mebibytes to allow parsing by scripts. In both
 295         cases, the <option>--units</option> option can be used to
 296         enforce a given output unit.
 297       </para>
 298
 299       <para>
 300         By default, the query of nodes will be done in parallel with
 301         any running jobs. This might give inconsistent results for the
 302         free disk/memory. The <option>--sync</option> can be used to
 303         grab locks for all the nodes and ensure consistent view of the
 304         cluster (but this might stall the query for a long time).
 305       </para>
 306
 307       <para>
 308         Passing the <option>--roman</option> option gnt-node list will try to
 309         output some of its fields in a latin-friendly way. This is not the
 310         default for backwards compatibility.
 311       </para>
 312
 313       <para>
 314         The <option>-o</option> option takes a comma-separated list of
 315         output fields. The available fields and their meaning are:
 316         <variablelist>
 317           <varlistentry>
 318             <term>name</term>
 319             <listitem>
 320               <simpara>the node name</simpara>
 321             </listitem>
 322           </varlistentry>
 323           <varlistentry>
 324             <term>pinst_cnt</term>
 325             <listitem>
 326               <simpara>the number of instances having this node as
 327               primary</simpara>
 328             </listitem>
 329           </varlistentry>
 330           <varlistentry>
 331             <term>pinst_list</term>
 332             <listitem>
 333               <simpara>the list of instances having this node as
 334               primary, comma separated</simpara>
 335             </listitem>
 336           </varlistentry>
 337           <varlistentry>
 338             <term>sinst_cnt</term>
 339             <listitem>
 340               <simpara>the number of instances having this node as a
 341               secondary node</simpara>
 342             </listitem>
 343           </varlistentry>
 344           <varlistentry>
 345             <term>sinst_list</term>
 346             <listitem>
 347               <simpara>the list of instances having this node as a
 348               secondary node, comma separated</simpara>
 349             </listitem>
 350           </varlistentry>
 351           <varlistentry>
 352             <term>pip</term>
 353             <listitem>
 354               <simpara>the primary ip of this node (used for cluster
 355               communication)</simpara>
 356             </listitem>
 357           </varlistentry>
 358           <varlistentry>
 359             <term>sip</term>
 360             <listitem>
 361               <simpara>
 362                 the secondary ip of this node (used for data
 363                 replication in dual-ip clusters, see <citerefentry>
 364                 <refentrytitle>gnt-cluster</refentrytitle>
 365                 <manvolnum>8</manvolnum>
 366                 </citerefentry>
 367               </simpara>
 368             </listitem>
 369           </varlistentry>
 370           <varlistentry>
 371             <term>dtotal</term>
 372             <listitem>
 373               <simpara>total disk space in the volume group used for
 374               instance disk allocations</simpara>
 375             </listitem>
 376           </varlistentry>
 377           <varlistentry>
 378             <term>dfree</term>
 379             <listitem>
 380               <simpara>available disk space in the volume group</simpara>
 381             </listitem>
 382           </varlistentry>
 383           <varlistentry>
 384             <term>mtotal</term>
 385             <listitem>
 386               <simpara>total memory on the physical node</simpara>
 387             </listitem>
 388           </varlistentry>
 389           <varlistentry>
 390             <term>mnode</term>
 391             <listitem>
 392               <simpara>the memory used by the node itself</simpara>
 393             </listitem>
 394           </varlistentry>
 395           <varlistentry>
 396             <term>mfree</term>
 397             <listitem>
 398               <simpara>memory available for instance
 399               allocations</simpara>
 400             </listitem>
 401           </varlistentry>
 402           <varlistentry>
 403             <term>bootid</term>
 404             <listitem>
 405               <simpara>the node bootid value; this is a linux specific
 406               feature that assigns a new UUID to the node at each boot
 407               and can be use to detect node reboots (by tracking
 408               changes in this value)</simpara>
 409             </listitem>
 410           </varlistentry>
 411           <varlistentry>
 412             <term>tags</term>
 413             <listitem>
 414               <simpara>comma-separated list of the node's
 415               tags</simpara>
 416             </listitem>
 417           </varlistentry>
 418           <varlistentry>
 419             <term>serial_no</term>
 420             <listitem>
 421               <simpara>the so called 'serial number' of the node;
 422               this is a numeric field that is incremented each time
 423               the node is modified, and it can be used to detect
 424               modifications</simpara>
 425             </listitem>
 426           </varlistentry>
 427           <varlistentry>
 428             <term>ctime</term>
 429             <listitem>
 430               <para>
 431                 the creation time of the node; note that this field
 432                 contains spaces and as such it's harder to parse
 433               </para>
 434               <para>
 435                 if this attribute is not present (e.g. when upgrading
 436                 from older versions), then "N/A" will be shown instead
 437               </para>
 438             </listitem>
 439           </varlistentry>
 440           <varlistentry>
 441             <term>mtime</term>
 442             <listitem>
 443               <para>
 444                 the last modification time of the node; note that this
 445                 field contains spaces and as such it's harder to parse
 446               </para>
 447               <para>
 448                 if this attribute is not present (e.g. when upgrading
 449                 from older versions), then "N/A" will be shown instead
 450               </para>
 451             </listitem>
 452           </varlistentry>
 453           <varlistentry>
 454             <term>uuid</term>
 455             <listitem>
 456               <simpara>Show the UUID of the node (generated
 457                 automatically by Ganeti)</simpara>
 458             </listitem>
 459           </varlistentry>
 460
 461           <varlistentry>
 462             <term>ctotal</term>
 463             <listitem>
 464               <simpara>the toal number of logical processors</simpara>
 465             </listitem>
 466           </varlistentry>
 467           <varlistentry>
 468             <term>cnodes</term>
 469             <listitem>
 470               <simpara>the number of NUMA domains on the node, if the
 471               hypervisor can export this information</simpara>
 472             </listitem>
 473           </varlistentry>
 474           <varlistentry>
 475             <term>csockets</term>
 476             <listitem>
 477               <simpara>the number of physical CPU sockets, if the
 478               hypervisor can export this information</simpara>
 479             </listitem>
 480           </varlistentry>
 481           <varlistentry>
 482             <term>master_candidate</term>
 483             <listitem>
 484               <simpara>whether the node is a master candidate or not</simpara>
 485             </listitem>
 486           </varlistentry>
 487           <varlistentry>
 488             <term>drained</term>
 489             <listitem>
 490               <simpara>whether the node is drained or not; the cluster
 491               still communicates with drained nodes but excludes them
 492               from allocation operations</simpara>
 493             </listitem>
 494           </varlistentry>
 495           <varlistentry>
 496             <term>offline</term>
 497             <listitem>
 498               <simpara>whether the node is offline or not; if offline,
 499               the cluster does not communicate with offline nodes;
 500               useful for nodes that are not reachable in order to
 501               avoid delays</simpara>
 502             </listitem>
 503           </varlistentry>
 504           <varlistentry>
 505             <term>role</term>
 506             <listitem>
 507               <para>
 508                 A condensed version of the node flags; this field will
 509                 output a one-character field, with the following
 510                 possible values:
 511                 <itemizedlist>
 512                   <listitem>
 513                     <simpara><emphasis>M</emphasis> for the master
 514                     node</simpara>
 515                   </listitem>
 516                   <listitem>
 517                     <simpara><emphasis>C</emphasis> for a master
 518                     candidate</simpara>
 519                   </listitem>
 520                   <listitem>
 521                     <simpara><emphasis>R</emphasis> for a regular
 522                     node</simpara>
 523                   </listitem>
 524                   <listitem>
 525                     <simpara><emphasis>D</emphasis> for a drained
 526                     node</simpara>
 527                   </listitem>
 528                   <listitem>
 529                     <simpara><emphasis>O</emphasis> for an offline
 530                     node</simpara>
 531                   </listitem>
 532                 </itemizedlist>
 533               </para>
 534             </listitem>
 535           </varlistentry>
 536           <varlistentry>
 537             <term>master_capable</term>
 538             <listitem>
 539               <para>whether the node can become a master candidate</para>
 540             </listitem>
 541           </varlistentry>
 542           <varlistentry>
 543             <term>vm_capable</term>
 544             <listitem>
 545               <para>whether the node can host instances</para>
 546             </listitem>
 547           </varlistentry>
 548         </variablelist>
 549       </para>
 550
 551       <para>
 552         If the value of the option starts with the character
 553         <constant>+</constant>, the new fields will be added to the
 554         default list. This allows to quickly see the default list plus
 555         a few other fields, instead of retyping the entire list of
 556         fields.
 557       </para>
 558
 559       <para>
 560         Note that some of this fields are known from the configuration
 561         of the cluster (e.g. <simplelist type="inline">
 562         <member>name</member> <member>pinst</member>
 563         <member>sinst</member> <member>pip</member>
 564         <member>sip</member> </simplelist> and thus the master does
 565         not need to contact the node for this data (making the listing
 566         fast if only fields from this set are selected), whereas the
 567         other fields are "live" fields and we need to make a query to
 568         the cluster nodes.
 569       </para>
 570
 571       <para>
 572         Depending on the virtualization type and implementation
 573         details, the mtotal, mnode and mfree may have slighly varying
 574         meanings. For example, some solutions share the node memory
 575         with the pool of memory used for instances
 576         (<acronym>KVM</acronym>), whereas others have separate memory
 577         for the node and for the instances (Xen).
 578       </para>
 579
 580       <para>
 581         If no node names are given, then all nodes are
 582         queried. Otherwise, only the given nodes will be listed.
 583       </para>
 584     </refsect2>
 585
 586     <refsect2>
 587       <title>LIST-TAGS</title>
 588
 589       <cmdsynopsis>
 590         <command>list-tags</command>
 591         <arg choice="req"><replaceable>nodename</replaceable></arg>
 592       </cmdsynopsis>
 593
 594       <para>List the tags of the given node.</para>
 595     </refsect2>
 596
 597     <refsect2>
 598       <title>MIGRATE</title>
 599       <cmdsynopsis>
 600         <command>migrate</command>
 601         <arg>-f</arg>
 602         <arg>--non-live</arg>
 603         <arg>--migration-mode=live|non-live</arg>
 604         <arg choice="req"><replaceable>node</replaceable></arg>
 605       </cmdsynopsis>
 606
 607       <para>
 608         This command will migrate all instances having the given
 609         node as primary to their secondary nodes. This works only for
 610         instances having a drbd disk template.
 611       </para>
 612
 613       <para>
 614         As for the <command>gnt-instance migrate</command> command,
 615         the options <option>--no-live</option>
 616         and <option>--migration-mode</option> can be given to
 617         influence the migration type.
 618       </para>
 619
 620       <para>
 621         Example:
 622         <screen>
 623           # gnt-node migrate node1.example.com
 624         </screen>
 625       </para>
 626
 627     </refsect2>
 628
 629     <refsect2>
 630       <title>MODIFY</title>
 631       <cmdsynopsis>
 632         <command>modify</command>
 633         <arg>-f</arg>
 634         <arg>--submit</arg>
 635         <arg>--master-candidate=<option>yes|no</option></arg>
 636         <arg>--drained=<option>yes|no</option></arg>
 637         <arg>--offline=<option>yes|no</option></arg>
 638         <arg>--master-capable=<option>yes|no</option></arg>
 639         <arg>--vm-capable=<option>yes|no</option></arg>
 640         <arg>--auto-promote</arg>
 641         <arg choice="req"><replaceable>node</replaceable></arg>
 642       </cmdsynopsis>
 643
 644       <para>
 645         This command changes the role of the node. Each options takes
 646         either a literal <literal>yes</literal> or
 647         <literal>no</literal>, and only one option should be given as
 648         <literal>yes</literal>. The meaning of the roles and flags are
 649         described in the manpage <citerefentry>
 650         <refentrytitle>ganeti</refentrytitle> <manvolnum>7</manvolnum>
 651         </citerefentry>.
 652       </para>
 653
 654       <para>
 655         In case a node is demoted from the master candidate role, the
 656         operation will be refused unless you pass
 657         the <option>--auto-promote</option> option. This option will
 658         cause the operation to lock all cluster nodes (thus it will
 659         not be able to run in parallel with most other jobs), but it
 660         allows automated maintenance of the cluster candidate pool. If
 661         locking all cluster node is too expensive, another option is
 662         to promote manually another node to master candidate before
 663         demoting the current one.
 664       </para>
 665
 666       <para>
 667         Example (setting a node offline, which will demote it from
 668         master candidate role if is in that role):
 669         <screen>
 670 # gnt-node modify --offline=yes node1.example.com
 671         </screen>
 672       </para>
 673
 674       <para>Example (setting the node back to online and master candidate):
 675         <screen>
 676 # gnt-node modify --offline=no --master-candidate=yes node1.example.com
 677         </screen>
 678       </para>
 679
 680     </refsect2>
 681
 682     <refsect2>
 683       <title>REMOVE</title>
 684
 685       <cmdsynopsis>
 686         <command>remove</command>
 687         <arg choice="req"><replaceable>nodename</replaceable></arg>
 688       </cmdsynopsis>
 689
 690       <para>
 691         Removes a node from the cluster. Instances must be removed or
 692         migrated to another cluster before.
 693       </para>
 694
 695       <para>
 696         Example:
 697         <screen>
 698 # gnt-node remove node5.example.com
 699         </screen>
 700       </para>
 701     </refsect2>
 702
 703     <refsect2>
 704       <title>REMOVE-TAGS</title>
 705       <cmdsynopsis>
 706         <command>remove-tags</command>
 707         <arg choice="opt">--from <replaceable>file</replaceable></arg>
 708         <arg choice="req"><replaceable>nodename</replaceable></arg>
 709         <arg choice="req"
 710         rep="repeat"><replaceable>tag</replaceable></arg>
 711       </cmdsynopsis>
 712
 713       <para>
 714         Remove tags from the given node. If any of the tags are not
 715         existing on the node, the entire operation will abort.
 716       </para>
 717
 718       <para>
 719         If the <option>--from</option> option is given, the list of
 720         tags will be extended with the contents of that file (each
 721         line becomes a tag). In this case, there is not need to pass
 722         tags on the command line (if you do, both sources will be
 723         used). A file name of - will be interpreted as stdin.
 724       </para>
 725     </refsect2>
 726
 727     <refsect2>
 728       <title>VOLUMES</title>
 729
 730       <cmdsynopsis>
 731         <command>volumes</command>
 732         <arg>--no-headers</arg>
 733         <arg>--human-readable</arg>
 734         <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
 735         <arg>--output=<replaceable>FIELDS</replaceable></arg>
 736         <sbr>
 737         <arg rep="repeat"><replaceable>node</replaceable></arg>
 738       </cmdsynopsis>
 739
 740       <para>
 741         Lists all logical volumes and their physical disks from the node(s)
 742         provided.
 743       </para>
 744
 745       <para>
 746         The <option>--no-headers</option> option will skip the initial
 747         header line. The <option>--separator</option> option takes an
 748         argument which denotes what will be used between the output
 749         fields. Both these options are to help scripting.
 750       </para>
 751
 752       <para>
 753         The units used to display the numeric values in the output
 754         varies, depending on the options given. By default, the values
 755         will be formatted in the most appropriate unit. If the
 756         <option>--separator</option> option is given, then the values
 757         are shown in mebibytes to allow parsing by scripts. In both
 758         cases, the <option>--units</option> option can be used to
 759         enforce a given output unit.
 760       </para>
 761
 762       <para>
 763         The <option>-o</option> option takes a comma-separated list of
 764         output fields. The available fields and their meaning are:
 765         <variablelist>
 766           <varlistentry>
 767             <term>node</term>
 768             <listitem>
 769               <simpara>the node name on which the volume exists</simpara>
 770             </listitem>
 771           </varlistentry>
 772           <varlistentry>
 773             <term>phys</term>
 774             <listitem>
 775               <simpara>the physical drive (on which the LVM physical
 776               volume lives)</simpara>
 777             </listitem>
 778           </varlistentry>
 779           <varlistentry>
 780             <term>vg</term>
 781             <listitem>
 782               <simpara>the volume group name</simpara>
 783             </listitem>
 784           </varlistentry>
 785           <varlistentry>
 786             <term>name</term>
 787             <listitem>
 788               <simpara>the logical volume name</simpara>
 789             </listitem>
 790           </varlistentry>
 791           <varlistentry>
 792             <term>size</term>
 793             <listitem>
 794               <simpara>the logical volume size</simpara>
 795             </listitem>
 796           </varlistentry>
 797           <varlistentry>
 798             <term>instance</term>
 799             <listitem>
 800               <simpara>The name of the instance to which this volume
 801               belongs, or (in case it's an orphan volume) the
 802               character <quote>-</quote></simpara>
 803             </listitem>
 804           </varlistentry>
 805         </variablelist>
 806       </para>
 807
 808       <para>
 809         Example:
 810         <screen>
 811 # gnt-node volumes node5.example.com
 812 Node              PhysDev   VG    Name                                 Size Instance
 813 node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128  instance1.example.com
 814 node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256  instance1.example.com
 815         </screen>
 816       </para>
 817     </refsect2>
 818
 819     <refsect2>
 820       <title>LIST-STORAGE</title>
 821
 822       <cmdsynopsis>
 823         <command>list-storage</command>
 824         <arg>--no-headers</arg>
 825         <arg>--human-readable</arg>
 826         <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
 827         <arg>--storage-type=<replaceable>STORAGE_TYPE</replaceable></arg>
 828         <arg>--output=<replaceable>FIELDS</replaceable></arg>
 829         <sbr>
 830         <arg rep="repeat"><replaceable>node</replaceable></arg>
 831       </cmdsynopsis>
 832
 833       <para>
 834         Lists the available storage units and their details for the
 835         given node(s).
 836       </para>
 837
 838       <para>
 839         The <option>--no-headers</option> option will skip the initial header
 840         line. The <option>--separator</option> option takes an argument which
 841         denotes what will be used between the output fields. Both these options
 842         are to help scripting.
 843       </para>
 844
 845       <para>
 846         The units used to display the numeric values in the output varies,
 847         depending on the options given. By default, the values will be
 848         formatted in the most appropriate unit. If the
 849         <option>--separator</option> option is given, then the values are shown
 850         in mebibytes to allow parsing by scripts. In both cases, the
 851         <option>--units</option> option can be used to enforce a given output
 852         unit.
 853       </para>
 854
 855       <para>
 856         The <option>--storage-type</option> option can be used to choose a
 857         storage unit type. Possible choices are <literal>lvm-pv</literal>,
 858         <literal>lvm-vg</literal> or <literal>file</literal>.
 859       </para>
 860
 861       <para>
 862         The <option>-o</option> option takes a comma-separated list of
 863         output fields. The available fields and their meaning are:
 864         <variablelist>
 865           <varlistentry>
 866             <term>node</term>
 867             <listitem>
 868               <simpara>the node name on which the volume exists</simpara>
 869             </listitem>
 870           </varlistentry>
 871           <varlistentry>
 872             <term>type</term>
 873             <listitem>
 874               <simpara>the type of the storage unit (currently just
 875               what is passed in via
 876               <option>--storage-type</option>)</simpara>
 877             </listitem>
 878           </varlistentry>
 879           <varlistentry>
 880             <term>name</term>
 881             <listitem>
 882               <simpara>the path/identifier of the storage unit</simpara>
 883             </listitem>
 884           </varlistentry>
 885           <varlistentry>
 886             <term>size</term>
 887             <listitem>
 888               <simpara>
 889                 total size of the unit; for the file type see a note below
 890               </simpara>
 891             </listitem>
 892           </varlistentry>
 893           <varlistentry>
 894             <term>used</term>
 895             <listitem>
 896               <simpara>
 897                 used space in the unit; for the file type see a note below
 898               </simpara>
 899             </listitem>
 900           </varlistentry>
 901           <varlistentry>
 902             <term>free</term>
 903             <listitem>
 904               <simpara>
 905                 available disk space
 906               </simpara>
 907             </listitem>
 908           </varlistentry>
 909           <varlistentry>
 910             <term>allocatable</term>
 911             <listitem>
 912               <simpara>
 913                 whether we the unit is available for allocation
 914                 (only <literal>lvm-pv</literal> can change this
 915                 setting, the other types always report true)
 916               </simpara>
 917             </listitem>
 918           </varlistentry>
 919         </variablelist>
 920       </para>
 921
 922       <para>
 923         Note that for the <quote>file</quote> type, the total disk
 924         space might not equal to the sum of used and free, due to the
 925         method Ganeti uses to compute each of them. The total and free
 926         values are computed as the total and free space values for the
 927         filesystem to which the directory belongs, but the used space
 928         is computed from the used space under that directory
 929         <emphasis>only</emphasis>, which might not be necessarily the
 930         root of the filesystem, and as such there could be files
 931         outside the file storage directory using disk space and
 932         causing a mismatch in the values.
 933       </para>
 934
 935       <para>
 936         Example:
 937         <screen>
 938 node1# gnt-node list-storage node2
 939 Node  Type   Name        Size Used   Free Allocatable
 940 node2 lvm-pv /dev/sda7 673.8G 1.5G 672.3G Y
 941 node2 lvm-pv /dev/sdb1 698.6G   0M 698.6G Y
 942         </screen>
 943       </para>
 944     </refsect2>
 945
 946     <refsect2>
 947       <title>MODIFY-STORAGE</title>
 948
 949       <cmdsynopsis>
 950         <command>modify-storage</command>
 951         <arg><option>--allocatable=yes|no</option></arg>
 952         <sbr>
 953         <arg choice="req"><replaceable>node</replaceable></arg>
 954         <arg choice="req"><replaceable>storage-type</replaceable></arg>
 955         <arg choice="req"><replaceable>volume-name</replaceable></arg>
 956       </cmdsynopsis>
 957
 958       <para>
 959         Modifies storage volumes on a node. Only LVM physical volumes
 960         can be modified at the moment. They have a storage type
 961         of <quote>lvm-pv</quote>.
 962       </para>
 963
 964       <para>
 965         Example:
 966         <screen>
 967 # gnt-node modify-storage --allocatable no node5.example.com lvm-pv /dev/sdb1
 968         </screen>
 969       </para>
 970     </refsect2>
 971
 972     <refsect2>
 973       <title>REPAIR-STORAGE</title>
 974
 975       <cmdsynopsis>
 976         <command>repair-storage</command>
 977         <arg>--ignore-consistency</arg>
 978         <arg choice="req"><replaceable>node</replaceable></arg>
 979         <arg choice="req"><replaceable>storage-type</replaceable></arg>
 980         <arg choice="req"><replaceable>volume-name</replaceable></arg>
 981       </cmdsynopsis>
 982
 983       <para>
 984         Repairs a storage volume on a node. Only LVM volume groups can
 985         be repaired at this time. They have the storage type
 986         <quote>lvm-vg</quote>.
 987       </para>
 988
 989       <para>
 990         On LVM volume groups, <command>repair-storage</command> runs
 991         <quote>vgreduce --removemissing</quote>.
 992       </para>
 993
 994       <caution>
 995         <para>
 996           Running this command can lead to data loss. Use it with care.
 997         </para>
 998       </caution>
 999
1000       <para>
1001         The <option>--ignore-consistency</option> option will ignore
1002         any inconsistent disks (on the nodes paired with this
1003         one). Use of this option is most likely to lead to data-loss.
1004       </para>
1005
1006       <para>
1007         Example:
1008         <screen>
1009 # gnt-node repair-storage node5.example.com lvm-vg xenvg
1010         </screen>
1011       </para>
1012     </refsect2>
1013
1014     <refsect2>
1015       <title>POWERCYCLE</title>
1016
1017       <cmdsynopsis>
1018         <command>powercycle</command>
1019         <arg><option>--yes</option></arg>
1020         <arg><option>--force</option></arg>
1021         <arg choice="req"><replaceable>node</replaceable></arg>
1022       </cmdsynopsis>
1023
1024       <para>
1025         This commands (tries to) forcefully reboot a node. It is a
1026         command that can be used if the node environemnt is broken,
1027         such that the admin can no longer login over ssh, but the
1028         Ganeti node daemon is still working.
1029       </para>
1030
1031       <para>
1032         Note that this command is not guaranteed to work; it depends
1033         on the hypervisor how effective is the reboot attempt. For
1034         Linux, this command require that the kernel option
1035         <literal>CONFIG_MAGIC_SYSRQ</literal> is enabled.
1036       </para>
1037
1038       <para>
1039         The <option>--yes</option> option can be used to skip
1040         confirmation, while the <option>--force</option> option is
1041         needed if the target node is the master node.
1042       </para>
1043
1044   </refsect1>
1045
1046   &footer;
1047
1048 </refentry>
1049
1050 <!-- Keep this comment at the end of the file
1051 Local variables:
1052 mode: sgml
1053 sgml-omittag:t
1054 sgml-shorttag:t
1055 sgml-minimize-attributes:nil
1056 sgml-always-quote-attributes:t
1057 sgml-indent-step:2
1058 sgml-indent-data:t
1059 sgml-parent-document:nil
1060 sgml-default-dtd-file:nil
1061 sgml-exposed-tags:nil
1062 sgml-local-catalogs:nil
1063 sgml-local-ecat-files:nil
1064 End:
1065 -->