1 gnt-cluster(8) Ganeti | Version @GANETI_VERSION@
2 ================================================
7 gnt-cluster - Ganeti administration, cluster-wide
12 **gnt-cluster** {command} [arguments...]
17 The **gnt-cluster** is used for cluster-wide administration in the
26 **activate-master-ip**
28 Activates the master IP on the master node.
33 **add-tags** [--from *file*] {*tag*...}
35 Add tags to the cluster. If any of the tags contains invalid
36 characters, the entire operation will abort.
38 If the ``--from`` option is given, the list of tags will be
39 extended with the contents of that file (each line becomes a tag).
40 In this case, there is not need to pass tags on the command line
41 (if you do, both sources will be used). A file name of - will be
47 **command** [-n *node*] [-g *group*] {*command*}
49 Executes a command on all nodes. If the option ``-n`` is not given,
50 the command will be executed on all nodes, otherwise it will be
51 executed only on the node(s) specified. Use the option multiple
52 times for running it on multiple nodes, like::
54 # gnt-cluster command -n node1.example.com -n node2.example.com date
56 The ``-g`` option can be used to run a command only on a specific node
59 # gnt-cluster command -g default date
61 The command is executed serially on the selected nodes. If the
62 master node is present in the list, the command will be executed
63 last on the master. Regarding the other nodes, the execution order
64 is somewhat alphabetic, so that node2.example.com will be earlier
65 than node10.example.com but after node1.example.com.
67 So given the node names node1, node2, node3, node10, node11, with
68 node3 being the master, the order will be: node1, node2, node10,
71 The command is constructed by concatenating all other command line
72 arguments. For example, to list the contents of the /etc directory
75 # gnt-cluster command ls -l /etc
77 and the command which will be executed will be ``ls -l /etc``.
82 | **copyfile** [--use-replication-network] [-n *node*] [-g *group*]
85 Copies a file to all or to some nodes. The argument specifies the
86 source file (on the current system), the ``-n`` argument specifies
87 the target node, or nodes if the option is given multiple times. If
88 ``-n`` is not given at all, the file will be copied to all nodes. The
89 ``-g`` option can be used to only select nodes in a specific node group.
90 Passing the ``--use-replication-network`` option will cause the
91 copy to be done over the replication network (only matters if the
92 primary/secondary IPs are different). Example::
94 # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test
96 This will copy the file /tmp/test from the current node to the two
102 **deactivate-master-ip** [--yes]
104 Deactivates the master IP on the master node.
106 This should be run only locally or on a connection to the node ip
107 directly, as a connection to the master ip will be broken by this
108 operation. Because of this risk it will require user confirmation
109 unless the ``--yes`` option is passed.
114 **destroy** {--yes-do-it}
116 Remove all configuration files related to the cluster, so that a
117 **gnt-cluster init** can be done again afterwards.
119 Since this is a dangerous command, you are required to pass the
120 argument *--yes-do-it.*
125 **epo** [--on] [--groups|--all] [--power-delay] *arguments*
127 Performs an emergency power-off on nodes given as arguments. If
128 ``--groups`` is given, arguments are node groups. If ``--all`` is
129 provided, the whole cluster will be shut down.
131 The ``--on`` flag recovers the cluster after an emergency power-off.
132 When powering on the cluster you can use ``--power-delay`` to define the
133 time in seconds (fractions allowed) waited between powering on
136 Please note that the master node will not be turned down or up
137 automatically. It will just be left in a state, where you can manully
138 perform the shutdown of that one node. If the master is in the list of
139 affected nodes and this is not a complete cluster emergency power-off
140 (e.g. using ``--all``), you're required to do a master failover to
141 another node not affected.
148 Displays the current master node.
155 Shows runtime cluster information: cluster name, architecture (32
156 or 64 bit), master node, node list and instance list.
158 Passing the ``--roman`` option gnt-cluster info will try to print
159 its integer fields in a latin friendly way. This allows further
160 diffusion of Ganeti among ancient cultures.
166 | [{-s|--secondary-ip} *secondary\_ip*]
167 | [--vg-name *vg-name*]
168 | [--master-netdev *interface-name*]
169 | [--master-netmask *netmask*]
170 | [--use-external-mip-script {yes \| no}]
171 | [{-m|--mac-prefix} *mac-prefix*]
175 | [--file-storage-dir *dir*]
176 | [--enabled-hypervisors *hypervisors*]
177 | [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
178 | [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
179 | [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
180 | [--maintain-node-health {yes \| no}]
181 | [--uid-pool *user-id pool definition*]
182 | [{-I|--default-iallocator} *default instance allocator*]
183 | [--primary-ip-version *version*]
184 | [--prealloc-wipe-disks {yes \| no}]
185 | [--node-parameters *ndparams*]
186 | [{-C|--candidate-pool-size} *candidate\_pool\_size*]
189 This commands is only run once initially on the first node of the
190 cluster. It will initialize the cluster configuration, setup the
191 ssh-keys, start the daemons on the master node, etc. in order to have
192 a working one-node cluster.
194 Note that the *clustername* is not any random name. It has to be
195 resolvable to an IP address using DNS, and it is best if you give the
196 fully-qualified domain name. This hostname must resolve to an IP
197 address reserved exclusively for this purpose, i.e. not already in
200 The cluster can run in two modes: single-home or dual-homed. In the
201 first case, all traffic (both public traffic, inter-node traffic and
202 data replication traffic) goes over the same interface. In the
203 dual-homed case, the data replication traffic goes over the second
204 network. The ``-s (--secondary-ip)`` option here marks the cluster as
205 dual-homed and its parameter represents this node's address on the
206 second network. If you initialise the cluster with ``-s``, all nodes
207 added must have a secondary IP as well.
209 Note that for Ganeti it doesn't matter if the secondary network is
210 actually a separate physical network, or is done using tunneling,
211 etc. For performance reasons, it's recommended to use a separate
214 The ``--vg-name`` option will let you specify a volume group
215 different than "xenvg" for Ganeti to use when creating instance
216 disks. This volume group must have the same name on all nodes. Once
217 the cluster is initialized this can be altered by using the
218 **modify** command. If you don't want to use lvm storage at all use
219 the ``--no-lvm-storage`` option. Once the cluster is initialized
220 you can change this setup with the **modify** command.
222 The ``--master-netdev`` option is useful for specifying a different
223 interface on which the master will activate its IP address. It's
224 important that all nodes have this interface because you'll need it
225 for a master failover.
227 The ``--master-netmask`` option allows to specify a netmask for the
228 master IP. The netmask must be specified as an integer, and will be
229 interpreted as a CIDR netmask. The default value is 32 for an IPv4
230 address and 128 for an IPv6 address.
232 The ``--use-external-mip-script`` options allows to specify
233 whether to use an user-supplied master IP address setup script, whose
234 location is ``/etc/ganeti/scripts/master-ip-setup``. If the option value
235 is set to False, the default script, whose location is
236 ``/usr/local/lib/ganeti/tools/master-ip-setup``, will be executed.
238 The ``-m (--mac-prefix)`` option will let you specify a three byte
239 prefix under which the virtual MAC addresses of your instances will be
240 generated. The prefix must be specified in the format ``XX:XX:XX`` and
241 the default is ``aa:00:00``.
243 The ``--no-lvm-storage`` option allows you to initialize the
244 cluster without lvm support. This means that only instances using
245 files as storage backend will be possible to create. Once the
246 cluster is initialized you can change this setup with the
249 The ``--no-etc-hosts`` option allows you to initialize the cluster
250 without modifying the /etc/hosts file.
252 The ``--no-ssh-init`` option allows you to initialize the cluster
253 without creating or distributing SSH key pairs.
255 The ``--file-storage-dir`` option allows you set the directory to
256 use for storing the instance disk files when using file storage as
257 backend for instance disks.
259 The ``--prealloc-wipe-disks`` sets a cluster wide configuration
260 value for wiping disks prior to allocation. This increases security
261 on instance level as the instance can't access untouched data from
262 it's underlying storage.
264 The ``--enabled-hypervisors`` option allows you to set the list of
265 hypervisors that will be enabled for this cluster. Instance
266 hypervisors can only be chosen from the list of enabled
267 hypervisors, and the first entry of this list will be used by
268 default. Currently, the following hypervisors are available:
280 a simple chroot manager that starts chroot based on a script at the
281 root of the filesystem holding the chroot
284 fake hypervisor for development/testing
286 Either a single hypervisor name or a comma-separated list of
287 hypervisor names can be specified. If this option is not specified,
288 only the xen-pvm hypervisor is enabled by default.
290 The ``-H (--hypervisor-parameters)`` option allows you to set default
291 hypervisor specific parameters for the cluster. The format of this
292 option is the name of the hypervisor, followed by a colon and a
293 comma-separated list of key=value pairs. The keys available for each
294 hypervisors are detailed in the gnt-instance(8) man page, in the
295 **add** command plus the following parameters which are only
296 configurable globally (at cluster level):
299 Valid for the Xen PVM and KVM hypervisors.
301 This options specifies the TCP port to use for live-migration. For
302 Xen, the same port should be configured on all nodes in the
303 ``/etc/xen/xend-config.sxp`` file, under the key
304 "xend-relocation-port".
307 Valid for the KVM hypervisor.
309 This option specifies the maximum bandwidth that KVM will use for
310 instance live migrations. The value is in MiB/s.
312 This option is only effective with kvm versions >= 78 and qemu-kvm
315 The ``-B (--backend-parameters)`` option allows you to set the default
316 backend parameters for the cluster. The parameter format is a
317 comma-separated list of key=value pairs with the following supported
321 Number of VCPUs to set for an instance by default, must be an
322 integer, will be set to 1 if no specified.
325 Maximum amount of memory to allocate for an instance by default, can
326 be either an integer or an integer followed by a unit (M for
327 mebibytes and G for gibibytes are supported), will be set to 128M if
331 Minimum amount of memory to allocate for an instance by default, can
332 be either an integer or an integer followed by a unit (M for
333 mebibytes and G for gibibytes are supported), will be set to 128M if
337 Value of the auto\_balance flag for instances to use by default,
338 will be set to true if not specified.
341 Default value for the ``always\_failover`` flag for instances; if
342 not set, ``False`` is used.
345 The ``-N (--nic-parameters)`` option allows you to set the default nic
346 parameters for the cluster. The parameter format is a comma-separated
347 list of key=value pairs with the following supported keys:
350 The default nic mode, 'routed' or 'bridged'.
353 In bridged mode the default NIC bridge. In routed mode it
354 represents an hypervisor-vif-script dependent value to allow
355 different instance groups. For example under the KVM default
356 network script it is interpreted as a routing table number or
359 The option ``--maintain-node-health`` allows one to enable/disable
360 automatic maintenance actions on nodes. Currently these include
361 automatic shutdown of instances and deactivation of DRBD devices on
362 offline nodes; in the future it might be extended to automatic
363 removal of unknown LVM volumes, etc. Note that this option is only
364 useful if the use of ``ganeti-confd`` was enabled at compilation.
366 The ``--uid-pool`` option initializes the user-id pool. The
367 *user-id pool definition* can contain a list of user-ids and/or a
368 list of user-id ranges. The parameter format is a comma-separated
369 list of numeric user-ids or user-id ranges. The ranges are defined
370 by a lower and higher boundary, separated by a dash. The boundaries
371 are inclusive. If the ``--uid-pool`` option is not supplied, the
372 user-id pool is initialized to an empty list. An empty list means
373 that the user-id pool feature is disabled.
375 The ``-I (--default-iallocator)`` option specifies the default
376 instance allocator. The instance allocator will be used for operations
377 like instance creation, instance and node migration, etc. when no
378 manual override is specified. If this option is not specified and
379 htools was not enabled at build time, the default instance allocator
380 will be blank, which means that relevant operations will require the
381 administrator to manually specify either an instance allocator, or a
382 set of nodes. If the option is not specified but htools was enabled,
383 the default iallocator will be **hail**(1) (assuming it can be found
384 on disk). The default iallocator can be changed later using the
387 The ``--primary-ip-version`` option specifies the IP version used
388 for the primary address. Possible values are 4 and 6 for IPv4 and
389 IPv6, respectively. This option is used when resolving node names
390 and the cluster name.
392 The ``--node-parameters`` option allows you to set default node
393 parameters for the cluster. Please see **ganeti**(7) for more
394 information about supported key=value pairs.
396 The ``-C (--candidate-pool-size)`` option specifies the
397 ``candidate_pool_size`` cluster parameter. This is the number of nodes
398 that the master will try to keep as master\_candidates. For more
399 details about this role and other node roles, see the ganeti(7).
406 List the tags of the cluster.
411 **master-failover** [--no-voting]
413 Failover the master role to the current node.
415 The ``--no-voting`` option skips the remote node agreement checks.
416 This is dangerous, but necessary in some cases (for example failing
417 over the master role in a 2 node cluster with the original master
418 down). If the original master then comes up, it won't be able to
419 start its master daemon because it won't have enough votes, but so
420 won't the new master, if the master daemon ever needs a restart.
421 You can pass ``--no-voting`` to **ganeti-masterd** on the new
422 master to solve this problem, and run **gnt-cluster redist-conf**
423 to make sure the cluster is consistent again.
430 Checks if the master daemon is alive.
432 If the master daemon is alive and can respond to a basic query (the
433 equivalent of **gnt-cluster info**), then the exit code of the
434 command will be 0. If the master daemon is not alive (either due to
435 a crash or because this is not the master node), the exit code will
442 | [--vg-name *vg-name*]
444 | [--enabled-hypervisors *hypervisors*]
445 | [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
446 | [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
447 | [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
448 | [--uid-pool *user-id pool definition*]
449 | [--add-uids *user-id pool definition*]
450 | [--remove-uids *user-id pool definition*]
451 | [{-C|--candidate-pool-size} *candidate\_pool\_size*]
452 | [--maintain-node-health {yes \| no}]
453 | [--prealloc-wipe-disks {yes \| no}]
454 | [{-I|--default-iallocator} *default instance allocator*]
455 | [--reserved-lvs=*NAMES*]
456 | [--node-parameters *ndparams*]
457 | [--master-netdev *interface-name*]
458 | [--master-netmask *netmask*]
459 | [--use-external-mip-script {yes \| no}]
460 | [--hypervisor-state *hvstate*]
461 | [--disk-state *diskstate*]
463 Modify the options for the cluster.
465 The ``--vg-name``, ``--no-lvm-storarge``, ``--enabled-hypervisors``,
466 ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``,
467 ``--nic-parameters``, ``-C (--candidate-pool-size)``,
468 ``--maintain-node-health``, ``--prealloc-wipe-disks``, ``--uid-pool``,
469 ``--node-parameters``, ``--master-netdev``, ``--master-netmask`` and
470 ``--use-external-mip-script`` options are described in the
473 The ``--hypervisor-state`` and ``--disk-state`` options are described in
474 detail in **ganeti**(7).
476 The ``--add-uids`` and ``--remove-uids`` options can be used to
477 modify the user-id pool by adding/removing a list of user-ids or
480 The option ``--reserved-lvs`` specifies a list (comma-separated) of
481 logical volume group names (regular expressions) that will be
482 ignored by the cluster verify operation. This is useful if the
483 volume group used for Ganeti is shared with the system for other
484 uses. Note that it's not recommended to create and mark as ignored
485 logical volume names which match Ganeti's own name format (starting
486 with UUID and then .diskN), as this option only skips the
487 verification, but not the actual use of the names given.
489 To remove all reserved logical volumes, pass in an empty argument
490 to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``.
492 The ``-I (--default-iallocator)`` is described in the **init**
493 command. To clear the default iallocator, just pass an empty string
499 **queue** {drain | undrain | info}
501 Change job queue properties.
503 The ``drain`` option sets the drain flag on the job queue. No new
504 jobs will be accepted, but jobs already in the queue will be
507 The ``undrain`` will unset the drain flag on the job queue. New
508 jobs will be accepted.
510 The ``info`` option shows the properties of the job queue.
515 **watcher** {pause *duration* | continue | info}
517 Make the watcher pause or let it continue.
519 The ``pause`` option causes the watcher to pause for *duration*
522 The ``continue`` option will let the watcher continue.
524 The ``info`` option shows whether the watcher is currently paused.
529 **redist-conf** [--submit]
531 This command forces a full push of configuration files from the
532 master node to the other nodes in the cluster. This is normally not
533 needed, but can be run if the **verify** complains about
534 configuration mismatches.
536 The ``--submit`` option is used to send the job to the master
537 daemon but not wait for its completion. The job ID will be shown so
538 that it can be examined via **gnt-job info**.
543 **remove-tags** [--from *file*] {*tag*...}
545 Remove tags from the cluster. If any of the tags are not existing
546 on the cluster, the entire operation will abort.
548 If the ``--from`` option is given, the list of tags to be removed will
549 be extended with the contents of that file (each line becomes a tag).
550 In this case, there is not need to pass tags on the command line (if
551 you do, tags from both sources will be removed). A file name of - will
552 be interpreted as stdin.
557 **rename** [-f] {*name*}
559 Renames the cluster and in the process updates the master IP
560 address to the one the new name resolves to. At least one of either
561 the name or the IP address must be different, otherwise the
562 operation will be aborted.
564 Note that since this command can be dangerous (especially when run
565 over SSH), the command will require confirmation unless run with
571 | **renew-crypto** [-f]
572 | [--new-cluster-certificate] [--new-confd-hmac-key]
573 | [--new-rapi-certificate] [--rapi-certificate *rapi-cert*]
574 | [--new-spice-certificate | --spice-certificate *spice-cert*
575 | -- spice-ca-certificate *spice-ca-cert*]
576 | [--new-cluster-domain-secret] [--cluster-domain-secret *filename*]
578 This command will stop all Ganeti daemons in the cluster and start
579 them again once the new certificates and keys are replicated. The
580 options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
581 can be used to regenerate the cluster-internal SSL certificate
582 respective the HMAC key used by ganeti-confd(8).
584 To generate a new self-signed RAPI certificate (used by
585 ganeti-rapi(8)) specify ``--new-rapi-certificate``. If you want to
586 use your own certificate, e.g. one signed by a certificate
587 authority (CA), pass its filename to ``--rapi-certificate``.
589 To generate a new self-signed SPICE certificate, used by SPICE
590 connections to the KVM hypervisor, specify the
591 ``--new-spice-certificate`` option. If you want to provide a
592 certificate, pass its filename to ``--spice-certificate`` and pass the
593 signing CA certificate to ``--spice-ca-certificate``.
595 ``--new-cluster-domain-secret`` generates a new, random cluster
596 domain secret. ``--cluster-domain-secret`` reads the secret from a
597 file. The cluster domain secret is used to sign information
598 exchanged between separate clusters via a third party.
603 **repair-disk-sizes** [instance...]
605 This command checks that the recorded size of the given instance's
606 disks matches the actual size and updates any mismatches found.
607 This is needed if the Ganeti configuration is no longer consistent
608 with reality, as it will impact some disk operations. If no
609 arguments are given, all instances will be checked.
611 Note that only active disks can be checked by this command; in case
612 a disk cannot be activated it's advised to use
613 **gnt-instance activate-disks --ignore-size ...** to force
614 activation without regard to the current size.
616 When the all disk sizes are consistent, the command will return no
617 output. Otherwise it will log details about the inconsistencies in
623 **search-tags** {*pattern*}
625 Searches the tags on all objects in the cluster (the cluster
626 itself, the nodes and the instances) for a given pattern. The
627 pattern is interpreted as a regular expression and a search will be
628 done on it (i.e. the given pattern is not anchored to the beggining
629 of the string; if you want that, prefix the pattern with ^).
631 If no tags are matching the pattern, the exit code of the command
632 will be one. If there is at least one match, the exit code will be
633 zero. Each match is listed on one line, the object and the tag
634 separated by a space. The cluster will be listed as /cluster, a
635 node will be listed as /nodes/*name*, and an instance as
636 /instances/*name*. Example:
640 # gnt-cluster search-tags time
641 /cluster ctime:2007-09-01
642 /nodes/node1.example.com mtime:2007-10-04
647 | **verify** [--no-nplus1-mem] [--node-group *nodegroup*]
648 | [--error-codes] [{-I|--ignore-errors} *errorcode*]
649 | [{-I|--ignore-errors} *errorcode*...]
651 Verify correctness of cluster configuration. This is safe with
652 respect to running instances, and incurs no downtime of the
655 If the ``--no-nplus1-mem`` option is given, Ganeti won't check
656 whether if it loses a node it can restart all the instances on
657 their secondaries (and report an error otherwise).
659 With ``--node-group``, restrict the verification to those nodes and
660 instances that live in the named group. This will not verify global
661 settings, but will allow to perform verification of a group while other
662 operations are ongoing in other groups.
664 The ``--error-codes`` option outputs each error in the following
665 parseable format: *ftype*:*ecode*:*edomain*:*name*:*msg*.
666 These fields have the following meaning:
669 Failure type. Can be *WARNING* or *ERROR*.
672 Error code of the failure. See below for a list of error codes.
675 Can be *cluster*, *node* or *instance*.
678 Contains the name of the item that is affected from the failure.
681 Contains a descriptive error message about the error
683 ``gnt-cluster verify`` will have a non-zero exit code if at least one of
684 the failures that are found are of type *ERROR*.
686 The ``--ignore-errors`` option can be used to change this behaviour,
687 because it demotes the error represented by the error code received as a
688 parameter to a warning. The option must be repeated for each error that
689 should be ignored (e.g.: ``-I ENODEVERSION -I ENODEORPHANLV``). The
690 ``--error-codes`` option can be used to determine the error code of a
702 The command checks which instances have degraded DRBD disks and
703 activates the disks of those instances.
705 This command is run from the **ganeti-watcher** tool, which also
706 has a different, complementary algorithm for doing this check.
707 Together, these two should ensure that DRBD disks are kept
715 Show the cluster version.
717 .. vim: set textwidth=72 :