1 gnt-node(8) Ganeti | Version @GANETI_VERSION@
2 =============================================
7 gnt-node - Node administration
12 **gnt-node** {command} [arguments...]
17 The **gnt-node** is used for managing the (physical) nodes in the
26 | **add** [--readd] [-s *secondary\_ip*] [-g *nodegroup*]
27 | [--master-capable=``yes|no``] [--vm-capable=``yes|no``]
28 | [--node-parameters *ndparams*]
31 Adds the given node to the cluster.
33 This command is used to join a new node to the cluster. You will
34 have to provide the password for root of the node to be able to add
35 the node in the cluster. The command needs to be run on the Ganeti
38 Note that the command is potentially destructive, as it will
39 forcibly join the specified host the cluster, not paying attention
40 to its current status (it could be already in a cluster, etc.)
42 The ``-s`` is used in dual-home clusters and specifies the new node's
43 IP in the secondary network. See the discussion in **gnt-cluster**(8)
46 In case you're readding a node after hardware failure, you can use
47 the ``--readd`` parameter. In this case, you don't need to pass the
48 secondary IP again, it will reused from the cluster. Also, the
49 drained and offline flags of the node will be cleared before
52 The ``--force-join`` option is to proceed with adding a node even if it already
53 appears to belong to another cluster. This is used during cluster merging, for
56 The ``-g`` is used to add the new node into a specific node group,
57 specified by UUID or name. If only one node group exists you can
58 skip this option, otherwise it's mandatory.
60 The ``vm_capable``, ``master_capable`` and ``ndparams`` options are
61 described in **ganeti**(7), and are used to set the properties of the
66 # gnt-node add node5.example.com
67 # gnt-node add -s 192.0.2.5 node5.example.com
68 # gnt-node add -g group2 -s 192.0.2.9 node9.group2.example.com
74 **add-tags** [--from *file*] {*nodename*} {*tag*...}
76 Add tags to the given node. If any of the tags contains invalid
77 characters, the entire operation will abort.
79 If the ``--from`` option is given, the list of tags will be
80 extended with the contents of that file (each line becomes a tag).
81 In this case, there is not need to pass tags on the command line
82 (if you do, both sources will be used). A file name of - will be
88 **evacuate** [-f] [--early-release] [--iallocator *NAME* \|
89 --new-secondary *destination\_node*] {*node*...}
91 This command will move all secondary instances away from the given
92 node(s). It works only for instances having a drbd disk template.
94 The new location for the instances can be specified in two ways:
96 - as a single node for all instances, via the ``--new-secondary``
99 - or via the ``--iallocator`` option, giving a script name as
100 parameter, so each instance will be in turn placed on the (per the
104 The ``--early-release`` changes the code so that the old storage on
105 node being evacuated is removed early (before the resync is
106 completed) and the internal Ganeti locks are also released for both
107 the current secondary and the new secondary, thus allowing more
108 parallelism in the cluster operation. This should be used only when
109 recovering from a disk failure on the current secondary (thus the
110 old storage is already broken) or when the storage on the primary
111 node is known to be fine (thus we won't need the old storage for
116 # gnt-node evacuate -I dumb node3.example.com
122 **failover** [-f] [--ignore-consistency] {*node*}
124 This command will fail over all instances having the given node as
125 primary to their secondary nodes. This works only for instances having
126 a drbd disk template.
128 Normally the failover will check the consistency of the disks before
129 failing over the instance. If you are trying to migrate instances off
130 a dead node, this will fail. Use the ``--ignore-consistency`` option
135 # gnt-node failover node1.example.com
143 Show detailed information about the nodes in the cluster. If you
144 don't give any arguments, all nodes will be shows, otherwise the
145 output will be restricted to the given names.
151 | [--no-headers] [--separator=*SEPARATOR*]
152 | [--units=*UNITS*] [-v] [-o *[+]FIELD,...*]
155 Lists the nodes in the cluster.
157 The ``--no-headers`` option will skip the initial header line. The
158 ``--separator`` option takes an argument which denotes what will be
159 used between the output fields. Both these options are to help
162 The units used to display the numeric values in the output varies,
163 depending on the options given. By default, the values will be
164 formatted in the most appropriate unit. If the ``--separator``
165 option is given, then the values are shown in mebibytes to allow
166 parsing by scripts. In both cases, the ``--units`` option can be
167 used to enforce a given output unit.
169 Queries of nodes will be done in parallel with any running jobs. This might
170 give inconsistent results for the free disk/memory.
172 The ``-v`` option activates verbose mode, which changes the display of
173 special field states (see **ganeti(7)**).
175 The ``-o`` option takes a comma-separated list of output fields.
176 The available fields and their meaning are:
180 If the value of the option starts with the character ``+``, the new
181 fields will be added to the default list. This allows to quickly
182 see the default list plus a few other fields, instead of retyping
183 the entire list of fields.
185 Note that some of this fields are known from the configuration of
186 the cluster (e.g. name, pinst, sinst, pip, sip and thus the master
187 does not need to contact the node for this data (making the listing
188 fast if only fields from this set are selected), whereas the other
189 fields are "live" fields and we need to make a query to the cluster
192 Depending on the virtualization type and implementation details,
193 the mtotal, mnode and mfree may have slighly varying meanings. For
194 example, some solutions share the node memory with the pool of
195 memory used for instances (KVM), whereas others have separate
196 memory for the node and for the instances (Xen).
198 If no node names are given, then all nodes are queried. Otherwise,
199 only the given nodes will be listed.
205 **list-fields** [field...]
207 Lists available fields for nodes.
213 **list-tags** {*nodename*}
215 List the tags of the given node.
220 **migrate** [-f] [--non-live] [--migration-mode=live\|non-live]
223 This command will migrate all instances having the given node as
224 primary to their secondary nodes. This works only for instances
225 having a drbd disk template.
227 As for the **gnt-instance migrate** command, the options
228 ``--no-live`` and ``--migration-mode`` can be given to influence
233 # gnt-node migrate node1.example.com
239 | **modify** [-f] [--submit]
240 | [--master-candidate=``yes|no``] [--drained=``yes|no``] [--offline=``yes|no``]
241 | [--master-capable=``yes|no``] [--vm-capable=``yes|no``] [--auto-promote]
242 | [-s *secondary_ip*]
243 | [--node-parameters *ndparams*]
244 | [--node-powered=``yes|no``]
247 This command changes the role of the node. Each options takes
248 either a literal yes or no, and only one option should be given as
249 yes. The meaning of the roles and flags are described in the
250 manpage **ganeti**(7).
252 ``--node-powered`` can be used to modify state-of-record if it doesn't reflect
255 In case a node is demoted from the master candidate role, the
256 operation will be refused unless you pass the ``--auto-promote``
257 option. This option will cause the operation to lock all cluster nodes
258 (thus it will not be able to run in parallel with most other jobs),
259 but it allows automated maintenance of the cluster candidate pool. If
260 locking all cluster node is too expensive, another option is to
261 promote manually another node to master candidate before demoting the
264 Example (setting a node offline, which will demote it from master
265 candidate role if is in that role)::
267 # gnt-node modify --offline=yes node1.example.com
269 The ``-s`` can be used to change the node's secondary ip. No drbd
270 instances can be running on the node, while this operation is
273 Example (setting the node back to online and master candidate)::
275 # gnt-node modify --offline=no --master-candidate=yes node1.example.com
281 **remove** {*nodename*}
283 Removes a node from the cluster. Instances must be removed or
284 migrated to another cluster before.
288 # gnt-node remove node5.example.com
294 **remove-tags** [--from *file*] {*nodename*} {*tag*...}
296 Remove tags from the given node. If any of the tags are not
297 existing on the node, the entire operation will abort.
299 If the ``--from`` option is given, the list of tags to be removed will
300 be extended with the contents of that file (each line becomes a tag).
301 In this case, there is not need to pass tags on the command line (if
302 you do, tags from both sources will be removed). A file name of - will
303 be interpreted as stdin.
308 | **volumes** [--no-headers] [--human-readable]
309 | [--separator=*SEPARATOR*] [--output=*FIELDS*]
312 Lists all logical volumes and their physical disks from the node(s)
315 The ``--no-headers`` option will skip the initial header line. The
316 ``--separator`` option takes an argument which denotes what will be
317 used between the output fields. Both these options are to help
320 The units used to display the numeric values in the output varies,
321 depending on the options given. By default, the values will be
322 formatted in the most appropriate unit. If the ``--separator``
323 option is given, then the values are shown in mebibytes to allow
324 parsing by scripts. In both cases, the ``--units`` option can be
325 used to enforce a given output unit.
327 The ``-o`` option takes a comma-separated list of output fields.
328 The available fields and their meaning are:
331 the node name on which the volume exists
334 the physical drive (on which the LVM physical volume lives)
337 the volume group name
340 the logical volume name
343 the logical volume size
346 The name of the instance to which this volume belongs, or (in case
347 it's an orphan volume) the character "-"
352 # gnt-node volumes node5.example.com
353 Node PhysDev VG Name Size Instance
354 node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128 instance1.example.com
355 node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256 instance1.example.com
361 | **list-storage** [--no-headers] [--human-readable]
362 | [--separator=*SEPARATOR*] [--storage-type=*STORAGE\_TYPE*]
363 | [--output=*FIELDS*]
366 Lists the available storage units and their details for the given
369 The ``--no-headers`` option will skip the initial header line. The
370 ``--separator`` option takes an argument which denotes what will be
371 used between the output fields. Both these options are to help
374 The units used to display the numeric values in the output varies,
375 depending on the options given. By default, the values will be
376 formatted in the most appropriate unit. If the ``--separator``
377 option is given, then the values are shown in mebibytes to allow
378 parsing by scripts. In both cases, the ``--units`` option can be
379 used to enforce a given output unit.
381 The ``--storage-type`` option can be used to choose a storage unit
382 type. Possible choices are lvm-pv, lvm-vg or file.
384 The ``-o`` option takes a comma-separated list of output fields.
385 The available fields and their meaning are:
388 the node name on which the volume exists
391 the type of the storage unit (currently just what is passed in via
395 the path/identifier of the storage unit
398 total size of the unit; for the file type see a note below
401 used space in the unit; for the file type see a note below
407 whether we the unit is available for allocation (only lvm-pv can
408 change this setting, the other types always report true)
411 Note that for the "file" type, the total disk space might not equal
412 to the sum of used and free, due to the method Ganeti uses to
413 compute each of them. The total and free values are computed as the
414 total and free space values for the filesystem to which the
415 directory belongs, but the used space is computed from the used
416 space under that directory *only*, which might not be necessarily
417 the root of the filesystem, and as such there could be files
418 outside the file storage directory using disk space and causing a
419 mismatch in the values.
423 node1# gnt-node list-storage node2
424 Node Type Name Size Used Free Allocatable
425 node2 lvm-pv /dev/sda7 673.8G 1.5G 672.3G Y
426 node2 lvm-pv /dev/sdb1 698.6G 0M 698.6G Y
432 **modify-storage** [``--allocatable=yes|no``]
433 {*node*} {*storage-type*} {*volume-name*}
435 Modifies storage volumes on a node. Only LVM physical volumes can
436 be modified at the moment. They have a storage type of "lvm-pv".
440 # gnt-node modify-storage --allocatable no node5.example.com lvm-pv /dev/sdb1
446 **repair-storage** [--ignore-consistency] {*node*} {*storage-type*}
449 Repairs a storage volume on a node. Only LVM volume groups can be
450 repaired at this time. They have the storage type "lvm-vg".
452 On LVM volume groups, **repair-storage** runs "vgreduce
457 **Caution:** Running this command can lead to data loss. Use it with
460 The ``--ignore-consistency`` option will ignore any inconsistent
461 disks (on the nodes paired with this one). Use of this option is
462 most likely to lead to data-loss.
466 # gnt-node repair-storage node5.example.com lvm-vg xenvg
472 **powercycle** [``--yes``] [``--force``] {*node*}
474 This commands (tries to) forcefully reboot a node. It is a command
475 that can be used if the node environemnt is broken, such that the
476 admin can no longer login over ssh, but the Ganeti node daemon is
479 Note that this command is not guaranteed to work; it depends on the
480 hypervisor how effective is the reboot attempt. For Linux, this
481 command require that the kernel option CONFIG\_MAGIC\_SYSRQ is
484 The ``--yes`` option can be used to skip confirmation, while the
485 ``--force`` option is needed if the target node is the master
491 **power** [``--force``] [``--ignore-status``] [``--all``]
492 on|off|cycle|status [*nodes*]
494 This commands calls out to out-of-band management to change the power
495 state of given node. With ``status`` you get the power status as reported
496 by the out-of-band management script.
498 Using ``--force`` you skip the confirmation to do the operation. Currently this
499 only has effect on ``off`` and ``cycle``. On those two you can *not* operate on
500 the master. However, the command will provide you with the command to invoke to
501 operate on the master nerver-mind. This is considered harmful and Ganeti does
502 not support the use of it.
504 Providing ``--ignore-status`` will ignore the offline=N state of a node and
505 continue with power off.
507 *nodes* are optional. If not provided it will call out for every node in the
508 cluster. Except for the ``off`` and ``cycle`` command where you've to explicit
509 use ``-all`` to select all.
516 This commands calls out to out-pf-band management to ask for the health status
517 of all or given nodes. The health contains the node name and then the items
518 element with their status in a ``item=status`` manner. Where ``item`` is script
519 specific and ``status`` can be one of ``OK``, ``WARNING``, ``CRITICAL`` or
520 ``UNKNOWN``. Items with status ``WARNING`` or ``CRITICAL`` are logged and
521 annotated in the command line output.