1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4 <!-- Please adjust the date whenever revising the manpage. -->
5 <!ENTITY dhdate "<date>February 11, 2009</date>">
6 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
7 allowed: see man(7), man(1). -->
8 <!ENTITY dhsection "<manvolnum>8</manvolnum>">
9 <!ENTITY dhucpackage "<refentrytitle>gnt-instance</refentrytitle>">
10 <!ENTITY dhpackage "gnt-instance">
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">
25 <holder>Google Inc.</holder>
33 <refmiscinfo>ganeti 2.0</refmiscinfo>
36 <refname>&dhpackage;</refname>
38 <refpurpose>ganeti instance administration</refpurpose>
42 <command>&dhpackage; </command>
44 <arg choice="req">command</arg>
45 <arg>arguments...</arg>
49 <title>DESCRIPTION</title>
52 The <command>&dhpackage;</command> is used for instance
53 administration in the ganeti system.
58 <title>COMMANDS</title>
61 <title>Creation/removal/querying</title>
66 <command>add</command>
68 <arg choice="req">-t<group choice="req">
77 <arg rep="repeat">--disk=<replaceable>N</replaceable>:size=<replaceable>VAL</replaceable><arg>,mode=<replaceable>ro|rw</replaceable></arg></arg>
78 <arg>-s <replaceable>SIZE</replaceable></arg>
82 <arg rep="repeat">--net=<replaceable>N</replaceable><arg rep="repeat">:options</arg></arg>
86 <arg>-B <replaceable>BEPARAMS</replaceable></arg>
89 <arg>-H <replaceable>HYPERVISOR</replaceable><arg>:<arg choice="plain" rep="repeat">option=<replaceable>value</replaceable></arg></arg></arg>
92 <arg>--file-storage-dir <replaceable>dir_path</replaceable></arg>
93 <arg>--file-driver<group choice="req">
100 <arg>-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
101 <arg>--iallocator <replaceable>name</replaceable></arg>
105 <arg choice="req">-o <replaceable>os-type</replaceable></arg>
110 <arg choice="req"><replaceable>instance</replaceable></arg>
114 Creates a new instance on the specified host. The
115 <replaceable>instance</replaceable> argument must be in DNS,
116 but depending on the bridge setup, need not be in the same
117 network as the nodes in the cluster.
121 The <option>disk</option> option specifies the parameters
122 for the disks of the instance. The numbering of disks starts
123 at zero, and at least one disk needs to be passed. For each
124 disk, at least the size needs to be given, and optionally
125 the access mode (read-only or the default of read-write) can
126 also be specified. The size is interpreted (when no unit is
127 given) in mebibytes. You can also use one of the suffixes
128 <literal>m</literal>, <literal>g</literal> or
129 <literal>t</literal> to specificy the exact the units used;
130 these suffixes map to mebibytes, gibibytes and tebibytes.
134 Alternatively, a single-disk instance can be created via the
135 <option>-s</option> option which takes a single argument,
136 the size of the disk. This is similar to the Ganeti 1.2
137 version (but will only create one disk).
141 The minimum disk specification is therefore
142 <userinput>--disk 0:size=20G</userinput> (or <userinput>-s
143 20G</userinput> when using the <option>-s</option> option),
144 and a three-disk instance can be specified as
145 <userinput>--disk 0:size=20G --disk 1:size=4G --disk
146 2:size=100G</userinput>.
150 The NICs of the instances can be specified via the
151 <option>--nic</option> option. By default, one NIC is
152 created for the instance, with a random MAC, and connected
153 to the default bridge. Each NIC can take up to three
154 parameters (all optional):
159 <simpara>either a value or <constant>GENERATE</constant>
160 to generate a new unique MAC</simpara>
166 <simpara>specifies the IP address assigned to the
167 instance from the Ganeti side (this is not necessarily
168 what the instance will use, but what the node expects
169 the instance to use)</simpara>
175 <simpara>specifies the bridge to attach this NIC
183 Alternatively, if no network is desired for the instance, you
184 can prevent the default of one NIC with the
185 <option>--no-nics</option> option.
189 The <option>-o</option> options specifies the operating
190 system to be installed. The available operating systems can
191 be listed with <command>gnt-os list</command>.
195 The <option>-B</option> option specifies the backend
196 parameters for the instance. If no such parameters are
197 specified, the values are inherited from the cluster. Possible
203 <simpara>the memory size of the instance; as usual,
204 suffixes can be used to denote the unit, otherwise the
205 value is taken in mebibites</simpara>
211 <simpara>the number of VCPUs to assign to the instance
212 (if this value makes sense for the hypervisor)</simpara>
216 <term>auto_balance</term>
218 <simpara>whether the instance is considered in the N+1
219 cluster checks (enough redundancy in the cluster to
220 survive a node failure)</simpara>
227 The <option>-H</option> option specified the hypervisor to
228 use for the instance (must be one of the enabled hypervisors
229 on the cluster) and optionally custom parameters for this
230 instance. If not other options are used (i.e. the invocation
231 is just <userinput>-H
232 <replaceable>NAME</replaceable></userinput>) the instance
233 will inherit the cluster options. The defaults below show
234 the cluster defaults at cluster creation time.
238 The possible hypervisor options are as follows:
241 <term>boot_order</term>
243 <simpara>Valid for the Xen HVM and KVM
244 hypervisors.</simpara>
246 <simpara>A string value denoting the boot order. This
247 has different meaning for the Xen HVM hypervisor and
248 for the KVM one.</simpara>
251 For Xen HVM, The boot order is a string of letters
252 listing the boot devices, with valid device letters
290 The default is not to set an HVM boot order which is
297 <term>cdrom_image_path</term>
299 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
301 <simpara>The path to a CDROM image to attach to the
307 <term>nic_type</term>
309 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
312 This parameter determines the way the network cards
313 are presented to the instance. The possible options are:
315 <member>rtl8139 (default for Xen HVM) (HVM & KVM)</member>
316 <member>ne2k_isa (HVM & KVM)</member>
317 <member>ne2k_pci (HVM & KVM)</member>
318 <member>i82551 (KVM)</member>
319 <member>i82557b (KVM)</member>
320 <member>i82559er (KVM)</member>
321 <member>pcnet (KVM)</member>
322 <member>e1000 (KVM)</member>
323 <member>paravirtual (default for KVM) (HVM & KVM)</member>
329 <term>disk_type</term>
331 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
334 This parameter determines the way the disks are
335 presented to the instance. The possible options are:
337 <member>ioemu (default for HVM & KVM) (HVM & KVM)</member>
338 <member>ide (HVM & KVM)</member>
339 <member>scsi (KVM)</member>
340 <member>sd (KVM)</member>
341 <member>mtd (KVM)</member>
342 <member>pflash (KVM)</member>
348 <term>vnc_bind_address</term>
350 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
352 <para>Specifies the address that the VNC listener for
353 this instance should bind to. Valid values are IPv4
354 addresses. Use the address 0.0.0.0 to bind to all
355 available interfaces (this is the default) or specify
356 the address of one of the interfaces on the node to
357 restrict listening to that interface.</para>
364 <simpara>Valid for the KVM hypervisor.</simpara>
366 <simpara>A boolean option that controls whether the
367 VNC connection is secured with TLS.</simpara>
372 <term>vnc_x509_path</term>
374 <simpara>Valid for the KVM hypervisor.</simpara>
376 <para>If <option>vnc_tls</option> is enabled, this
377 options specifies the path to the x509 certificate to
383 <term>vnc_x509_verify</term>
385 <simpara>Valid for the KVM hypervisor.</simpara>
392 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
395 A boolean option that specifies if the hypervisor
396 should enable ACPI support for this instance. By
397 default, ACPI is disabled.
405 <simpara>Valid for the Xen HVM and KVM hypervisors.</simpara>
408 A boolean option that specifies if the hypervisor
409 should enabled PAE support for this instance. The
410 default is false, disabling PAE support.
416 <term>kernel_path</term>
418 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
421 This option specifies the path (on the node) to the
422 kernel to boot the instance with. Xen PVM instances
423 always require this, while for KVM if this option is
424 empty, it will cause the machine to load the kernel
431 <term>initrd_path</term>
433 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
436 This option specifies the path (on the node) to the
437 initrd to boot the instance with. Xen PVM instances
438 can use this always, while for KVM if this option is
439 only used if the <option>kernel_path</option> option
446 <term>root_path</term>
448 <simpara>Valid for the Xen PVM and KVM hypervisors.</simpara>
451 This options specifies the name of the root
452 device. This is always needed for Xen PVM, while for
453 KVM it is only used if the
454 <option>kernel_path</option> option is also
461 <term>serial_console</term>
463 <simpara>Valid for the KVM hypervisor.</simpara>
465 <simpara>This boolean option specifies whether to
466 emulate a serial console for the instance.</simpara>
476 The <option>--iallocator</option> option specifies the instance
477 allocator plugin to use. If you pass in this option the allocator
478 will select nodes for this instance automatically, so you don't need
479 to pass them with the <option>-n</option> option. For more
480 information please refer to the instance allocator documentation.
484 The <option>-t</option> options specifies the disk layout type for
485 the instance. The available choices are:
488 <term>diskless</term>
491 This creates an instance with no disks. Its useful for
492 testing only (or other special cases).
499 <para>Disk devices will be regular files.</para>
505 <para>Disk devices will be logical volumes.</para>
512 Disk devices will be drbd (version 8.x) on top of
521 The optional second value of the <option>--node</option> is used for
522 the drbd template type and specifies the remote node.
526 If you do not want gnt-instance to wait for the disk mirror
527 to be synced, use the <option>--no-wait-for-sync</option>
532 The <option>--file-storage-dir</option> specifies the relative path
533 under the cluster-wide file storage directory to store file-based
534 disks. It is useful for having different subdirectories for
535 different instances. The full path of the directory where the disk
536 files are stored will consist of cluster-wide file storage directory
537 + optional subdirectory + instance name. Example:
538 /srv/ganeti/file-storage/mysubdir/instance1.example.com. This option
539 is only relevant for instances using the file storage backend.
543 The <option>--file-driver</option> specifies the driver to use for
544 file-based disks. Note that currently these drivers work with the
545 xen hypervisor only. This option is only relevant for instances using
546 the file storage backend. The available choices are:
552 Kernel loopback driver. This driver uses loopback
553 devices to access the filesystem within the
554 file. However, running I/O intensive applications in
555 your instance using the loop driver might result in
556 slowdowns. Furthermore, if you use the loopback
557 driver consider increasing the maximum amount of
558 loopback devices (on most systems it's 8) using the
566 <para>The blktap driver (for Xen hypervisors). In
567 order to be able to use the blktap driver you should
568 check if the 'blktapctrl' user space disk agent is
569 running (usually automatically started via xend). This
570 user-level disk I/O interface has the advantage of
571 better performance. Especially if you use a network
572 file system (e.g. NFS) to store your instances this is
573 the recommended choice.
581 The <option>--submit</option> option is used to send the job to
582 the master daemon but not wait for its completion. The job
583 ID will be shown so that it can be examined via
584 <command>gnt-job info</command>.
590 # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
591 -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
592 # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
593 -n node1.example.com instance1.example.com
594 # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
595 -n node1.example.com:node2.example.com instance2.example.com
601 <title>BATCH-CREATE</title>
603 <command>batch-create</command>
604 <arg choice="req">instances_file.json</arg>
608 This command (similar to the Ganeti 1.2
609 <command>batcher</command> tool) submits multiple instance
610 creation jobs based on a definition file. The instance
611 configurations do not encompass all the possible options for
612 the <command>add</command> command, but only a subset.
616 The instance file should be a valid-formed JSON file,
617 containing a dictionary with instance name and instance
618 parameters. The accepted parameters are:
622 <term>disk_size</term>
624 <simpara>The size of the disks of the instance.</simpara>
628 <term>disk_templace</term>
630 <simpara>The disk template to use for the instance,
631 the same as in the <command>add</command>
638 <simpara>A dictionary of backend parameters.</simpara>
642 <term>hypervisor</term>
644 <simpara>A dictionary with a single key (the
645 hypervisor name), and as value the hypervisor
646 options. If not passed, the default hypervisor and
647 hypervisor options will be inherited.</simpara>
651 <term>mac, ip, bridge</term>
653 <simpara>Specifications for the one NIC that will be
654 created for the instance.</simpara>
658 <term>primary_node, secondary_node</term>
660 <simpara>The primary and optionally the secondary node
661 to use for the instance (in case an iallocator script
662 is not used).</simpara>
666 <term>iallocator</term>
668 <simpara>Instead of specifying the nodes, an
669 iallocator script can be used to automatically compute
676 <simpara>whether to start the instance</simpara>
680 <term>ip_check</term>
682 <simpara>Skip the check for already-in-use instance;
683 see the description in the <command>add</command>
684 command for details.</simpara>
688 <term>file_storage_dir, file_driver</term>
690 <simpara>Configuration for the <literal>file</literal>
691 disk type, see the <command>add</command> command for
699 A simple definition for one instance can be (with most of
700 the parameters taken from the cluster defaults):
706 "disk_size": ["25G"],
712 "disk_size": ["25G"],
713 "iallocator": "dumb",
714 "hypervisor": "xen-hvm",
715 "hvparams": {"acpi": true},
716 "backend": {"memory": 512}
723 The command will display the job id for each submitted instance, as follows:
725 # gnt-instance batch-create instances.json
734 <title>REMOVE</title>
737 <command>remove</command>
738 <arg>--ignore-failures</arg>
740 <arg choice="req"><replaceable>instance</replaceable></arg>
744 Remove an instance. This will remove all data from the
745 instance and there is <emphasis>no way back</emphasis>. If
746 you are not sure if you use an instance again, use
747 <command>shutdown</command> first and leave it in the
748 shutdown state for a while.
753 The <option>--ignore-failures</option> option will cause the
754 removal to proceed even in the presence of errors during the
755 removal of the instance (e.g. during the shutdown or the
756 disk removal). If this option is not given, the command will
757 stop at the first error.
761 The <option>--submit</option> option is used to send the job to
762 the master daemon but not wait for its completion. The job
763 ID will be shown so that it can be examined via
764 <command>gnt-job info</command>.
770 # gnt-instance remove instance1.example.com
779 <command>list</command>
780 <arg>--no-headers</arg>
781 <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
782 <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
783 <arg rep="repeat">instance</arg>
787 Shows the currently configured instances with memory usage,
788 disk usage, the node they are running on, and their run
793 The <option>--no-headers</option> option will skip the
794 initial header line. The <option>--separator</option> option
795 takes an argument which denotes what will be used between
796 the output fields. Both these options are to help scripting.
800 The <option>-o</option> option takes a comma-separated list
801 of output fields. The available fields and their meaning
807 <simpara>the instance name</simpara>
813 <simpara>the OS of the instance</simpara>
819 <simpara>the primary node of the instance</simpara>
825 <simpara>comma-separated list of secondary nodes for the
826 instance; usually this will be just one node</simpara>
830 <term>admin_state</term>
832 <simpara>the desired state of the instance (either "yes"
833 or "no" denoting the instance should run or
838 <term>disk_template</term>
840 <simpara>the disk template of the instance</simpara>
844 <term>oper_state</term>
846 <simpara>the actual state of the instance; can be
847 one of the values "running", "stopped", "(node
854 <simpara>combined form of admin_state and oper_stat;
856 <computeroutput>ERROR_nodedown</computeroutput> if the
857 node of the instance is down,
858 <computeroutput>ERROR_down</computeroutput> if the
859 instance should run but is down,
860 <computeroutput>ERROR_up</computeroutput> if the
861 instance should be stopped but is actually running,
862 <computeroutput>ADMIN_down</computeroutput> if the
863 instance has been stopped (and is stopped) and
864 <computeroutput>running</computeroutput> if the
865 instance is set to be running (and is
870 <term>oper_ram</term>
872 <simpara>the actual memory usage of the instance as seen
873 by the hypervisor</simpara>
879 <simpara>the ip address ganeti recognizes as associated with
880 the first instance interface</simpara>
886 <simpara>the first instance interface MAC address</simpara>
892 <simpara>the bridge of the first instance NIC
897 <term>sda_size</term>
899 <simpara>the size of the instance's first disk</simpara>
903 <term>sdb_size</term>
905 <simpara>the size of the instance's second disk, if
912 <simpara>the number of VCPUs allocated to the
919 <simpara>comma-separated list of the instances's
924 <term>serial_no</term>
926 <simpara>the so called 'serial number' of the
927 instance; this is a numeric field that is incremented
928 each time the instance is modified, and it can be used
929 to track modifications</simpara>
933 <term>network_port</term>
935 <simpara>If the instance has a network port assigned
936 to it (e.g. for VNC connections), this will be shown,
937 otherwise <literal>-</literal> will be
942 <term>beparams</term>
944 <simpara>A text format of the entire beparams for the
945 instance. It's more useful to select individual fields
946 from this dictionary, see below.</simpara>
950 <term>disk.count</term>
952 <simpara>The number of instance disks.</simpara>
956 <term>disk.size/N</term>
958 <simpara>The size of the instance's Nth disk. This is
959 a more generic form of the <literal>sda_size</literal>
960 and <literal>sdb_size</literal> fields.</simpara>
964 <term>disk.sizes</term>
966 <simpara>A comma-separated list of the disk sizes for
967 this instance.</simpara>
971 <term>disk_usage</term>
973 <simpara>The total disk space used by this instance on
974 each of its nodes. This is not the instance-visible
975 disk size, but the actual disk "cost" of the
980 <term>nic.mac/N</term>
982 <simpara>The MAC of the Nth instance NIC.</simpara>
986 <term>nic.ip/N</term>
988 <simpara>The IP address of the Nth instance NIC.</simpara>
992 <term>nic.bridge/N</term>
994 <simpara>The bridge the Nth instance NIC is attached
999 <term>nic.macs</term>
1001 <simpara>A comma-separated list of all the MACs of the
1002 instance's NICs.</simpara>
1006 <term>nic.ips</term>
1008 <simpara>A comma-separated list of all the IP
1009 addresses of the instance's NICs.</simpara>
1013 <term>nic.bridges</term>
1015 <simpara>A comma-separated list of all the bridges of the
1016 instance's NICs.</simpara>
1020 <term>nic.count</term>
1022 <simpara>The number of instance nics.</simpara>
1026 <term>hv/<replaceable>NAME</replaceable></term>
1028 <simpara>The value of the hypervisor parameter called
1029 <replaceable>NAME</replaceable>. For details of what
1030 hypervisor parameters exist and their meaning, see the
1031 <command>add</command> command.</simpara>
1035 <term>be/memory</term>
1037 <simpara>The configured memory for the instance.</simpara>
1041 <term>be/vcpus</term>
1043 <simpara>The configured number of VCPUs for the
1048 <term>be/auto_balance</term>
1050 <simpara>Whether the instance is considered in N+1
1058 If the value of the option starts with the character
1059 <constant>+</constant>, the new field(s) will be added to the
1060 default list. This allows to quickly see the default list
1061 plus a few other fields, instead of retyping the entire list
1066 There is a subtle grouping about the available output
1067 fields: all fields except for <option>oper_state</option>,
1068 <option>oper_ram</option> and <option>status</option> are
1069 configuration value and not run-time values. So if you don't
1070 select any of the these fields, the query will be satisfied
1071 instantly from the cluster configuration, without having to
1072 ask the remote nodes for the data. This can be helpful for
1073 big clusters when you only want some data and it makes sense
1074 to specify a reduced set of output fields.
1077 <para>The default output field list is:
1078 <simplelist type="inline">
1079 <member>name</member>
1081 <member>pnode</member>
1082 <member>admin_state</member>
1083 <member>oper_state</member>
1084 <member>oper_ram</member>
1093 <command>info</command>
1098 <arg rep="repeat"><replaceable>instance</replaceable></arg>
1102 Show detailed information about the (given) instances. This
1103 is different from <command>list</command> as it shows
1104 detailed data about the instance's disks (especially useful
1105 for drbd disk template).
1109 If the option <option>-s</option> is used, only information
1110 available in the configuration file is returned, without
1111 querying nodes, making the operation faster.
1116 <title>MODIFY</title>
1119 <command>modify</command>
1121 <arg choice="opt">-H <replaceable>HYPERVISOR_PARAMETERS</replaceable></arg>
1123 <arg choice="opt">-B <replaceable>BACKEND_PARAMETERS</replaceable></arg>
1126 <arg>--net add<replaceable><optional>:options</optional></replaceable></arg>
1127 <arg>--net remove</arg>
1128 <arg>--net <replaceable>N:options</replaceable></arg>
1132 <arg>--disk add:size=<replaceable>SIZE</replaceable></arg>
1133 <arg>--disk remove</arg>
1134 <arg>--disk <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></arg>
1140 <arg choice="req"><replaceable>instance</replaceable></arg>
1144 Modifies the memory size, number of vcpus, ip address, MAC
1145 address and/or bridge for an instance. It can also add and
1146 remove disks and NICs to/from the instance. Note that you
1147 need to give at least one of the arguments, otherwise the
1152 The <option>-H</option> option specifies hypervisor options
1153 in the form of <userinput>name=value[,...]</userinput>. For details which options can be specified, see the <command>add</command> command.
1158 add:size=<replaceable>SIZE</replaceable></option> option
1159 adds a disk to the instance. The <option>--disk
1160 remove</option> will remove the last disk of the
1161 instance. The <option>--disk
1162 <replaceable>N</replaceable>:mode=<replaceable>MODE</replaceable></option>
1163 option will change the mode of the Nth disk of the instance
1164 between read-only (<literal>ro</literal>) and read-write
1165 (<literal>rw</literal>).
1170 add:<replaceable>options</replaceable></option> option will
1171 add a new NIC to the instance. The available options are the
1172 same as in the <command>add</command> command (mac, ip,
1173 bridge). The <option>--nice remove</option> will remove the
1174 last NIC of the instance, while the <option>--nic
1175 <replaceable>N</replaceable>:<replaceable>options</replaceable></option>
1176 option will change the parameters of the Nth instance NIC.
1180 The <option>--submit</option> option is used to send the job to
1181 the master daemon but not wait for its completion. The job
1182 ID will be shown so that it can be examined via
1183 <command>gnt-job info</command>.
1187 All the changes take effect at the next restart. If the
1188 instance is running, there is no effect on the instance.
1193 <title>REINSTALL</title>
1196 <command>reinstall</command>
1197 <arg choice="opt">-o <replaceable>os-type</replaceable></arg>
1198 <arg choice="opt">-f <replaceable>force</replaceable></arg>
1199 <arg>--select-os</arg>
1201 <arg choice="req"><replaceable>instance</replaceable></arg>
1205 Reinstalls the operating system on the given instance. The instance
1206 must be stopped when running this command. If the
1207 <option>--os-type</option> is specified, the operating system is
1212 The <option>--select-os</option> option switches to an
1213 interactive OS reinstall. The user is prompted to select the OS
1214 template from the list of available OS templates.
1218 The <option>--submit</option> option is used to send the job to
1219 the master daemon but not wait for its completion. The job
1220 ID will be shown so that it can be examined via
1221 <command>gnt-job info</command>.
1228 <title>RENAME</title>
1231 <command>rename</command>
1232 <arg>--no-ip-check</arg>
1234 <arg choice="req"><replaceable>instance</replaceable></arg>
1235 <arg choice="req"><replaceable>new_name</replaceable></arg>
1239 Renames the given instance. The instance must be stopped
1240 when running this command. The requirements for the new name
1241 are the same as for adding an instance: the new name must be
1242 resolvable and the IP it resolves to must not be reachable
1243 (in order to prevent duplicate IPs the next time the
1244 instance is started). The IP test can be skipped if the
1245 <option>--no-ip-check</option> option is passed.
1249 The <option>--submit</option> option is used to send the job to
1250 the master daemon but not wait for its completion. The job
1251 ID will be shown so that it can be examined via
1252 <command>gnt-job info</command>.
1260 <title>Starting/stopping/connecting to console</title>
1263 <title>STARTUP</title>
1266 <command>startup</command>
1268 <arg>--extra=<replaceable>PARAMS</replaceable></arg>
1271 <arg>--force-multiple</arg>
1273 <group choice="opt">
1274 <arg>--instance</arg>
1276 <arg>--primary</arg>
1277 <arg>--secondary</arg>
1284 rep="repeat"><replaceable>name</replaceable></arg>
1288 Starts one or more instances, depending on the following
1289 options. The four available modes are:
1292 <term><option>--instance</option></term>
1294 <simpara>will start the instances given as arguments
1295 (at least one argument required); this is the default
1302 <simpara>will start the instances who have the given
1303 node as either primary or secondary</simpara>
1307 <term><option>--primary</option></term>
1309 <simpara>will start all instances whose primary node
1310 is in the list of nodes passed as arguments (at least
1311 one node required)</simpara>
1315 <term><option>--secondary</option></term>
1317 <simpara>will start all instances whose secondary node
1318 is in the list of nodes passed as arguments (at least
1319 one node required)</simpara>
1325 <simpara>will start all instances in the cluster (no
1326 arguments accepted)</simpara>
1333 Note that although you can pass more than one selection
1334 option, the last one wins, so in order to guarantee the
1335 desired result, don't pass more than one such option.
1339 The <option>--extra</option> option is used to pass
1340 additional argument to the instance's kernel for this start
1341 only. Currently there is no way to specify a persistent set
1342 of arguments (beside the one hardcoded). Note that this may
1343 not apply to all virtualization types.
1347 Use <option>--force</option> to start even if secondary disks are
1352 The <option>--force-multiple</option> will skip the
1353 interactive confirmation in the case the more than one
1354 instance will be affected.
1358 The <option>--submit</option> option is used to send the job to
1359 the master daemon but not wait for its completion. The job
1360 ID will be shown so that it can be examined via
1361 <command>gnt-job info</command>.
1367 # gnt-instance start instance1.example.com
1368 # gnt-instance start --extra single test1.example.com
1369 # gnt-instance start --node node1.example.com node2.example.com
1370 # gnt-instance start --all
1376 <title>SHUTDOWN</title>
1379 <command>shutdown</command>
1381 <arg>--force-multiple</arg>
1383 <group choice="opt">
1384 <arg>--instance</arg>
1386 <arg>--primary</arg>
1387 <arg>--secondary</arg>
1394 rep="repeat"><replaceable>name</replaceable></arg>
1398 Stops one or more instances. If the instance cannot be
1399 cleanly stopped during a hardcoded interval (currently 2
1400 minutes), it will forcibly stop the instance (equivalent to
1401 switching off the power on a physical machine).
1405 The <option>--instance</option>, <option>--node</option>,
1406 <option>--primary</option>, <option>--secondary</option> and
1407 <option>--all</option> options are similar as for the
1408 <command>startup</command> command and they influence the
1409 actual instances being shutdown.
1413 The <option>--submit</option> option is used to send the job to
1414 the master daemon but not wait for its completion. The job
1415 ID will be shown so that it can be examined via
1416 <command>gnt-job info</command>.
1423 # gnt-instance shutdown instance1.example.com
1424 # gnt-instance shutdown --all
1430 <title>REBOOT</title>
1433 <command>reboot</command>
1435 <arg>--extra=<replaceable>PARAMS</replaceable></arg>
1437 <arg>--type=<replaceable>REBOOT-TYPE</replaceable></arg>
1439 <arg>--ignore-secondaries</arg>
1441 <arg>--force-multiple</arg>
1443 <group choice="opt">
1444 <arg>--instance</arg>
1446 <arg>--primary</arg>
1447 <arg>--secondary</arg>
1454 rep="repeat"><replaceable>name</replaceable></arg>
1458 Reboots one or more instances. The type of reboot depends on
1459 the value of <option>--type</option>. A soft reboot does a
1460 hypervisor reboot, a hard reboot does a instance stop,
1461 recreates the hypervisor config for the instance and
1462 starts the instance. A full reboot does the equivalent
1463 of <command>gnt-instance shutdown && gnt-instance
1464 startup</command>. The default is hard reboot.
1468 For the hard reboot the option
1469 <option>--ignore-secondaries</option> ignores errors for the
1470 secondary node while re-assembling the instance disks.
1474 The <option>--instance</option>, <option>--node</option>,
1475 <option>--primary</option>, <option>--secondary</option> and
1476 <option>--all</option> options are similar as for the
1477 <command>startup</command> command and they influence the
1478 actual instances being rebooted.
1482 The <option>--force-multiple</option> will skip the
1483 interactive confirmation in the case the more than one
1484 instance will be affected.
1490 # gnt-instance reboot instance1.example.com
1491 # gnt-instance reboot --type=full instance1.example.com
1497 <title>CONSOLE</title>
1499 <command>console</command>
1500 <arg choice="opt">--show-cmd</arg>
1501 <arg choice="req"><replaceable>instance</replaceable></arg>
1505 Connects to the console of the given instance. If the
1506 instance is not up, an error is returned. Use the
1507 <option>--show-cmd</option> option to display the command
1508 instead of executing it.
1512 For HVM instances, this will attempt to connect to the
1513 serial console of the instance. To connect to the
1514 virtualized "physical" console of a HVM instance, use a VNC
1515 client with the connection info from the
1516 <command>info</command> command.
1522 # gnt-instance console instance1.example.com
1530 <title>Disk management</title>
1533 <title>REPLACE-DISKS</title>
1536 <command>replace-disks</command>
1538 <arg choice="req">-p</arg>
1539 <arg choice="req"><replaceable>instance</replaceable></arg>
1543 <command>replace-disks</command>
1545 <arg choice="req">-s</arg>
1546 <arg choice="req"><replaceable>instance</replaceable></arg>
1550 <command>replace-disks</command>
1552 <group choice="req">
1553 <arg>--iallocator <replaceable>name</replaceable></arg>
1554 <arg>--new-secondary <replaceable>NODE</replaceable></arg>
1557 <arg choice="req"><replaceable>instance</replaceable></arg>
1561 This command is a generalized form for adding and replacing
1562 disks. It is currently only valid for the mirrored (DRBD)
1567 The first form (when passing the <option>-p</option> option)
1568 will replace the disks on the primary, while the second form
1569 (when passing the <option>-s</option> option will replace
1570 the disks on the secondary node.
1574 The third form (when passing either the
1575 <option>--iallocator</option> or the
1576 <option>--new-secondary</option> option) is designed to
1577 change secondary node of the instance. Specifying
1578 <option>--iallocator</option> makes the new secondary be
1579 selected automatically by the specified allocator plugin,
1580 otherwise the new secondary node will be the one chosen
1581 manually via the <option>--new-secondary</option> option.
1585 The <option>--submit</option> option is used to send the job to
1586 the master daemon but not wait for its completion. The job
1587 ID will be shown so that it can be examined via
1588 <command>gnt-job info</command>.
1592 Note that it is not possible to select an offline or drained
1593 node as a new secondary.
1599 <title>ACTIVATE-DISKS</title>
1602 <command>activate-disks</command>
1604 <arg choice="req"><replaceable>instance</replaceable></arg>
1607 Activates the block devices of the given instance. If
1608 successful, the command will show the location and name of
1611 node1.example.com:disk/0:/dev/drbd0
1612 node1.example.com:disk/1:/dev/drbd1
1615 In this example, <emphasis>node1.example.com</emphasis> is
1616 the name of the node on which the devices have been
1617 activated. The <emphasis>disk/0</emphasis> and
1618 <emphasis>disk/1</emphasis> are the Ganeti-names of the
1619 instance disks; how they are visible inside the instance is
1620 hypervisor-specific. <emphasis>/dev/drbd0</emphasis> and
1621 <emphasis>/dev/drbd1</emphasis> are the actual block devices
1622 as visible on the node.
1626 The <option>--submit</option> option is used to send the job to
1627 the master daemon but not wait for its completion. The job
1628 ID will be shown so that it can be examined via
1629 <command>gnt-job info</command>.
1633 Note that it is safe to run this command while the instance
1639 <title>DEACTIVATE-DISKS</title>
1642 <command>deactivate-disks</command>
1644 <arg choice="req"><replaceable>instance</replaceable></arg>
1647 De-activates the block devices of the given instance. Note
1648 that if you run this command for an instance with a drbd
1649 disk template, while it is running, it will not be able to
1650 shutdown the block devices on the primary node, but it will
1651 shutdown the block devices on the secondary nodes, thus
1652 breaking the replication.
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>.
1665 <title>GROW-DISK</title>
1667 <command>grow-disk</command>
1668 <arg>--no-wait-for-sync</arg>
1670 <arg choice="req"><replaceable>instance</replaceable></arg>
1671 <arg choice="req"><replaceable>disk</replaceable></arg>
1672 <arg choice="req"><replaceable>amount</replaceable></arg>
1676 Grows an instance's disk. This is only possible for
1677 instances having a <literal>plain</literal> or
1678 <literal>drbd</literal> disk template.
1682 Note that this command only change the block device size; it
1683 will not grow the actual filesystems, partitions, etc. that
1684 live on that disk. Usually, you will need to:
1687 <simpara>use <command>gnt-instance grow-disk</command></simpara>
1690 <simpara>reboot the instance (later, at a convenient
1694 <simpara>use a filesystem resizer, such as
1695 <citerefentry> <refentrytitle>ext2online</refentrytitle>
1696 <manvolnum>8</manvolnum> </citerefentry> or
1697 <citerefentry> <refentrytitle>xfs_growfs</refentrytitle>
1698 <manvolnum>8</manvolnum> </citerefentry> to resize the
1699 filesystem, or use <citerefentry>
1700 <refentrytitle>fdisk</refentrytitle>
1701 <manvolnum>8</manvolnum> </citerefentry> to change the
1702 partition table on the disk
1710 The <replaceable>disk</replaceable> argument is the index of
1711 the instance disk to grow. The
1712 <replaceable>amount</replaceable> argument is given either
1713 as a number (and it represents the amount to increase the
1714 disk with in mebibytes) or can be given similar to the
1715 arguments in the create instance operation, with a suffix
1720 Note that the disk grow operation might complete on one node
1721 but fail on the other; this will leave the instance with
1722 different-sized LVs on the two nodes, but this will not
1723 create problems (except for unused space).
1727 If you do not want gnt-instance to wait for the new disk
1728 region to be synced, use the
1729 <option>--no-wait-for-sync</option> option.
1733 The <option>--submit</option> option is used to send the job to
1734 the master daemon but not wait for its completion. The job
1735 ID will be shown so that it can be examined via
1736 <command>gnt-job info</command>.
1740 <para>Example (increase the first disk for instance1 by 16GiB):
1742 # gnt-instance grow-disk instance1.example.com 0 16g
1747 Also note that disk shrinking is not supported; use
1748 <command>gnt-backup export</command> and then
1749 <command>gnt-backup import</command> to reduce the disk size
1757 <title>Recovery</title>
1760 <title>FAILOVER</title>
1763 <command>failover</command>
1765 <arg>--ignore-consistency</arg>
1767 <arg choice="req"><replaceable>instance</replaceable></arg>
1771 Failover will fail the instance over its secondary
1772 node. This works only for instances having a drbd disk
1777 Normally the failover will check the consistency of the
1778 disks before failing over the instance. If you are trying to
1779 migrate instances off a dead node, this will fail. Use the
1780 <option>--ignore-consistency</option> option for this
1781 purpose. Note that this option can be dangerous as errors in
1782 shutting down the instance will be ignored, resulting in
1783 possibly having the instance running on two machines in
1784 parallel (on disconnected DRBD drives).
1788 The <option>--submit</option> option is used to send the job to
1789 the master daemon but not wait for its completion. The job
1790 ID will be shown so that it can be examined via
1791 <command>gnt-job info</command>.
1797 # gnt-instance failover instance1.example.com
1803 <title>MIGRATE</title>
1806 <command>migrate</command>
1808 <arg choice="req">--cleanup</arg>
1809 <arg choice="req"><replaceable>instance</replaceable></arg>
1813 <command>migrate</command>
1815 <arg>--non-live</arg>
1816 <arg choice="req"><replaceable>instance</replaceable></arg>
1820 Migrate will move the instance to its secondary node without
1821 shutdown. It only works for instances having the drbd8 disk
1826 The migration command needs a perfectly healthy instance, as
1827 we rely on the dual-master capability of drbd8 and the disks
1828 of the instance are not allowed to be degraded.
1832 The <option>--non-live</option> option will switch (for the
1833 hypervisors that support it) between a "fully live"
1834 (i.e. the interruption is as minimal as possible) migration
1835 and one in which the instance is frozen, its state saved and
1836 transported to the remote node, and then resumed there. This
1837 all depends on the hypervisor support for two different
1838 methods. In any case, it is not an error to pass this
1839 parameter (it will just be ignored if the hypervisor doesn't
1844 If the <option>--cleanup</option> option is passed, the
1845 operation changes from migration to attempting recovery from
1846 a failed previous migration. In this mode, ganeti checks if
1847 the instance runs on the correct node (and updates its
1848 configuration if not) and ensures the instances's disks are
1849 configured correctly. In this mode, the
1850 <option>--non-live</option> option is ignored.
1854 The option <option>-f</option> will skip the prompting for
1858 Example (and expected output):
1860 # gnt-instance migrate instance1
1861 Migrate will happen to the instance instance1. Note that migration is
1862 **experimental** in this version. This might impact the instance if
1863 anything goes wrong. Continue?
1865 * checking disk consistency between source and target
1866 * ensuring the target is in secondary mode
1867 * changing disks into dual-master mode
1868 - INFO: Waiting for instance instance1 to sync disks.
1869 - INFO: Instance instance1's disks are in sync.
1870 * migrating instance to node2.example.com
1871 * changing the instance's disks on source node to secondary
1872 - INFO: Waiting for instance instance1 to sync disks.
1873 - INFO: Instance instance1's disks are in sync.
1874 * changing the instance's disks to single-master
1886 <title>ADD-TAGS</title>
1889 <command>add-tags</command>
1890 <arg choice="opt">--from <replaceable>file</replaceable></arg>
1891 <arg choice="req"><replaceable>instancename</replaceable></arg>
1893 rep="repeat"><replaceable>tag</replaceable></arg>
1897 Add tags to the given instance. If any of the tags contains
1898 invalid characters, the entire operation will abort.
1901 If the <option>--from</option> option is given, the list of
1902 tags will be extended with the contents of that file (each
1903 line becomes a tag). In this case, there is not need to pass
1904 tags on the command line (if you do, both sources will be
1905 used). A file name of - will be interpreted as stdin.
1910 <title>LIST-TAGS</title>
1913 <command>list-tags</command>
1914 <arg choice="req"><replaceable>instancename</replaceable></arg>
1917 <para>List the tags of the given instance.</para>
1921 <title>REMOVE-TAGS</title>
1923 <command>remove-tags</command>
1924 <arg choice="opt">--from <replaceable>file</replaceable></arg>
1925 <arg choice="req"><replaceable>instancename</replaceable></arg>
1927 rep="repeat"><replaceable>tag</replaceable></arg>
1931 Remove tags from the given instance. If any of the tags are
1932 not existing on the node, the entire operation will abort.
1936 If the <option>--from</option> option is given, the list of
1937 tags will be extended with the contents of that file (each
1938 line becomes a tag). In this case, there is not need to pass
1939 tags on the command line (if you do, both sources will be
1940 used). A file name of - will be interpreted as stdin.
1952 <!-- Keep this comment at the end of the file
1957 sgml-minimize-attributes:nil
1958 sgml-always-quote-attributes:t
1961 sgml-parent-document:nil
1962 sgml-default-dtd-file:nil
1963 sgml-exposed-tags:nil
1964 sgml-local-catalogs:nil
1965 sgml-local-ecat-files:nil