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.
159 | [{-s|\--secondary-ip} *secondary\_ip*]
160 | [\--vg-name *vg-name*]
161 | [\--master-netdev *interface-name*]
162 | [\--master-netmask *netmask*]
163 | [\--use-external-mip-script {yes \| no}]
164 | [{-m|\--mac-prefix} *mac-prefix*]
167 | [\--file-storage-dir *dir*]
168 | [\--enabled-hypervisors *hypervisors*]
169 | [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
170 | [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
171 | [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
172 | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
173 | [\--maintain-node-health {yes \| no}]
174 | [\--uid-pool *user-id pool definition*]
175 | [{-I|\--default-iallocator} *default instance allocator*]
176 | [\--primary-ip-version *version*]
177 | [\--prealloc-wipe-disks {yes \| no}]
178 | [\--node-parameters *ndparams*]
179 | [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
180 | [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
181 | [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
182 | [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
183 | [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
184 | [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
185 | [\--ipolicy-disk-templates *template* [,*template*...]]
186 | [\--disk-state *diskstate*]
187 | [\--hypervisor-state *hvstate*]
188 | [\--drbd-usermode-helper *helper*]
189 | [\--enabled-disk-templates *template* [,*template*...]]
192 This commands is only run once initially on the first node of the
193 cluster. It will initialize the cluster configuration, setup the
194 ssh-keys, start the daemons on the master node, etc. in order to have
195 a working one-node cluster.
197 Note that the *clustername* is not any random name. It has to be
198 resolvable to an IP address using DNS, and it is best if you give the
199 fully-qualified domain name. This hostname must resolve to an IP
200 address reserved exclusively for this purpose, i.e. not already in
203 The cluster can run in two modes: single-home or dual-homed. In the
204 first case, all traffic (both public traffic, inter-node traffic and
205 data replication traffic) goes over the same interface. In the
206 dual-homed case, the data replication traffic goes over the second
207 network. The ``-s (--secondary-ip)`` option here marks the cluster as
208 dual-homed and its parameter represents this node's address on the
209 second network. If you initialise the cluster with ``-s``, all nodes
210 added must have a secondary IP as well.
212 Note that for Ganeti it doesn't matter if the secondary network is
213 actually a separate physical network, or is done using tunneling,
214 etc. For performance reasons, it's recommended to use a separate
217 The ``--vg-name`` option will let you specify a volume group
218 different than "xenvg" for Ganeti to use when creating instance
219 disks. This volume group must have the same name on all nodes. Once
220 the cluster is initialized this can be altered by using the
221 **modify** command. If you don't want to use lvm storage at all use
222 the ``--enabled-disk-template`` option to restrict the set of enabled
223 disk templates. Once the cluster is initialized
224 you can change this setup with the **modify** command.
226 The ``--master-netdev`` option is useful for specifying a different
227 interface on which the master will activate its IP address. It's
228 important that all nodes have this interface because you'll need it
229 for a master failover.
231 The ``--master-netmask`` option allows to specify a netmask for the
232 master IP. The netmask must be specified as an integer, and will be
233 interpreted as a CIDR netmask. The default value is 32 for an IPv4
234 address and 128 for an IPv6 address.
236 The ``--use-external-mip-script`` option allows to specify whether to
237 use an user-supplied master IP address setup script, whose location is
238 ``@SYSCONFDIR@/ganeti/scripts/master-ip-setup``. If the option value is
239 set to False, the default script (located at
240 ``@PKGLIBDIR@/tools/master-ip-setup``) will be executed.
242 The ``-m (--mac-prefix)`` option will let you specify a three byte
243 prefix under which the virtual MAC addresses of your instances will be
244 generated. The prefix must be specified in the format ``XX:XX:XX`` and
245 the default is ``aa:00:00``.
247 The ``--no-etc-hosts`` option allows you to initialize the cluster
248 without modifying the /etc/hosts file.
250 The ``--no-ssh-init`` option allows you to initialize the cluster
251 without creating or distributing SSH key pairs.
253 The ``--file-storage-dir`` option allows you set the directory to
254 use for storing the instance disk files when using file storage as
255 backend for instance disks.
257 The ``--prealloc-wipe-disks`` sets a cluster wide configuration value
258 for wiping disks prior to allocation and size changes (``gnt-instance
259 grow-disk``). This increases security on instance level as the instance
260 can't access untouched data from its underlying storage.
262 The ``--enabled-hypervisors`` option allows you to set the list of
263 hypervisors that will be enabled for this cluster. Instance
264 hypervisors can only be chosen from the list of enabled
265 hypervisors, and the first entry of this list will be used by
266 default. Currently, the following hypervisors are available:
278 a simple chroot manager that starts chroot based on a script at the
279 root of the filesystem holding the chroot
282 fake hypervisor for development/testing
284 Either a single hypervisor name or a comma-separated list of
285 hypervisor names can be specified. If this option is not specified,
286 only the xen-pvm hypervisor is enabled by default.
288 The ``-H (--hypervisor-parameters)`` option allows you to set default
289 hypervisor specific parameters for the cluster. The format of this
290 option is the name of the hypervisor, followed by a colon and a
291 comma-separated list of key=value pairs. The keys available for each
292 hypervisors are detailed in the **gnt-instance**\(8) man page, in the
293 **add** command plus the following parameters which are only
294 configurable globally (at cluster level):
297 Valid for the Xen PVM and KVM hypervisors.
299 This options specifies the TCP port to use for live-migration. For
300 Xen, the same port should be configured on all nodes in the
301 ``@XEN_CONFIG_DIR@/xend-config.sxp`` file, under the key
302 "xend-relocation-port".
305 Valid for the KVM hypervisor.
307 This option specifies the maximum bandwidth that KVM will use for
308 instance live migrations. The value is in MiB/s.
310 This option is only effective with kvm versions >= 78 and qemu-kvm
313 The ``-B (--backend-parameters)`` option allows you to set the default
314 backend parameters for the cluster. The parameter format is a
315 comma-separated list of key=value pairs with the following supported
319 Number of VCPUs to set for an instance by default, must be an
320 integer, will be set to 1 if no specified.
323 Maximum amount of memory to allocate for an instance by default, can
324 be either an integer or an integer followed by a unit (M for
325 mebibytes and G for gibibytes are supported), will be set to 128M if
329 Minimum amount of memory to allocate for an instance by default, can
330 be either an integer or an integer followed by a unit (M for
331 mebibytes and G for gibibytes are supported), will be set to 128M if
335 Value of the auto\_balance flag for instances to use by default,
336 will be set to true if not specified.
339 Default value for the ``always_failover`` flag for instances; if
340 not set, ``False`` is used.
343 The ``-N (--nic-parameters)`` option allows you to set the default
344 network interface parameters for the cluster. The parameter format is a
345 comma-separated list of key=value pairs with the following supported
349 The default NIC mode, one of ``routed``, ``bridged`` or
353 In ``bridged`` or ``openvswitch`` mode the default interface where
354 to attach NICs. In ``routed`` mode it represents an
355 hypervisor-vif-script dependent value to allow different instance
356 groups. For example under the KVM default network script it is
357 interpreted as a routing table number or name. Openvswitch support
358 is also hypervisor dependent and currently works for the default KVM
359 network script. Under Xen a custom network script must be provided.
361 The ``-D (--disk-parameters)`` option allows you to set the default disk
362 template parameters at cluster level. The format used for this option is
363 similar to the one use by the ``-H`` option: the disk template name
364 must be specified first, followed by a colon and by a comma-separated
365 list of key-value pairs. These parameters can only be specified at
366 cluster and node group level; the cluster-level parameter are inherited
367 by the node group at the moment of its creation, and can be further
368 modified at node group level using the **gnt-group**\(8) command.
370 The following is the list of disk parameters available for the **drbd**
371 template, with measurement units specified in square brackets at the end
372 of the description (when applicable):
375 Static re-synchronization rate. [KiB/s]
378 Number of stripes to use for data LVs.
381 Number of stripes to use for meta LVs.
384 What kind of barriers to **disable** for disks. It can either assume
385 the value "n", meaning no barrier disabled, or a non-empty string
386 containing a subset of the characters "bfd". "b" means disable disk
387 barriers, "f" means disable disk flushes, "d" disables disk drains.
390 Boolean value indicating whether the meta barriers should be
391 disabled (True) or not (False).
394 String containing the name of the default LVM volume group for DRBD
395 metadata. By default, it is set to ``xenvg``. It can be overridden
396 during the instance creation process by using the ``metavg`` key of
397 the ``--disk`` parameter.
400 String containing additional parameters to be appended to the
401 arguments list of ``drbdsetup disk``.
404 String containing additional parameters to be appended to the
405 arguments list of ``drbdsetup net``.
408 Boolean indicating whether to use the dynamic resync speed
409 controller or not. If enabled, c-plan-ahead must be non-zero and all
410 the c-* parameters will be used by DRBD. Otherwise, the value of
411 resync-rate will be used as a static resync speed.
414 Agility factor of the dynamic resync speed controller. (the higher,
415 the slower the algorithm will adapt the resync speed). A value of 0
416 (that is the default) disables the controller. [ds]
419 Maximum amount of in-flight resync data for the dynamic resync speed
420 controller. [sectors]
423 Maximum estimated peer response latency for the dynamic resync speed
427 Minimum resync speed for the dynamic resync speed controller. [KiB/s]
430 Upper bound on resync speed for the dynamic resync speed controller.
433 List of parameters available for the **plain** template:
436 Number of stripes to use for new LVs.
438 List of parameters available for the **rbd** template:
441 The RADOS cluster pool, inside which all rbd volumes will reside.
442 When a new RADOS cluster is deployed, the default pool to put rbd
443 volumes (Images in RADOS terminology) is 'rbd'.
445 The option ``--maintain-node-health`` allows one to enable/disable
446 automatic maintenance actions on nodes. Currently these include
447 automatic shutdown of instances and deactivation of DRBD devices on
448 offline nodes; in the future it might be extended to automatic
449 removal of unknown LVM volumes, etc. Note that this option is only
450 useful if the use of ``ganeti-confd`` was enabled at compilation.
452 The ``--uid-pool`` option initializes the user-id pool. The
453 *user-id pool definition* can contain a list of user-ids and/or a
454 list of user-id ranges. The parameter format is a comma-separated
455 list of numeric user-ids or user-id ranges. The ranges are defined
456 by a lower and higher boundary, separated by a dash. The boundaries
457 are inclusive. If the ``--uid-pool`` option is not supplied, the
458 user-id pool is initialized to an empty list. An empty list means
459 that the user-id pool feature is disabled.
461 The ``-I (--default-iallocator)`` option specifies the default
462 instance allocator. The instance allocator will be used for operations
463 like instance creation, instance and node migration, etc. when no
464 manual override is specified. If this option is not specified and
465 htools was not enabled at build time, the default instance allocator
466 will be blank, which means that relevant operations will require the
467 administrator to manually specify either an instance allocator, or a
468 set of nodes. If the option is not specified but htools was enabled,
469 the default iallocator will be **hail**\(1) (assuming it can be found
470 on disk). The default iallocator can be changed later using the
473 The ``--primary-ip-version`` option specifies the IP version used
474 for the primary address. Possible values are 4 and 6 for IPv4 and
475 IPv6, respectively. This option is used when resolving node names
476 and the cluster name.
478 The ``--node-parameters`` option allows you to set default node
479 parameters for the cluster. Please see **ganeti**\(7) for more
480 information about supported key=value pairs.
482 The ``-C (--candidate-pool-size)`` option specifies the
483 ``candidate_pool_size`` cluster parameter. This is the number of nodes
484 that the master will try to keep as master\_candidates. For more
485 details about this role and other node roles, see the **ganeti**\(7).
487 The ``--specs-...`` and ``--ipolicy-disk-templates`` options specify
488 instance policy on the cluster. For the ``--specs-...`` options, each
489 option can have three values: ``min``, ``max`` and ``std``, which can
490 also be modified on group level (except for ``std``, which is defined
491 once for the entire cluster). Please note, that ``std`` values are not
492 the same as defaults set by ``--beparams``, but they are used for the
493 capacity calculations. The ``--ipolicy-disk-templates`` option takes a
494 comma-separated list of disk templates.
496 - ``--specs-cpu-count`` limits the number of VCPUs that can be used by an
498 - ``--specs-disk-count`` limits the number of disks
499 - ``--specs-disk-size`` limits the disk size for every disk used
500 - ``--specs-mem-size`` limits the amount of memory available
501 - ``--specs-nic-count`` sets limits on the number of NICs used
502 - ``--ipolicy-disk-templates`` limits the allowed disk templates
504 The ``--drbd-usermode-helper`` option can be used to specify a usermode
505 helper. Check that this string is the one used by the DRBD kernel.
507 For details about how to use ``--hypervisor-state`` and ``--disk-state``
508 have a look at **ganeti**\(7).
510 The ``--enabled-disk-templates`` option specifies a list of disk templates
511 that can be used by instances of the cluster. For the possible values in
512 this list, see **gnt-instance**\(8). Note that in contrast to the list of
513 disk templates in the ipolicy, this list is a hard restriction. It is not
514 possible to create instances with disk templates that are not enabled in
515 the cluster. It is also not possible to disable a disk template when there
516 are still instances using it.
521 **master-failover** [\--no-voting] [\--yes-do-it]
523 Failover the master role to the current node.
525 The ``--no-voting`` option skips the remote node agreement checks.
526 This is dangerous, but necessary in some cases (for example failing
527 over the master role in a 2 node cluster with the original master
528 down). If the original master then comes up, it won't be able to
529 start its master daemon because it won't have enough votes, but so
530 won't the new master, if the master daemon ever needs a restart.
531 You can pass ``--no-voting`` to **ganeti-masterd** on the new
532 master to solve this problem, and run **gnt-cluster redist-conf**
533 to make sure the cluster is consistent again.
535 The option ``--yes-do-it`` is used together with ``--no-voting``, for
536 skipping the interactive checks. This is even more dangerous, and should
537 only be used in conjunction with other means (e.g. a HA suite) to
538 confirm that the operation is indeed safe.
545 Checks if the master daemon is alive.
547 If the master daemon is alive and can respond to a basic query (the
548 equivalent of **gnt-cluster info**), then the exit code of the
549 command will be 0. If the master daemon is not alive (either due to
550 a crash or because this is not the master node), the exit code will
556 | **modify** [\--submit]
557 | [\--vg-name *vg-name*]
558 | [\--enabled-hypervisors *hypervisors*]
559 | [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
560 | [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
561 | [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
562 | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
563 | [\--uid-pool *user-id pool definition*]
564 | [\--add-uids *user-id pool definition*]
565 | [\--remove-uids *user-id pool definition*]
566 | [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
567 | [\--maintain-node-health {yes \| no}]
568 | [\--prealloc-wipe-disks {yes \| no}]
569 | [{-I|\--default-iallocator} *default instance allocator*]
570 | [\--reserved-lvs=*NAMES*]
571 | [\--node-parameters *ndparams*]
572 | [\--master-netdev *interface-name*]
573 | [\--master-netmask *netmask*]
574 | [\--use-external-mip-script {yes \| no}]
575 | [\--hypervisor-state *hvstate*]
576 | [\--disk-state *diskstate*]
577 | [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
578 | [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
579 | [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
580 | [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
581 | [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
582 | [\--ipolicy-disk-templates *template* [,*template*...]]
583 | [\--enabled-disk-templates *template* [,*template*...]]
584 | [\--drbd-usermode-helper *helper*]
587 Modify the options for the cluster.
589 The ``--vg-name``, ``--enabled-hypervisors``, ``-H (--hypervisor-parameters)``,
590 ``-B (--backend-parameters)``, ``-D (--disk-parameters)``, ``--nic-parameters``,
591 ``-C (--candidate-pool-size)``, ``--maintain-node-health``,
592 ``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``,
593 ``--master-netdev``, ``--master-netmask``, ``--use-external-mip-script``,
594 ``--drbd-usermode-helper``, and ``--enabled-disk-templates`` options are
595 described in the **init** command.
597 The ``--hypervisor-state`` and ``--disk-state`` options are described in
598 detail in **ganeti**\(7).
600 The ``--add-uids`` and ``--remove-uids`` options can be used to
601 modify the user-id pool by adding/removing a list of user-ids or
604 The option ``--reserved-lvs`` specifies a list (comma-separated) of
605 logical volume group names (regular expressions) that will be
606 ignored by the cluster verify operation. This is useful if the
607 volume group used for Ganeti is shared with the system for other
608 uses. Note that it's not recommended to create and mark as ignored
609 logical volume names which match Ganeti's own name format (starting
610 with UUID and then .diskN), as this option only skips the
611 verification, but not the actual use of the names given.
613 To remove all reserved logical volumes, pass in an empty argument
614 to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``.
616 The ``-I (--default-iallocator)`` is described in the **init**
617 command. To clear the default iallocator, just pass an empty string
620 The ``--specs-...`` and ``--ipolicy-disk-templates`` options are
621 described in the **init** command.
623 See **ganeti**\(7) for a description of ``--submit`` and other common
629 **queue** {drain | undrain | info}
631 Change job queue properties.
633 The ``drain`` option sets the drain flag on the job queue. No new
634 jobs will be accepted, but jobs already in the queue will be
637 The ``undrain`` will unset the drain flag on the job queue. New
638 jobs will be accepted.
640 The ``info`` option shows the properties of the job queue.
645 **watcher** {pause *duration* | continue | info}
647 Make the watcher pause or let it continue.
649 The ``pause`` option causes the watcher to pause for *duration*
652 The ``continue`` option will let the watcher continue.
654 The ``info`` option shows whether the watcher is currently paused.
659 **redist-conf** [\--submit]
661 This command forces a full push of configuration files from the
662 master node to the other nodes in the cluster. This is normally not
663 needed, but can be run if the **verify** complains about
664 configuration mismatches.
666 See **ganeti**\(7) for a description of ``--submit`` and other common
672 **rename** [-f] {*name*}
674 Renames the cluster and in the process updates the master IP
675 address to the one the new name resolves to. At least one of either
676 the name or the IP address must be different, otherwise the
677 operation will be aborted.
679 Note that since this command can be dangerous (especially when run
680 over SSH), the command will require confirmation unless run with
686 | **renew-crypto** [-f]
687 | [\--new-cluster-certificate] [\--new-confd-hmac-key]
688 | [\--new-rapi-certificate] [\--rapi-certificate *rapi-cert*]
689 | [\--new-spice-certificate | \--spice-certificate *spice-cert*
690 | \--spice-ca-certificate *spice-ca-cert*]
691 | [\--new-cluster-domain-secret] [\--cluster-domain-secret *filename*]
693 This command will stop all Ganeti daemons in the cluster and start
694 them again once the new certificates and keys are replicated. The
695 options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
696 can be used to regenerate the cluster-internal SSL certificate
697 respective the HMAC key used by **ganeti-confd**\(8).
699 To generate a new self-signed RAPI certificate (used by
700 **ganeti-rapi**\(8)) specify ``--new-rapi-certificate``. If you want to
701 use your own certificate, e.g. one signed by a certificate
702 authority (CA), pass its filename to ``--rapi-certificate``.
704 To generate a new self-signed SPICE certificate, used by SPICE
705 connections to the KVM hypervisor, specify the
706 ``--new-spice-certificate`` option. If you want to provide a
707 certificate, pass its filename to ``--spice-certificate`` and pass the
708 signing CA certificate to ``--spice-ca-certificate``.
710 ``--new-cluster-domain-secret`` generates a new, random cluster
711 domain secret. ``--cluster-domain-secret`` reads the secret from a
712 file. The cluster domain secret is used to sign information
713 exchanged between separate clusters via a third party.
718 **repair-disk-sizes** [instance...]
720 This command checks that the recorded size of the given instance's
721 disks matches the actual size and updates any mismatches found.
722 This is needed if the Ganeti configuration is no longer consistent
723 with reality, as it will impact some disk operations. If no
724 arguments are given, all instances will be checked.
726 Note that only active disks can be checked by this command; in case
727 a disk cannot be activated it's advised to use
728 **gnt-instance activate-disks \--ignore-size ...** to force
729 activation without regard to the current size.
731 When the all disk sizes are consistent, the command will return no
732 output. Otherwise it will log details about the inconsistencies in
738 | **verify** [\--no-nplus1-mem] [\--node-group *nodegroup*]
739 | [\--error-codes] [{-I|\--ignore-errors} *errorcode*]
740 | [{-I|\--ignore-errors} *errorcode*...]
742 Verify correctness of cluster configuration. This is safe with
743 respect to running instances, and incurs no downtime of the
746 If the ``--no-nplus1-mem`` option is given, Ganeti won't check
747 whether if it loses a node it can restart all the instances on
748 their secondaries (and report an error otherwise).
750 With ``--node-group``, restrict the verification to those nodes and
751 instances that live in the named group. This will not verify global
752 settings, but will allow to perform verification of a group while other
753 operations are ongoing in other groups.
755 The ``--error-codes`` option outputs each error in the following
756 parseable format: *ftype*:*ecode*:*edomain*:*name*:*msg*.
757 These fields have the following meaning:
760 Failure type. Can be *WARNING* or *ERROR*.
763 Error code of the failure. See below for a list of error codes.
766 Can be *cluster*, *node* or *instance*.
769 Contains the name of the item that is affected from the failure.
772 Contains a descriptive error message about the error
774 ``gnt-cluster verify`` will have a non-zero exit code if at least one of
775 the failures that are found are of type *ERROR*.
777 The ``--ignore-errors`` option can be used to change this behaviour,
778 because it demotes the error represented by the error code received as a
779 parameter to a warning. The option must be repeated for each error that
780 should be ignored (e.g.: ``-I ENODEVERSION -I ENODEORPHANLV``). The
781 ``--error-codes`` option can be used to determine the error code of a
793 The command checks which instances have degraded DRBD disks and
794 activates the disks of those instances.
796 This command is run from the **ganeti-watcher** tool, which also
797 has a different, complementary algorithm for doing this check.
798 Together, these two should ensure that DRBD disks are kept
806 Show the cluster version.
814 **add-tags** [\--from *file*] {*tag*...}
816 Add tags to the cluster. If any of the tags contains invalid
817 characters, the entire operation will abort.
819 If the ``--from`` option is given, the list of tags will be
820 extended with the contents of that file (each line becomes a tag).
821 In this case, there is not need to pass tags on the command line
822 (if you do, both sources will be used). A file name of - will be
823 interpreted as stdin.
830 List the tags of the cluster.
835 **remove-tags** [\--from *file*] {*tag*...}
837 Remove tags from the cluster. If any of the tags are not existing
838 on the cluster, the entire operation will abort.
840 If the ``--from`` option is given, the list of tags to be removed will
841 be extended with the contents of that file (each line becomes a tag).
842 In this case, there is not need to pass tags on the command line (if
843 you do, tags from both sources will be removed). A file name of - will
844 be interpreted as stdin.
849 **search-tags** {*pattern*}
851 Searches the tags on all objects in the cluster (the cluster
852 itself, the nodes and the instances) for a given pattern. The
853 pattern is interpreted as a regular expression and a search will be
854 done on it (i.e. the given pattern is not anchored to the beggining
855 of the string; if you want that, prefix the pattern with ^).
857 If no tags are matching the pattern, the exit code of the command
858 will be one. If there is at least one match, the exit code will be
859 zero. Each match is listed on one line, the object and the tag
860 separated by a space. The cluster will be listed as /cluster, a
861 node will be listed as /nodes/*name*, and an instance as
862 /instances/*name*. Example:
866 # gnt-cluster search-tags time
867 /cluster ctime:2007-09-01
868 /nodes/node1.example.com mtime:2007-10-04
870 .. vim: set textwidth=72 :