COMMANDS
--------
-ADD-TAGS
-~~~~~~~~
-
-**add-tags** [--from *file*] {*tag*...}
+ACTIVATE-MASTER-IP
+~~~~~~~~~~~~~~~~~~
-Add tags to the cluster. If any of the tags contains invalid
-characters, the entire operation will abort.
+**activate-master-ip**
-If the ``--from`` option is given, the list of tags will be
-extended with the contents of that file (each line becomes a tag).
-In this case, there is not need to pass tags on the command line
-(if you do, both sources will be used). A file name of - will be
-interpreted as stdin.
+Activates the master IP on the master node.
COMMAND
~~~~~~~
-**command** [-n *node*] {*command*}
+**command** [-n *node*] [-g *group*] [-M] {*command*}
-Executes a command on all nodes. If the option ``-n`` is not given,
-the command will be executed on all nodes, otherwise it will be
-executed only on the node(s) specified. Use the option multiple
-times for running it on multiple nodes, like::
+Executes a command on all nodes. This command is designed for simple
+usage. For more complex use cases the commands **dsh**\(1) or **cssh**\(1)
+should be used instead.
+
+If the option ``-n`` is not given, the command will be executed on all
+nodes, otherwise it will be executed only on the node(s) specified. Use
+the option multiple times for running it on multiple nodes, like::
# gnt-cluster command -n node1.example.com -n node2.example.com date
+The ``-g`` option can be used to run a command only on a specific node
+group, e.g.::
+
+ # gnt-cluster command -g default date
+
+The ``-M`` option can be used to prepend the node name to all output
+lines. The ``--failure-only`` option hides successful commands, making
+it easier to see failures.
+
The command is executed serially on the selected nodes. If the
master node is present in the list, the command will be executed
last on the master. Regarding the other nodes, the execution order
COPYFILE
~~~~~~~~
-**copyfile** [--use-replication-network] [-n *node*] {*file*}
+| **copyfile** [\--use-replication-network] [-n *node*] [-g *group*]
+| {*file*}
Copies a file to all or to some nodes. The argument specifies the
source file (on the current system), the ``-n`` argument specifies
the target node, or nodes if the option is given multiple times. If
-``-n`` is not given at all, the file will be copied to all nodes.
+``-n`` is not given at all, the file will be copied to all nodes. The
+``-g`` option can be used to only select nodes in a specific node group.
Passing the ``--use-replication-network`` option will cause the
copy to be done over the replication network (only matters if the
primary/secondary IPs are different). Example::
This will copy the file /tmp/test from the current node to the two
named nodes.
+DEACTIVATE-MASTER-IP
+~~~~~~~~~~~~~~~~~~~~
+
+**deactivate-master-ip** [\--yes]
+
+Deactivates the master IP on the master node.
+
+This should be run only locally or on a connection to the node ip
+directly, as a connection to the master ip will be broken by this
+operation. Because of this risk it will require user confirmation
+unless the ``--yes`` option is passed.
+
DESTROY
~~~~~~~
-**destroy** {--yes-do-it}
+**destroy** {\--yes-do-it}
Remove all configuration files related to the cluster, so that a
**gnt-cluster init** can be done again afterwards.
Since this is a dangerous command, you are required to pass the
-argument *--yes-do-it.*
+argument *\--yes-do-it.*
+
+EPO
+~~~
+
+**epo** [\--on] [\--groups|\--all] [\--power-delay] *arguments*
+
+Performs an emergency power-off on nodes given as arguments. If
+``--groups`` is given, arguments are node groups. If ``--all`` is
+provided, the whole cluster will be shut down.
+
+The ``--on`` flag recovers the cluster after an emergency power-off.
+When powering on the cluster you can use ``--power-delay`` to define the
+time in seconds (fractions allowed) waited between powering on
+individual nodes.
+
+Please note that the master node will not be turned down or up
+automatically. It will just be left in a state, where you can manully
+perform the shutdown of that one node. If the master is in the list of
+affected nodes and this is not a complete cluster emergency power-off
+(e.g. using ``--all``), you're required to do a master failover to
+another node not affected.
GETMASTER
~~~~~~~~~
INFO
~~~~
-**info** [--roman]
+**info** [\--roman]
Shows runtime cluster information: cluster name, architecture (32
or 64 bit), master node, node list and instance list.
its integer fields in a latin friendly way. This allows further
diffusion of Ganeti among ancient cultures.
+SHOW-ISPECS-CMD
+~~~~~~~~~~~~~~~
+
+**show-ispecs-cmd**
+
+Shows the command line that can be used to recreate the cluster with the
+same options relative to specs in the instance policies.
+
INIT
~~~~
| **init**
-| [{-s|--secondary-ip} *secondary\_ip*]
-| [--vg-name *vg-name*]
-| [--master-netdev *interface-name*]
-| [{-m|--mac-prefix} *mac-prefix*]
-| [--no-lvm-storage]
-| [--no-etc-hosts]
-| [--no-ssh-init]
-| [--file-storage-dir *dir*]
-| [--enabled-hypervisors *hypervisors*]
-| [-t *hypervisor name*]
-| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
-| [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
-| [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
-| [--maintain-node-health {yes \| no}]
-| [--uid-pool *user-id pool definition*]
-| [{-I|--default-iallocator} *default instance allocator*]
-| [--primary-ip-version *version*]
-| [--prealloc-wipe-disks {yes \| no}]
-| [--node-parameters *ndparams*]
-| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
+| [{-s|\--secondary-ip} *secondary\_ip*]
+| [\--vg-name *vg-name*]
+| [\--master-netdev *interface-name*]
+| [\--master-netmask *netmask*]
+| [\--use-external-mip-script {yes \| no}]
+| [{-m|\--mac-prefix} *mac-prefix*]
+| [\--no-etc-hosts]
+| [\--no-ssh-init]
+| [\--file-storage-dir *dir*]
+| [\--shared-file-storage-dir *dir*]
+| [\--enabled-hypervisors *hypervisors*]
+| [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
+| [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
+| [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
+| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
+| [\--maintain-node-health {yes \| no}]
+| [\--uid-pool *user-id pool definition*]
+| [{-I|\--default-iallocator} *default instance allocator*]
+| [\--primary-ip-version *version*]
+| [\--prealloc-wipe-disks {yes \| no}]
+| [\--node-parameters *ndparams*]
+| [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
+| [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
+| [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
+| [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
+| [\--ipolicy-std-specs *spec*=*value* [,*spec*=*value*...]]
+| [\--ipolicy-bounds-specs *bounds_ispecs*]
+| [\--ipolicy-disk-templates *template* [,*template*...]]
+| [\--ipolicy-spindle-ratio *ratio*]
+| [\--ipolicy-vcpu-ratio *ratio*]
+| [\--disk-state *diskstate*]
+| [\--hypervisor-state *hvstate*]
+| [\--drbd-usermode-helper *helper*]
+| [\--enabled-disk-templates *template* [,*template*...]]
| {*clustername*}
This commands is only run once initially on the first node of the
different than "xenvg" for Ganeti to use when creating instance
disks. This volume group must have the same name on all nodes. Once
the cluster is initialized this can be altered by using the
-**modify** command. If you don't want to use lvm storage at all use
-the ``--no-lvm-storage`` option. Once the cluster is initialized
+**modify** command. Note that if the volume group name is modified after
+the cluster creation and DRBD support is enabled you might have to
+manually modify the metavg as well.
+
+If you don't want to use lvm storage at all use
+the ``--enabled-disk-templates`` option to restrict the set of enabled
+disk templates. Once the cluster is initialized
you can change this setup with the **modify** command.
The ``--master-netdev`` option is useful for specifying a different
important that all nodes have this interface because you'll need it
for a master failover.
+The ``--master-netmask`` option allows to specify a netmask for the
+master IP. The netmask must be specified as an integer, and will be
+interpreted as a CIDR netmask. The default value is 32 for an IPv4
+address and 128 for an IPv6 address.
+
+The ``--use-external-mip-script`` option allows to specify whether to
+use an user-supplied master IP address setup script, whose location is
+``@SYSCONFDIR@/ganeti/scripts/master-ip-setup``. If the option value is
+set to False, the default script (located at
+``@PKGLIBDIR@/tools/master-ip-setup``) will be executed.
+
The ``-m (--mac-prefix)`` option will let you specify a three byte
prefix under which the virtual MAC addresses of your instances will be
generated. The prefix must be specified in the format ``XX:XX:XX`` and
the default is ``aa:00:00``.
-The ``--no-lvm-storage`` option allows you to initialize the
-cluster without lvm support. This means that only instances using
-files as storage backend will be possible to create. Once the
-cluster is initialized you can change this setup with the
-**modify** command.
-
The ``--no-etc-hosts`` option allows you to initialize the cluster
without modifying the /etc/hosts file.
The ``--no-ssh-init`` option allows you to initialize the cluster
without creating or distributing SSH key pairs.
-The ``--file-storage-dir`` option allows you set the directory to
-use for storing the instance disk files when using file storage as
-backend for instance disks.
+The ``--file-storage-dir`` and ``--shared-file-storage-dir`` options
+allow you set the directory to use for storing the instance disk files
+when using file storage backend, respectively shared file storage
+backend, for instance disks. Note that the file and shared file storage
+dir must be an allowed directory for file storage. Those directories
+are specified in the ``@SYSCONFDIR@/ganeti/file-storage-paths`` file.
+The file storage directory can also be a subdirectory of an allowed one.
+The file storage directory should be present on all nodes.
-The ``--prealloc-wipe-disks`` sets a cluster wide configuration
-value for wiping disks prior to allocation. This increases security
-on instance level as the instance can't access untouched data from
-it's underlying storage.
+The ``--prealloc-wipe-disks`` sets a cluster wide configuration value
+for wiping disks prior to allocation and size changes (``gnt-instance
+grow-disk``). This increases security on instance level as the instance
+can't access untouched data from its underlying storage.
The ``--enabled-hypervisors`` option allows you to set the list of
hypervisors that will be enabled for this cluster. Instance
hypervisor specific parameters for the cluster. The format of this
option is the name of the hypervisor, followed by a colon and a
comma-separated list of key=value pairs. The keys available for each
-hypervisors are detailed in the gnt-instance(8) man page, in the
+hypervisors are detailed in the **gnt-instance**\(8) man page, in the
**add** command plus the following parameters which are only
configurable globally (at cluster level):
This options specifies the TCP port to use for live-migration. For
Xen, the same port should be configured on all nodes in the
- ``/etc/xen/xend-config.sxp`` file, under the key
+ ``@XEN_CONFIG_DIR@/xend-config.sxp`` file, under the key
"xend-relocation-port".
migration\_bandwidth
Number of VCPUs to set for an instance by default, must be an
integer, will be set to 1 if no specified.
-memory
- Amount of memory to allocate for an instance by default, can be
- either an integer or an integer followed by a unit (M for mebibytes
- and G for gibibytes are supported), will be set to 128M if not
- specified.
+maxmem
+ Maximum amount of memory to allocate for an instance by default, can
+ be either an integer or an integer followed by a unit (M for
+ mebibytes and G for gibibytes are supported), will be set to 128M if
+ not specified.
+
+minmem
+ Minimum amount of memory to allocate for an instance by default, can
+ be either an integer or an integer followed by a unit (M for
+ mebibytes and G for gibibytes are supported), will be set to 128M if
+ not specified.
auto\_balance
Value of the auto\_balance flag for instances to use by default,
will be set to true if not specified.
+always\_failover
+ Default value for the ``always_failover`` flag for instances; if
+ not set, ``False`` is used.
-The ``-N (--nic-parameters)`` option allows you to set the default nic
-parameters for the cluster. The parameter format is a comma-separated
-list of key=value pairs with the following supported keys:
+
+The ``-N (--nic-parameters)`` option allows you to set the default
+network interface parameters for the cluster. The parameter format is a
+comma-separated list of key=value pairs with the following supported
+keys:
mode
- The default nic mode, 'routed' or 'bridged'.
+ The default NIC mode, one of ``routed``, ``bridged`` or
+ ``openvswitch``.
link
- In bridged mode the default NIC bridge. In routed mode it
- represents an hypervisor-vif-script dependent value to allow
- different instance groups. For example under the KVM default
- network script it is interpreted as a routing table number or
- name.
+ In ``bridged`` or ``openvswitch`` mode the default interface where
+ to attach NICs. In ``routed`` mode it represents an
+ hypervisor-vif-script dependent value to allow different instance
+ groups. For example under the KVM default network script it is
+ interpreted as a routing table number or name. Openvswitch support
+ is also hypervisor dependent and currently works for the default KVM
+ network script. Under Xen a custom network script must be provided.
+
+The ``-D (--disk-parameters)`` option allows you to set the default disk
+template parameters at cluster level. The format used for this option is
+similar to the one use by the ``-H`` option: the disk template name
+must be specified first, followed by a colon and by a comma-separated
+list of key-value pairs. These parameters can only be specified at
+cluster and node group level; the cluster-level parameter are inherited
+by the node group at the moment of its creation, and can be further
+modified at node group level using the **gnt-group**\(8) command.
+
+The following is the list of disk parameters available for the **drbd**
+template, with measurement units specified in square brackets at the end
+of the description (when applicable):
+
+resync-rate
+ Static re-synchronization rate. [KiB/s]
+
+data-stripes
+ Number of stripes to use for data LVs.
+
+meta-stripes
+ Number of stripes to use for meta LVs.
+
+disk-barriers
+ What kind of barriers to **disable** for disks. It can either assume
+ the value "n", meaning no barrier disabled, or a non-empty string
+ containing a subset of the characters "bfd". "b" means disable disk
+ barriers, "f" means disable disk flushes, "d" disables disk drains.
+
+meta-barriers
+ Boolean value indicating whether the meta barriers should be
+ disabled (True) or not (False).
+
+metavg
+ String containing the name of the default LVM volume group for DRBD
+ metadata. By default, it is set to ``xenvg``. It can be overridden
+ during the instance creation process by using the ``metavg`` key of
+ the ``--disk`` parameter.
+
+disk-custom
+ String containing additional parameters to be appended to the
+ arguments list of ``drbdsetup disk``.
+
+net-custom
+ String containing additional parameters to be appended to the
+ arguments list of ``drbdsetup net``.
+
+protocol
+ Replication protocol for the DRBD device. Has to be either "A", "B"
+ or "C". Refer to the DRBD documentation for further information
+ about the differences between the protocols.
+
+dynamic-resync
+ Boolean indicating whether to use the dynamic resync speed
+ controller or not. If enabled, c-plan-ahead must be non-zero and all
+ the c-* parameters will be used by DRBD. Otherwise, the value of
+ resync-rate will be used as a static resync speed.
+
+c-plan-ahead
+ Agility factor of the dynamic resync speed controller. (the higher,
+ the slower the algorithm will adapt the resync speed). A value of 0
+ (that is the default) disables the controller. [ds]
+
+c-fill-target
+ Maximum amount of in-flight resync data for the dynamic resync speed
+ controller. [sectors]
+
+c-delay-target
+ Maximum estimated peer response latency for the dynamic resync speed
+ controller. [ds]
+
+c-min-rate
+ Minimum resync speed for the dynamic resync speed controller. [KiB/s]
+
+c-max-rate
+ Upper bound on resync speed for the dynamic resync speed controller.
+ [KiB/s]
+
+List of parameters available for the **plain** template:
+
+stripes
+ Number of stripes to use for new LVs.
+
+List of parameters available for the **rbd** template:
+
+pool
+ The RADOS cluster pool, inside which all rbd volumes will reside.
+ When a new RADOS cluster is deployed, the default pool to put rbd
+ volumes (Images in RADOS terminology) is 'rbd'.
The option ``--maintain-node-health`` allows one to enable/disable
automatic maintenance actions on nodes. Currently these include
automatic shutdown of instances and deactivation of DRBD devices on
offline nodes; in the future it might be extended to automatic
-removal of unknown LVM volumes, etc.
+removal of unknown LVM volumes, etc. Note that this option is only
+useful if the use of ``ganeti-confd`` was enabled at compilation.
The ``--uid-pool`` option initializes the user-id pool. The
*user-id pool definition* can contain a list of user-ids and/or a
that the user-id pool feature is disabled.
The ``-I (--default-iallocator)`` option specifies the default
-instance allocator. The instance allocator will be used for
-operations like instance creation, instance and node migration,
-etc. when no manual override is specified. If this option is not
-specified, the default instance allocator will be blank, which
-means that relevant operations will require the administrator to
-manually specify either an instance allocator, or a set of nodes.
-The default iallocator can be changed later using the **modify**
-command.
+instance allocator. The instance allocator will be used for operations
+like instance creation, instance and node migration, etc. when no
+manual override is specified. If this option is not specified and
+htools was not enabled at build time, the default instance allocator
+will be blank, which means that relevant operations will require the
+administrator to manually specify either an instance allocator, or a
+set of nodes. If the option is not specified but htools was enabled,
+the default iallocator will be **hail**\(1) (assuming it can be found
+on disk). The default iallocator can be changed later using the
+**modify** command.
The ``--primary-ip-version`` option specifies the IP version used
for the primary address. Possible values are 4 and 6 for IPv4 and
and the cluster name.
The ``--node-parameters`` option allows you to set default node
-parameters for the cluster. Please see **ganeti**(7) for more
+parameters for the cluster. Please see **ganeti**\(7) for more
information about supported key=value pairs.
The ``-C (--candidate-pool-size)`` option specifies the
``candidate_pool_size`` cluster parameter. This is the number of nodes
that the master will try to keep as master\_candidates. For more
-details about this role and other node roles, see the ganeti(7).
-
-LIST-TAGS
-~~~~~~~~~
-
-**list-tags**
-
-List the tags of the cluster.
+details about this role and other node roles, see the **ganeti**\(7).
+
+The ``--specs-...`` and ``--ipolicy-...`` options specify the instance
+policy on the cluster. The ``--ipolicy-bounds-specs`` option sets the
+minimum and maximum specifications for instances. The format is:
+min:*param*=*value*,.../max:*param*=*value*,... and further
+specifications pairs can be added by using ``//`` as a separator. The
+``--ipolicy-std-specs`` option takes a list of parameter/value pairs.
+For both options, *param* can be:
+
+- ``cpu-count``: number of VCPUs for an instance
+- ``disk-count``: number of disk for an instance
+- ``disk-size``: size of each disk
+- ``memory-size``: instance memory
+- ``nic-count``: number of network interface
+- ``spindle-use``: spindle usage for an instance
+
+For the ``--specs-...`` options, each option can have three values:
+``min``, ``max`` and ``std``, which can also be modified on group level
+(except for ``std``, which is defined once for the entire cluster).
+Please note, that ``std`` values are not the same as defaults set by
+``--beparams``, but they are used for the capacity calculations.
+
+- ``--specs-cpu-count`` limits the number of VCPUs that can be used by an
+ instance.
+- ``--specs-disk-count`` limits the number of disks
+- ``--specs-disk-size`` limits the disk size for every disk used
+- ``--specs-mem-size`` limits the amount of memory available
+- ``--specs-nic-count`` sets limits on the number of NICs used
+
+The ``--ipolicy-spindle-ratio`` option takes a decimal number. The
+``--ipolicy-disk-templates`` option takes a comma-separated list of disk
+templates. This list of disk templates must be a subset of the list
+of cluster-wide enabled disk templates (which can be set with
+``--enabled-disk-templates``).
+
+- ``--ipolicy-spindle-ratio`` limits the instances-spindles ratio
+- ``--ipolicy-vcpu-ratio`` limits the vcpu-cpu ratio
+
+All the instance policy elements can be overridden at group level. Group
+level overrides can be removed by specifying ``default`` as the value of
+an item.
+
+The ``--drbd-usermode-helper`` option can be used to specify a usermode
+helper. Check that this string is the one used by the DRBD kernel.
+
+For details about how to use ``--hypervisor-state`` and ``--disk-state``
+have a look at **ganeti**\(7).
+
+The ``--enabled-disk-templates`` option specifies a list of disk templates
+that can be used by instances of the cluster. For the possible values in
+this list, see **gnt-instance**\(8). Note that in contrast to the list of
+disk templates in the ipolicy, this list is a hard restriction. It is not
+possible to create instances with disk templates that are not enabled in
+the cluster. It is also not possible to disable a disk template when there
+are still instances using it. The first disk template in the list of
+enabled disk template is the default disk template. It will be used for
+instance creation, if no disk template is requested explicitely.
MASTER-FAILOVER
~~~~~~~~~~~~~~~
-**master-failover** [--no-voting]
+**master-failover** [\--no-voting] [\--yes-do-it]
Failover the master role to the current node.
master to solve this problem, and run **gnt-cluster redist-conf**
to make sure the cluster is consistent again.
+The option ``--yes-do-it`` is used together with ``--no-voting``, for
+skipping the interactive checks. This is even more dangerous, and should
+only be used in conjunction with other means (e.g. a HA suite) to
+confirm that the operation is indeed safe.
+
MASTER-PING
~~~~~~~~~~~
MODIFY
~~~~~~
-| **modify**
-| [--vg-name *vg-name*]
-| [--no-lvm-storage]
-| [--enabled-hypervisors *hypervisors*]
-| [{-H|--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
-| [{-B|--backend-parameters} *be-param*=*value* [,*be-param*=*value*...]]
-| [{-N|--nic-parameters} *nic-param*=*value* [,*nic-param*=*value*...]]
-| [--uid-pool *user-id pool definition*]
-| [--add-uids *user-id pool definition*]
-| [--remove-uids *user-id pool definition*]
-| [{-C|--candidate-pool-size} *candidate\_pool\_size*]
-| [--maintain-node-health {yes \| no}]
-| [--prealloc-wipe-disks {yes \| no}]
-| [{-I|--default-iallocator} *default instance allocator*]
-| [--reserved-lvs=*NAMES*]
-| [--node-parameters *ndparams*]
-| [--master-netdev *interface-name*]
+| **modify** [\--submit] [\--print-job-id]
+| [\--force]
+| [\--vg-name *vg-name*]
+| [\--enabled-hypervisors *hypervisors*]
+| [{-H|\--hypervisor-parameters} *hypervisor*:*hv-param*=*value*[,*hv-param*=*value*...]]
+| [{-B|\--backend-parameters} *be-param*=*value*[,*be-param*=*value*...]]
+| [{-N|\--nic-parameters} *nic-param*=*value*[,*nic-param*=*value*...]]
+| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
+| [\--uid-pool *user-id pool definition*]
+| [\--add-uids *user-id pool definition*]
+| [\--remove-uids *user-id pool definition*]
+| [{-C|\--candidate-pool-size} *candidate\_pool\_size*]
+| [\--maintain-node-health {yes \| no}]
+| [\--prealloc-wipe-disks {yes \| no}]
+| [{-I|\--default-iallocator} *default instance allocator*]
+| [\--reserved-lvs=*NAMES*]
+| [\--node-parameters *ndparams*]
+| [\--master-netdev *interface-name*]
+| [\--master-netmask *netmask*]
+| [\--use-external-mip-script {yes \| no}]
+| [\--hypervisor-state *hvstate*]
+| [\--disk-state *diskstate*]
+| [\--ipolicy-std-specs *spec*=*value* [,*spec*=*value*...]]
+| [\--ipolicy-bounds-specs *bounds_ispecs*]
+| [\--ipolicy-disk-templates *template* [,*template*...]]
+| [\--ipolicy-spindle-ratio *ratio*]
+| [\--ipolicy-vcpu-ratio *ratio*]
+| [\--enabled-disk-templates *template* [,*template*...]]
+| [\--drbd-usermode-helper *helper*]
+| [\--file-storage-dir *dir*]
+| [\--shared-file-storage-dir *dir*]
+
Modify the options for the cluster.
-The ``--vg-name``, ``--no-lvm-storarge``, ``--enabled-hypervisors``,
-``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)``,
-``--nic-parameters``, ``-C (--candidate-pool-size)``,
-``--maintain-node-health``, ``--prealloc-wipe-disks``, ``--uid-pool``,
-``--node-parameters``, ``--master-netdev`` options are described in
-the **init** command.
+The ``--vg-name``, ``--enabled-hypervisors``, ``-H (--hypervisor-parameters)``,
+``-B (--backend-parameters)``, ``-D (--disk-parameters)``, ``--nic-parameters``,
+``-C (--candidate-pool-size)``, ``--maintain-node-health``,
+``--prealloc-wipe-disks``, ``--uid-pool``, ``--node-parameters``,
+``--master-netdev``, ``--master-netmask``, ``--use-external-mip-script``,
+``--drbd-usermode-helper``, ``--file-storage-dir``,
+``--shared-file-storage-dir``, and ``--enabled-disk-templates`` options are
+described in the **init** command.
+
+The ``--hypervisor-state`` and ``--disk-state`` options are described in
+detail in **ganeti**\(7).
The ``--add-uids`` and ``--remove-uids`` options can be used to
modify the user-id pool by adding/removing a list of user-ids or
command. To clear the default iallocator, just pass an empty string
('').
+The ``--ipolicy-...`` options are described in the **init** command.
+
+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.
+
QUEUE
~~~~~
The ``info`` option shows whether the watcher is currently paused.
-redist-conf
+REDIST-CONF
~~~~~~~~~~~
-**redist-conf** [--submit]
+**redist-conf** [\--submit] [\--print-job-id]
This command forces a full push of configuration files from the
master node to the other nodes in the cluster. This is normally not
needed, but can be run if the **verify** complains about
configuration mismatches.
-The ``--submit`` option is used to send the job to the master
-daemon but not wait for its completion. The job ID will be shown so
-that it can be examined via **gnt-job info**.
-
-REMOVE-TAGS
-~~~~~~~~~~~
-
-**remove-tags** [--from *file*] {*tag*...}
-
-Remove tags from the cluster. If any of the tags are not existing
-on the cluster, the entire operation will abort.
-
-If the ``--from`` option is given, the list of tags to be removed will
-be extended with the contents of that file (each line becomes a tag).
-In this case, there is not need to pass tags on the command line (if
-you do, tags from both sources will be removed). A file name of - will
-be interpreted as stdin.
+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.
RENAME
~~~~~~
~~~~~~~~~~~~
| **renew-crypto** [-f]
-| [--new-cluster-certificate] [--new-confd-hmac-key]
-| [--new-rapi-certificate] [--rapi-certificate *rapi-cert*]
-| [--new-cluster-domain-secret] [--cluster-domain-secret *filename*]
+| [\--new-cluster-certificate] [\--new-confd-hmac-key]
+| [\--new-rapi-certificate] [\--rapi-certificate *rapi-cert*]
+| [\--new-spice-certificate | \--spice-certificate *spice-cert*
+| \--spice-ca-certificate *spice-ca-cert*]
+| [\--new-cluster-domain-secret] [\--cluster-domain-secret *filename*]
This command will stop all Ganeti daemons in the cluster and start
them again once the new certificates and keys are replicated. The
options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
-can be used to regenerate the cluster-internal SSL certificate
-respective the HMAC key used by ganeti-confd(8).
+can be used to regenerate respectively the cluster-internal SSL
+certificate and the HMAC key used by **ganeti-confd**\(8).
To generate a new self-signed RAPI certificate (used by
-ganeti-rapi(8)) specify ``--new-rapi-certificate``. If you want to
+**ganeti-rapi**\(8)) specify ``--new-rapi-certificate``. If you want to
use your own certificate, e.g. one signed by a certificate
authority (CA), pass its filename to ``--rapi-certificate``.
-``--new-cluster-domain-secret`` generates a new, random cluster
-domain secret. ``--cluster-domain-secret`` reads the secret from a
-file. The cluster domain secret is used to sign information
-exchanged between separate clusters via a third party.
+To generate a new self-signed SPICE certificate, used for SPICE
+connections to the KVM hypervisor, specify the
+``--new-spice-certificate`` option. If you want to provide a
+certificate, pass its filename to ``--spice-certificate`` and pass the
+signing CA certificate to ``--spice-ca-certificate``.
+
+Finally ``--new-cluster-domain-secret`` generates a new, random
+cluster domain secret, and ``--cluster-domain-secret`` reads the
+secret from a file. The cluster domain secret is used to sign
+information exchanged between separate clusters via a third party.
REPAIR-DISK-SIZES
~~~~~~~~~~~~~~~~~
disks matches the actual size and updates any mismatches found.
This is needed if the Ganeti configuration is no longer consistent
with reality, as it will impact some disk operations. If no
-arguments are given, all instances will be checked.
+arguments are given, all instances will be checked. When exclusive
+storage is active, also spindles are updated.
Note that only active disks can be checked by this command; in case
a disk cannot be activated it's advised to use
-**gnt-instance activate-disks --ignore-size ...** to force
+**gnt-instance activate-disks \--ignore-size ...** to force
activation without regard to the current size.
-When the all disk sizes are consistent, the command will return no
+When all the disk sizes are consistent, the command will return no
output. Otherwise it will log details about the inconsistencies in
the configuration.
-SEARCH-TAGS
-~~~~~~~~~~~
-
-**search-tags** {*pattern*}
-
-Searches the tags on all objects in the cluster (the cluster
-itself, the nodes and the instances) for a given pattern. The
-pattern is interpreted as a regular expression and a search will be
-done on it (i.e. the given pattern is not anchored to the beggining
-of the string; if you want that, prefix the pattern with ^).
-
-If no tags are matching the pattern, the exit code of the command
-will be one. If there is at least one match, the exit code will be
-zero. Each match is listed on one line, the object and the tag
-separated by a space. The cluster will be listed as /cluster, a
-node will be listed as /nodes/*name*, and an instance as
-/instances/*name*. Example:
-
-::
-
- # gnt-cluster search-tags time
- /cluster ctime:2007-09-01
- /nodes/node1.example.com mtime:2007-10-04
-
VERIFY
~~~~~~
-**verify** [--no-nplus1-mem]
+| **verify** [\--no-nplus1-mem] [\--node-group *nodegroup*]
+| [\--error-codes] [{-I|\--ignore-errors} *errorcode*]
+| [{-I|\--ignore-errors} *errorcode*...]
Verify correctness of cluster configuration. This is safe with
respect to running instances, and incurs no downtime of the
whether if it loses a node it can restart all the instances on
their secondaries (and report an error otherwise).
+With ``--node-group``, restrict the verification to those nodes and
+instances that live in the named group. This will not verify global
+settings, but will allow to perform verification of a group while other
+operations are ongoing in other groups.
+
+The ``--error-codes`` option outputs each error in the following
+parseable format: *ftype*:*ecode*:*edomain*:*name*:*msg*.
+These fields have the following meaning:
+
+ftype
+ Failure type. Can be *WARNING* or *ERROR*.
+
+ecode
+ Error code of the failure. See below for a list of error codes.
+
+edomain
+ Can be *cluster*, *node* or *instance*.
+
+name
+ Contains the name of the item that is affected from the failure.
+
+msg
+ Contains a descriptive error message about the error
+
+``gnt-cluster verify`` will have a non-zero exit code if at least one of
+the failures that are found are of type *ERROR*.
+
+The ``--ignore-errors`` option can be used to change this behaviour,
+because it demotes the error represented by the error code received as a
+parameter to a warning. The option must be repeated for each error that
+should be ignored (e.g.: ``-I ENODEVERSION -I ENODEORPHANLV``). The
+``--error-codes`` option can be used to determine the error code of a
+given error.
+
+List of error codes:
+
+@CONSTANTS_ECODES@
+
VERIFY-DISKS
~~~~~~~~~~~~
**version**
Show the cluster version.
+
+Tags
+~~~~
+
+ADD-TAGS
+^^^^^^^^
+
+**add-tags** [\--from *file*] {*tag*...}
+
+Add tags to the cluster. If any of the tags contains invalid
+characters, the entire operation will abort.
+
+If the ``--from`` option is given, the list of tags will be
+extended with the contents of that file (each line becomes a tag).
+In this case, there is not need to pass tags on the command line
+(if you do, both sources will be used). A file name of - will be
+interpreted as stdin.
+
+LIST-TAGS
+^^^^^^^^^
+
+**list-tags**
+
+List the tags of the cluster.
+
+REMOVE-TAGS
+^^^^^^^^^^^
+
+**remove-tags** [\--from *file*] {*tag*...}
+
+Remove tags from the cluster. If any of the tags are not existing
+on the cluster, the entire operation will abort.
+
+If the ``--from`` option is given, the list of tags to be removed will
+be extended with the contents of that file (each line becomes a tag).
+In this case, there is not need to pass tags on the command line (if
+you do, tags from both sources will be removed). A file name of - will
+be interpreted as stdin.
+
+SEARCH-TAGS
+^^^^^^^^^^^
+
+**search-tags** {*pattern*}
+
+Searches the tags on all objects in the cluster (the cluster
+itself, the nodes and the instances) for a given pattern. The
+pattern is interpreted as a regular expression and a search will be
+done on it (i.e. the given pattern is not anchored to the beggining
+of the string; if you want that, prefix the pattern with ^).
+
+If no tags are matching the pattern, the exit code of the command
+will be one. If there is at least one match, the exit code will be
+zero. Each match is listed on one line, the object and the tag
+separated by a space. The cluster will be listed as /cluster, a
+node will be listed as /nodes/*name*, and an instance as
+/instances/*name*. Example:
+
+::
+
+ # gnt-cluster search-tags time
+ /cluster ctime:2007-09-01
+ /nodes/node1.example.com mtime:2007-10-04
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: