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 **command** [-n *node*] [-g *group*] [-M] {*command*}
35 Executes a command on all nodes. This command is designed for simple
36 usage. For more complex use cases the commands **dsh**\(1) or **cssh**\(1)
37 should be used instead.
39 If the option ``-n`` is not given, the command will be executed on all
40 nodes, otherwise it will be executed only on the node(s) specified. Use
41 the option multiple times for running it on multiple nodes, like::
43 # gnt-cluster command -n node1.example.com -n node2.example.com date
45 The ``-g`` option can be used to run a command only on a specific node
48 # gnt-cluster command -g default date
50 The ``-M`` option can be used to prepend the node name to all output
51 lines. The ``--failure-only`` option hides successful commands, making
52 it easier to see failures.
54 The command is executed serially on the selected nodes. If the
55 master node is present in the list, the command will be executed
56 last on the master. Regarding the other nodes, the execution order
57 is somewhat alphabetic, so that node2.example.com will be earlier
58 than node10.example.com but after node1.example.com.
60 So given the node names node1, node2, node3, node10, node11, with
61 node3 being the master, the order will be: node1, node2, node10,
64 The command is constructed by concatenating all other command line
65 arguments. For example, to list the contents of the /etc directory
68 # gnt-cluster command ls -l /etc
70 and the command which will be executed will be ``ls -l /etc``.
75 | **copyfile** [\--use-replication-network] [-n *node*] [-g *group*]
78 Copies a file to all or to some nodes. The argument specifies the
79 source file (on the current system), the ``-n`` argument specifies
80 the target node, or nodes if the option is given multiple times. If
81 ``-n`` is not given at all, the file will be copied to all nodes. The
82 ``-g`` option can be used to only select nodes in a specific node group.
83 Passing the ``--use-replication-network`` option will cause the
84 copy to be done over the replication network (only matters if the
85 primary/secondary IPs are different). Example::
87 # gnt-cluster -n node1.example.com -n node2.example.com copyfile /tmp/test
89 This will copy the file /tmp/test from the current node to the two
95 **deactivate-master-ip** [\--yes]
97 Deactivates the master IP on the master node.
99 This should be run only locally or on a connection to the node ip
100 directly, as a connection to the master ip will be broken by this
101 operation. Because of this risk it will require user confirmation
102 unless the ``--yes`` option is passed.
107 **destroy** {\--yes-do-it}
109 Remove all configuration files related to the cluster, so that a
110 **gnt-cluster init** can be done again afterwards.
112 Since this is a dangerous command, you are required to pass the
113 argument *\--yes-do-it.*
118 **epo** [\--on] [\--groups|\--all] [\--power-delay] *arguments*
120 Performs an emergency power-off on nodes given as arguments. If
121 ``--groups`` is given, arguments are node groups. If ``--all`` is
122 provided, the whole cluster will be shut down.
124 The ``--on`` flag recovers the cluster after an emergency power-off.
125 When powering on the cluster you can use ``--power-delay`` to define the
126 time in seconds (fractions allowed) waited between powering on
129 Please note that the master node will not be turned down or up
130 automatically. It will just be left in a state, where you can manully
131 perform the shutdown of that one node. If the master is in the list of
132 affected nodes and this is not a complete cluster emergency power-off
133 (e.g. using ``--all``), you're required to do a master failover to
134 another node not affected.
141 Displays the current master node.
148 Shows runtime cluster information: cluster name, architecture (32
149 or 64 bit), master node, node list and instance list.
151 Passing the ``--roman`` option gnt-cluster info will try to print
152 its integer fields in a latin friendly way. This allows further
153 diffusion of Ganeti among ancient cultures.
160 Shows the command line that can be used to recreate the cluster with the
161 same options relative to specs in the instance policies.
167 | [{-s|\--secondary-ip} *secondary\_ip*]
168 | [\--vg-name *vg-name*]
169 | [\--master-netdev *interface-name*]
170 | [\--master-netmask *netmask*]
171 | [\--use-external-mip-script {yes \| no}]
172 | [{-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 | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
181 | [\--maintain-node-health {yes \| no}]
182 | [\--uid-pool *user-id pool definition*]
183 | [{-I|\--default-iallocator} *default instance allocator*]
184 | [\--primary-ip-version *version*]
185 | [\--prealloc-wipe-disks {yes \| no}]
186 | [\--node-parameters *ndparams*]
187 | [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
188 | [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
189 | [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
190 | [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
191 | [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
192 | [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
193 | [\--ipolicy-std-specs *spec*=*value* [,*spec*=*value*...]]
194 | [\--ipolicy-bounds-specs *bounds_ispecs*]
195 | [\--ipolicy-disk-templates *template* [,*template*...]]
196 | [\--ipolicy-spindle-ratio *ratio*]
197 | [\--ipolicy-vcpu-ratio *ratio*]
198 | [\--disk-state *diskstate*]
199 | [\--hypervisor-state *hvstate*]
200 | [\--drbd-usermode-helper *helper*]
201 | [\--enabled-disk-templates *template* [,*template*...]]
204 This commands is only run once initially on the first node of the
205 cluster. It will initialize the cluster configuration, setup the
206 ssh-keys, start the daemons on the master node, etc. in order to have
207 a working one-node cluster.
209 Note that the *clustername* is not any random name. It has to be
210 resolvable to an IP address using DNS, and it is best if you give the
211 fully-qualified domain name. This hostname must resolve to an IP
212 address reserved exclusively for this purpose, i.e. not already in
215 The cluster can run in two modes: single-home or dual-homed. In the
216 first case, all traffic (both public traffic, inter-node traffic and
217 data replication traffic) goes over the same interface. In the
218 dual-homed case, the data replication traffic goes over the second
219 network. The ``-s (--secondary-ip)`` option here marks the cluster as
220 dual-homed and its parameter represents this node's address on the
221 second network. If you initialise the cluster with ``-s``, all nodes
222 added must have a secondary IP as well.
224 Note that for Ganeti it doesn't matter if the secondary network is
225 actually a separate physical network, or is done using tunneling,
226 etc. For performance reasons, it's recommended to use a separate
229 The ``--vg-name`` option will let you specify a volume group
230 different than "xenvg" for Ganeti to use when creating instance
231 disks. This volume group must have the same name on all nodes. Once
232 the cluster is initialized this can be altered by using the
233 **modify** command. Note that if the volume group name is modified after
234 the cluster creation and DRBD support is enabled you might have to
235 manually modify the metavg as well.
237 If you don't want to use lvm storage at all use
238 the ``--enabled-disk-template`` option to restrict the set of enabled
239 disk templates. Once the cluster is initialized
240 you can change this setup with the **modify** command.
242 The ``--master-netdev`` option is useful for specifying a different
243 interface on which the master will activate its IP address. It's
244 important that all nodes have this interface because you'll need it
245 for a master failover.
247 The ``--master-netmask`` option allows to specify a netmask for the
248 master IP. The netmask must be specified as an integer, and will be
249 interpreted as a CIDR netmask. The default value is 32 for an IPv4
250 address and 128 for an IPv6 address.
252 The ``--use-external-mip-script`` option allows to specify whether to
253 use an user-supplied master IP address setup script, whose location is
254 ``@SYSCONFDIR@/ganeti/scripts/master-ip-setup``. If the option value is
255 set to False, the default script (located at
256 ``@PKGLIBDIR@/tools/master-ip-setup``) will be executed.
258 The ``-m (--mac-prefix)`` option will let you specify a three byte
259 prefix under which the virtual MAC addresses of your instances will be
260 generated. The prefix must be specified in the format ``XX:XX:XX`` and
261 the default is ``aa:00:00``.
263 The ``--no-etc-hosts`` option allows you to initialize the cluster
264 without modifying the /etc/hosts file.
266 The ``--no-ssh-init`` option allows you to initialize the cluster
267 without creating or distributing SSH key pairs.
269 The ``--file-storage-dir`` option allows you set the directory to
270 use for storing the instance disk files when using file storage as
271 backend for instance disks.
273 The ``--prealloc-wipe-disks`` sets a cluster wide configuration value
274 for wiping disks prior to allocation and size changes (``gnt-instance
275 grow-disk``). This increases security on instance level as the instance
276 can't access untouched data from its underlying storage.
278 The ``--enabled-hypervisors`` option allows you to set the list of
279 hypervisors that will be enabled for this cluster. Instance
280 hypervisors can only be chosen from the list of enabled
281 hypervisors, and the first entry of this list will be used by
282 default. Currently, the following hypervisors are available:
294 a simple chroot manager that starts chroot based on a script at the
295 root of the filesystem holding the chroot
298 fake hypervisor for development/testing
300 Either a single hypervisor name or a comma-separated list of
301 hypervisor names can be specified. If this option is not specified,
302 only the xen-pvm hypervisor is enabled by default.
304 The ``-H (--hypervisor-parameters)`` option allows you to set default
305 hypervisor specific parameters for the cluster. The format of this
306 option is the name of the hypervisor, followed by a colon and a
307 comma-separated list of key=value pairs. The keys available for each
308 hypervisors are detailed in the **gnt-instance**\(8) man page, in the
309 **add** command plus the following parameters which are only
310 configurable globally (at cluster level):
313 Valid for the Xen PVM and KVM hypervisors.
315 This options specifies the TCP port to use for live-migration. For
316 Xen, the same port should be configured on all nodes in the
317 ``@XEN_CONFIG_DIR@/xend-config.sxp`` file, under the key
318 "xend-relocation-port".
321 Valid for the KVM hypervisor.
323 This option specifies the maximum bandwidth that KVM will use for
324 instance live migrations. The value is in MiB/s.
326 This option is only effective with kvm versions >= 78 and qemu-kvm
329 The ``-B (--backend-parameters)`` option allows you to set the default
330 backend parameters for the cluster. The parameter format is a
331 comma-separated list of key=value pairs with the following supported
335 Number of VCPUs to set for an instance by default, must be an
336 integer, will be set to 1 if no specified.
339 Maximum amount of memory to allocate for an instance by default, can
340 be either an integer or an integer followed by a unit (M for
341 mebibytes and G for gibibytes are supported), will be set to 128M if
345 Minimum amount of memory to allocate for an instance by default, can
346 be either an integer or an integer followed by a unit (M for
347 mebibytes and G for gibibytes are supported), will be set to 128M if
351 Value of the auto\_balance flag for instances to use by default,
352 will be set to true if not specified.
355 Default value for the ``always_failover`` flag for instances; if
356 not set, ``False`` is used.
359 The ``-N (--nic-parameters)`` option allows you to set the default
360 network interface parameters for the cluster. The parameter format is a
361 comma-separated list of key=value pairs with the following supported
365 The default NIC mode, one of ``routed``, ``bridged`` or
369 In ``bridged`` or ``openvswitch`` mode the default interface where
370 to attach NICs. In ``routed`` mode it represents an
371 hypervisor-vif-script dependent value to allow different instance
372 groups. For example under the KVM default network script it is
373 interpreted as a routing table number or name. Openvswitch support
374 is also hypervisor dependent and currently works for the default KVM
375 network script. Under Xen a custom network script must be provided.
377 The ``-D (--disk-parameters)`` option allows you to set the default disk
378 template parameters at cluster level. The format used for this option is
379 similar to the one use by the ``-H`` option: the disk template name
380 must be specified first, followed by a colon and by a comma-separated
381 list of key-value pairs. These parameters can only be specified at
382 cluster and node group level; the cluster-level parameter are inherited
383 by the node group at the moment of its creation, and can be further
384 modified at node group level using the **gnt-group**\(8) command.
386 The following is the list of disk parameters available for the **drbd**
387 template, with measurement units specified in square brackets at the end
388 of the description (when applicable):
391 Static re-synchronization rate. [KiB/s]
394 Number of stripes to use for data LVs.
397 Number of stripes to use for meta LVs.
400 What kind of barriers to **disable** for disks. It can either assume
401 the value "n", meaning no barrier disabled, or a non-empty string
402 containing a subset of the characters "bfd". "b" means disable disk
403 barriers, "f" means disable disk flushes, "d" disables disk drains.
406 Boolean value indicating whether the meta barriers should be
407 disabled (True) or not (False).
410 String containing the name of the default LVM volume group for DRBD
411 metadata. By default, it is set to ``xenvg``. It can be overridden
412 during the instance creation process by using the ``metavg`` key of
413 the ``--disk`` parameter.
416 String containing additional parameters to be appended to the
417 arguments list of ``drbdsetup disk``.
420 String containing additional parameters to be appended to the
421 arguments list of ``drbdsetup net``.
424 Boolean indicating whether to use the dynamic resync speed
425 controller or not. If enabled, c-plan-ahead must be non-zero and all
426 the c-* parameters will be used by DRBD. Otherwise, the value of
427 resync-rate will be used as a static resync speed.
430 Agility factor of the dynamic resync speed controller. (the higher,
431 the slower the algorithm will adapt the resync speed). A value of 0
432 (that is the default) disables the controller. [ds]
435 Maximum amount of in-flight resync data for the dynamic resync speed
436 controller. [sectors]
439 Maximum estimated peer response latency for the dynamic resync speed
443 Minimum resync speed for the dynamic resync speed controller. [KiB/s]
446 Upper bound on resync speed for the dynamic resync speed controller.
449 List of parameters available for the **plain** template:
452 Number of stripes to use for new LVs.
454 List of parameters available for the **rbd** template:
457 The RADOS cluster pool, inside which all rbd volumes will reside.
458 When a new RADOS cluster is deployed, the default pool to put rbd
459 volumes (Images in RADOS terminology) is 'rbd'.
461 The option ``--maintain-node-health`` allows one to enable/disable
462 automatic maintenance actions on nodes. Currently these include
463 automatic shutdown of instances and deactivation of DRBD devices on
464 offline nodes; in the future it might be extended to automatic
465 removal of unknown LVM volumes, etc. Note that this option is only
466 useful if the use of ``ganeti-confd`` was enabled at compilation.
468 The ``--uid-pool`` option initializes the user-id pool. The
469 *user-id pool definition* can contain a list of user-ids and/or a
470 list of user-id ranges. The parameter format is a comma-separated
471 list of numeric user-ids or user-id ranges. The ranges are defined
472 by a lower and higher boundary, separated by a dash. The boundaries
473 are inclusive. If the ``--uid-pool`` option is not supplied, the
474 user-id pool is initialized to an empty list. An empty list means
475 that the user-id pool feature is disabled.
477 The ``-I (--default-iallocator)`` option specifies the default
478 instance allocator. The instance allocator will be used for operations
479 like instance creation, instance and node migration, etc. when no
480 manual override is specified. If this option is not specified and
481 htools was not enabled at build time, the default instance allocator
482 will be blank, which means that relevant operations will require the
483 administrator to manually specify either an instance allocator, or a
484 set of nodes. If the option is not specified but htools was enabled,
485 the default iallocator will be **hail**\(1) (assuming it can be found
486 on disk). The default iallocator can be changed later using the
489 The ``--primary-ip-version`` option specifies the IP version used
490 for the primary address. Possible values are 4 and 6 for IPv4 and
491 IPv6, respectively. This option is used when resolving node names
492 and the cluster name.
494 The ``--node-parameters`` option allows you to set default node
495 parameters for the cluster. Please see **ganeti**\(7) for more
496 information about supported key=value pairs.
498 The ``-C (--candidate-pool-size)`` option specifies the
499 ``candidate_pool_size`` cluster parameter. This is the number of nodes
500 that the master will try to keep as master\_candidates. For more
501 details about this role and other node roles, see the **ganeti**\(7).
503 The ``--specs-...`` and ``--ipolicy-...`` options specify the instance
504 policy on the cluster. The ``--ipolicy-bounds-specs`` option sets the
505 minimum and maximum specifications for instances. The format is:
506 min:*param*=*value*,.../max:*param*=*value*,... and further
507 specifications pairs can be added by using ``//`` as a separator. The
508 ``--ipolicy-std-specs`` option takes a list of parameter/value pairs.
509 For both options, *param* can be:
511 - ``cpu-count``: number of VCPUs for an instance
512 - ``disk-count``: number of disk for an instance
513 - ``disk-size``: size of each disk
514 - ``memory-size``: instance memory
515 - ``nic-count``: number of network interface
516 - ``spindle-use``: spindle usage for an instance
518 For the ``--specs-...`` options, each option can have three values:
519 ``min``, ``max`` and ``std``, which can also be modified on group level
520 (except for ``std``, which is defined once for the entire cluster).
521 Please note, that ``std`` values are not the same as defaults set by
522 ``--beparams``, but they are used for the capacity calculations.
524 - ``--specs-cpu-count`` limits the number of VCPUs that can be used by an
526 - ``--specs-disk-count`` limits the number of disks
527 - ``--specs-disk-size`` limits the disk size for every disk used
528 - ``--specs-mem-size`` limits the amount of memory available
529 - ``--specs-nic-count`` sets limits on the number of NICs used
531 The ``--ipolicy-disk-templates`` and ``--ipolicy-spindle-ratio`` options
532 take a decimal number. The ``--ipolicy-disk-templates`` option takes a
533 comma-separated list of disk templates.
535 - ``--ipolicy-disk-templates`` limits the allowed disk templates
536 - ``--ipolicy-spindle-ratio`` limits the instances-spindles ratio
537 - ``--ipolicy-vcpu-ratio`` limits the vcpu-cpu ratio
539 All the instance policy elements can be overridden at group level. Group
540 level overrides can be removed by specifying ``default`` as the value of
543 The ``--drbd-usermode-helper`` option can be used to specify a usermode
544 helper. Check that this string is the one used by the DRBD kernel.
546 For details about how to use ``--hypervisor-state`` and ``--disk-state``
547 have a look at **ganeti**\(7).
549 The ``--enabled-disk-templates`` option specifies a list of disk templates
550 that can be used by instances of the cluster. For the possible values in
551 this list, see **gnt-instance**\(8). Note that in contrast to the list of
552 disk templates in the ipolicy, this list is a hard restriction. It is not
553 possible to create instances with disk templates that are not enabled in
554 the cluster. It is also not possible to disable a disk template when there
555 are still instances using it.
560 **master-failover** [\--no-voting] [\--yes-do-it]
562 Failover the master role to the current node.
564 The ``--no-voting`` option skips the remote node agreement checks.
565 This is dangerous, but necessary in some cases (for example failing
566 over the master role in a 2 node cluster with the original master
567 down). If the original master then comes up, it won't be able to
568 start its master daemon because it won't have enough votes, but so
569 won't the new master, if the master daemon ever needs a restart.
570 You can pass ``--no-voting`` to **ganeti-masterd** on the new
571 master to solve this problem, and run **gnt-cluster redist-conf**
572 to make sure the cluster is consistent again.
574 The option ``--yes-do-it`` is used together with ``--no-voting``, for
575 skipping the interactive checks. This is even more dangerous, and should
576 only be used in conjunction with other means (e.g. a HA suite) to
577 confirm that the operation is indeed safe.
584 Checks if the master daemon is alive.
586 If the master daemon is alive and can respond to a basic query (the
587 equivalent of **gnt-cluster info**), then the exit code of the
588 command will be 0. If the master daemon is not alive (either due to
589 a crash or because this is not the master node), the exit code will
595 | **modify** [\--submit]
596 | [\--vg-name *vg-name*]
597 | [\--enabled-hypervisors *hypervisors*]
598 | [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
599 | [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
600 | [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
601 | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
602 | [\--uid-pool *user-id pool definition*]
603 | [\--add-uids *user-id pool definition*]
604 | [\--remove-uids *user-id pool definition*]
605 | [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
606 | [\--maintain-node-health {yes \| no}]
607 | [\--prealloc-wipe-disks {yes \| no}]
608 | [{-I|\--default-iallocator} *default instance allocator*]
609 | [\--reserved-lvs=*NAMES*]
610 | [\--node-parameters *ndparams*]
611 | [\--master-netdev *interface-name*]
612 | [\--master-netmask *netmask*]
613 | [\--use-external-mip-script {yes \| no}]
614 | [\--hypervisor-state *hvstate*]
615 | [\--disk-state *diskstate*]
616 | [\--ipolicy-std-specs *spec*=*value* [,*spec*=*value*...]]
617 | [\--ipolicy-bounds-specs *bounds_ispecs*]
618 | [\--ipolicy-disk-templates *template* [,*template*...]]
619 | [\--ipolicy-spindle-ratio *ratio*]
620 | [\--ipolicy-vcpu-ratio *ratio*]
621 | [\--enabled-disk-templates *template* [,*template*...]]
622 | [\--drbd-usermode-helper *helper*]
625 Modify the options for the cluster.
627 The ``--vg-name``, ``--enabled-hypervisors``, ``-H (--hypervisor-parameters)``,
628 ``-B (--backend-parameters)``, ``-D (--disk-parameters)``, ``--nic-parameters``,
629 ``-C (--candidate-pool-size)``, ``--maintain-node-health``,
630 ``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``,
631 ``--master-netdev``, ``--master-netmask``, ``--use-external-mip-script``,
632 ``--drbd-usermode-helper``, and ``--enabled-disk-templates`` options are
633 described in the **init** command.
635 The ``--hypervisor-state`` and ``--disk-state`` options are described in
636 detail in **ganeti**\(7).
638 The ``--add-uids`` and ``--remove-uids`` options can be used to
639 modify the user-id pool by adding/removing a list of user-ids or
642 The option ``--reserved-lvs`` specifies a list (comma-separated) of
643 logical volume group names (regular expressions) that will be
644 ignored by the cluster verify operation. This is useful if the
645 volume group used for Ganeti is shared with the system for other
646 uses. Note that it's not recommended to create and mark as ignored
647 logical volume names which match Ganeti's own name format (starting
648 with UUID and then .diskN), as this option only skips the
649 verification, but not the actual use of the names given.
651 To remove all reserved logical volumes, pass in an empty argument
652 to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``.
654 The ``-I (--default-iallocator)`` is described in the **init**
655 command. To clear the default iallocator, just pass an empty string
658 The ``--ipolicy-...`` options are described in the **init** command.
660 See **ganeti**\(7) for a description of ``--submit`` and other common
666 **queue** {drain | undrain | info}
668 Change job queue properties.
670 The ``drain`` option sets the drain flag on the job queue. No new
671 jobs will be accepted, but jobs already in the queue will be
674 The ``undrain`` will unset the drain flag on the job queue. New
675 jobs will be accepted.
677 The ``info`` option shows the properties of the job queue.
682 **watcher** {pause *duration* | continue | info}
684 Make the watcher pause or let it continue.
686 The ``pause`` option causes the watcher to pause for *duration*
689 The ``continue`` option will let the watcher continue.
691 The ``info`` option shows whether the watcher is currently paused.
696 **redist-conf** [\--submit]
698 This command forces a full push of configuration files from the
699 master node to the other nodes in the cluster. This is normally not
700 needed, but can be run if the **verify** complains about
701 configuration mismatches.
703 See **ganeti**\(7) for a description of ``--submit`` and other common
709 **rename** [-f] {*name*}
711 Renames the cluster and in the process updates the master IP
712 address to the one the new name resolves to. At least one of either
713 the name or the IP address must be different, otherwise the
714 operation will be aborted.
716 Note that since this command can be dangerous (especially when run
717 over SSH), the command will require confirmation unless run with
723 | **renew-crypto** [-f]
724 | [\--new-cluster-certificate] [\--new-confd-hmac-key]
725 | [\--new-rapi-certificate] [\--rapi-certificate *rapi-cert*]
726 | [\--new-spice-certificate | \--spice-certificate *spice-cert*
727 | \--spice-ca-certificate *spice-ca-cert*]
728 | [\--new-cluster-domain-secret] [\--cluster-domain-secret *filename*]
730 This command will stop all Ganeti daemons in the cluster and start
731 them again once the new certificates and keys are replicated. The
732 options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
733 can be used to regenerate respectively the cluster-internal SSL
734 certificate and the HMAC key used by **ganeti-confd**\(8).
736 To generate a new self-signed RAPI certificate (used by
737 **ganeti-rapi**\(8)) specify ``--new-rapi-certificate``. If you want to
738 use your own certificate, e.g. one signed by a certificate
739 authority (CA), pass its filename to ``--rapi-certificate``.
741 To generate a new self-signed SPICE certificate, used for SPICE
742 connections to the KVM hypervisor, specify the
743 ``--new-spice-certificate`` option. If you want to provide a
744 certificate, pass its filename to ``--spice-certificate`` and pass the
745 signing CA certificate to ``--spice-ca-certificate``.
747 Finally ``--new-cluster-domain-secret`` generates a new, random
748 cluster domain secret, and ``--cluster-domain-secret`` reads the
749 secret from a file. The cluster domain secret is used to sign
750 information exchanged between separate clusters via a third party.
755 **repair-disk-sizes** [instance...]
757 This command checks that the recorded size of the given instance's
758 disks matches the actual size and updates any mismatches found.
759 This is needed if the Ganeti configuration is no longer consistent
760 with reality, as it will impact some disk operations. If no
761 arguments are given, all instances will be checked. When exclusive
762 storage is active, also spindles are updated.
764 Note that only active disks can be checked by this command; in case
765 a disk cannot be activated it's advised to use
766 **gnt-instance activate-disks \--ignore-size ...** to force
767 activation without regard to the current size.
769 When all the disk sizes are consistent, the command will return no
770 output. Otherwise it will log details about the inconsistencies in
776 | **verify** [\--no-nplus1-mem] [\--node-group *nodegroup*]
777 | [\--error-codes] [{-I|\--ignore-errors} *errorcode*]
778 | [{-I|\--ignore-errors} *errorcode*...]
780 Verify correctness of cluster configuration. This is safe with
781 respect to running instances, and incurs no downtime of the
784 If the ``--no-nplus1-mem`` option is given, Ganeti won't check
785 whether if it loses a node it can restart all the instances on
786 their secondaries (and report an error otherwise).
788 With ``--node-group``, restrict the verification to those nodes and
789 instances that live in the named group. This will not verify global
790 settings, but will allow to perform verification of a group while other
791 operations are ongoing in other groups.
793 The ``--error-codes`` option outputs each error in the following
794 parseable format: *ftype*:*ecode*:*edomain*:*name*:*msg*.
795 These fields have the following meaning:
798 Failure type. Can be *WARNING* or *ERROR*.
801 Error code of the failure. See below for a list of error codes.
804 Can be *cluster*, *node* or *instance*.
807 Contains the name of the item that is affected from the failure.
810 Contains a descriptive error message about the error
812 ``gnt-cluster verify`` will have a non-zero exit code if at least one of
813 the failures that are found are of type *ERROR*.
815 The ``--ignore-errors`` option can be used to change this behaviour,
816 because it demotes the error represented by the error code received as a
817 parameter to a warning. The option must be repeated for each error that
818 should be ignored (e.g.: ``-I ENODEVERSION -I ENODEORPHANLV``). The
819 ``--error-codes`` option can be used to determine the error code of a
831 The command checks which instances have degraded DRBD disks and
832 activates the disks of those instances.
834 This command is run from the **ganeti-watcher** tool, which also
835 has a different, complementary algorithm for doing this check.
836 Together, these two should ensure that DRBD disks are kept
844 Show the cluster version.
852 **add-tags** [\--from *file*] {*tag*...}
854 Add tags to the cluster. If any of the tags contains invalid
855 characters, the entire operation will abort.
857 If the ``--from`` option is given, the list of tags will be
858 extended with the contents of that file (each line becomes a tag).
859 In this case, there is not need to pass tags on the command line
860 (if you do, both sources will be used). A file name of - will be
861 interpreted as stdin.
868 List the tags of the cluster.
873 **remove-tags** [\--from *file*] {*tag*...}
875 Remove tags from the cluster. If any of the tags are not existing
876 on the cluster, the entire operation will abort.
878 If the ``--from`` option is given, the list of tags to be removed will
879 be extended with the contents of that file (each line becomes a tag).
880 In this case, there is not need to pass tags on the command line (if
881 you do, tags from both sources will be removed). A file name of - will
882 be interpreted as stdin.
887 **search-tags** {*pattern*}
889 Searches the tags on all objects in the cluster (the cluster
890 itself, the nodes and the instances) for a given pattern. The
891 pattern is interpreted as a regular expression and a search will be
892 done on it (i.e. the given pattern is not anchored to the beggining
893 of the string; if you want that, prefix the pattern with ^).
895 If no tags are matching the pattern, the exit code of the command
896 will be one. If there is at least one match, the exit code will be
897 zero. Each match is listed on one line, the object and the tag
898 separated by a space. The cluster will be listed as /cluster, a
899 node will be listed as /nodes/*name*, and an instance as
900 /instances/*name*. Example:
904 # gnt-cluster search-tags time
905 /cluster ctime:2007-09-01
906 /nodes/node1.example.com mtime:2007-10-04
908 .. vim: set textwidth=72 :