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} *secondary\_ip*]
27 | [{-g|\--node-group} *nodegroup*]
28 | [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``]
29 | [\--node-parameters *ndparams*]
30 | [\--disk-state *diskstate*]
31 | [\--hypervisor-state *hvstate*]
34 Adds the given node to the cluster.
36 This command is used to join a new node to the cluster. You will
37 have to provide the password for root of the node to be able to add
38 the node in the cluster. The command needs to be run on the Ganeti
41 Note that the command is potentially destructive, as it will
42 forcibly join the specified host to the cluster, not paying attention
43 to its current status (it could be already in a cluster, etc.)
45 The ``-s (--secondary-ip)`` is used in dual-home clusters and
46 specifies the new node's IP in the secondary network. See the
47 discussion in **gnt-cluster**\(8) for more information.
49 In case you're readding a node after hardware failure, you can use
50 the ``--readd`` parameter. In this case, you don't need to pass the
51 secondary IP again, it will be reused from the cluster. Also, the
52 drained and offline flags of the node will be cleared before
55 The ``-g (--node-group)`` option is used to add the new node into a
56 specific node group, specified by UUID or name. If only one node group
57 exists you can skip this option, otherwise it's mandatory.
59 The ``vm_capable``, ``master_capable``, ``ndparams``, ``diskstate`` and
60 ``hvstate`` options are described in **ganeti**\(7), and are used to set
61 the properties of the new node.
63 The command performs some operations that change the state of the master
64 and the new node, like copying certificates and starting the node daemon
65 on the new node, or updating ``/etc/hosts`` on the master node. If the
66 command fails at a later stage, it doesn't undo such changes. This
67 should not be a problem, as a successful run of ``gnt-node add`` will
68 bring everything back in sync.
70 If the node was previously part of another cluster and still has daemons
71 running, the ``node-cleanup`` tool can be run on the machine to be added
72 to clean remains of the previous cluster from the node.
76 # gnt-node add node5.example.com
77 # gnt-node add -s 192.0.2.5 node5.example.com
78 # gnt-node add -g group2 -s 192.0.2.9 node9.group2.example.com
84 | **evacuate** [-f] [\--early-release] [\--submit] [\--print-job-id]
85 | [{-I|\--iallocator} *NAME* \| {-n|\--new-secondary} *destination\_node*]
86 | [{-p|\--primary-only} \| {-s|\--secondary-only} ]
89 This command will move instances away from the given node. If
90 ``--primary-only`` is given, only primary instances are evacuated, with
91 ``--secondary-only`` only secondaries. If neither is given, all
92 instances are evacuated. It works only for instances having a drbd disk
95 The new location for the instances can be specified in two ways:
97 - as a single node for all instances, via the ``-n (--new-secondary)``
100 - or via the ``-I (--iallocator)`` option, giving a script name as
101 parameter (or ``.`` to use the default allocator), so each instance
102 will be in turn placed on the (per the script) optimal node
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
114 Note that this command is equivalent to using per-instance commands for
115 each affected instance individually:
117 - ``--primary-only`` is equivalent to performing ``gnt-instance
118 migrate`` for every primary instance running on the node that can be
119 migrated and ``gnt-instance failover`` for every primary instance that
121 - ``--secondary-only`` is equivalent to ``gnt-instance replace-disks``
122 in secondary node change mode (``--new-secondary``) for every DRBD
123 instance that the node is a secondary for.
124 - when neither of the above is done a combination of the two cases is run
126 Note that the iallocator currently only considers disk information of
127 the default disk template, even if the instance's disk templates differ
130 See **ganeti**\(7) for a description of ``--submit`` and other common
135 # gnt-node evacuate -I hail node3.example.com
137 Note that, due to an issue with the iallocator interface, evacuation of
138 all instances at once is not yet implemented. Full evacuation can
139 currently be achieved by sequentially evacuating primaries and
143 # gnt-node evacuate -p node3.example.com
144 # gnt-node evacuate -s node3.example.com
150 **failover** [-f] [\--ignore-consistency] {*node*}
152 This command will fail over all instances having the given node as
153 primary to their secondary nodes. This works only for instances having
154 a drbd disk template.
156 Normally the failover will check the consistency of the disks before
157 failing over the instance. If you are trying to migrate instances off
158 a dead node, this will fail. Use the ``--ignore-consistency`` option
163 # gnt-node failover node1.example.com
171 Show detailed information about the nodes in the cluster. If you
172 don't give any arguments, all nodes will be shows, otherwise the
173 output will be restricted to the given names.
179 | [\--no-headers] [\--separator=*SEPARATOR*]
180 | [\--units=*UNITS*] [-v] [{-o|\--output} *[+]FIELD,...*]
184 Lists the nodes in the cluster.
186 The ``--no-headers`` option will skip the initial header line. The
187 ``--separator`` option takes an argument which denotes what will be
188 used between the output fields. Both these options are to help
191 The units used to display the numeric values in the output varies,
192 depending on the options given. By default, the values will be
193 formatted in the most appropriate unit. If the ``--separator``
194 option is given, then the values are shown in mebibytes to allow
195 parsing by scripts. In both cases, the ``--units`` option can be
196 used to enforce a given output unit.
198 Queries of nodes will be done in parallel with any running jobs. This might
199 give inconsistent results for the free disk/memory.
201 The ``-v`` option activates verbose mode, which changes the display of
202 special field states (see **ganeti**\(7)).
204 The ``-o (--output)`` option takes a comma-separated list of output
205 fields. The available fields and their meaning are:
209 If the value of the option starts with the character ``+``, the new
210 fields will be added to the default list. This allows one to quickly
211 see the default list plus a few other fields, instead of retyping
212 the entire list of fields.
214 Note that some of these fields are known from the configuration of the
215 cluster (e.g. ``name``, ``pinst``, ``sinst``, ``pip``, ``sip``) and thus
216 the master does not need to contact the node for this data (making the
217 listing fast if only fields from this set are selected), whereas the
218 other fields are "live" fields and require a query to the cluster nodes.
220 Depending on the virtualization type and implementation details, the
221 ``mtotal``, ``mnode`` and ``mfree`` fields may have slightly varying
222 meanings. For example, some solutions share the node memory with the
223 pool of memory used for instances (KVM), whereas others have separate
224 memory for the node and for the instances (Xen).
226 Note that the field 'dtotal' and 'dfree' refer to the storage type
227 that is defined by the default disk template. The default disk template
228 is the first on in the list of cluster-wide enabled disk templates and
229 can be set with ``gnt-cluster modify``. Currently, only the disk
230 templates 'plain', 'drbd', 'file', and 'sharedfile' support storage
231 reporting, for all others '0' is displayed.
233 If exactly one argument is given and it appears to be a query filter
234 (see **ganeti**\(7)), the query result is filtered accordingly. For
235 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
236 (``-F``) option forces the argument to be treated as a filter (e.g.
237 ``gnt-node list -F master_candidate``).
239 If no node names are given, then all nodes are queried. Otherwise,
240 only the given nodes will be listed.
246 **list-drbd** [\--no-headers] [\--separator=*SEPARATOR*] node
248 Lists the mapping of DRBD minors for a given node. This outputs a static
249 list of fields (it doesn't accept the ``--output`` option), as follows:
252 The (full) name of the node we are querying
256 The instance the DRBD minor belongs to
258 The disk index that the DRBD minor belongs to
260 Either ``primary`` or ``secondary``, denoting the role of the node for
261 the instance (note: this is not the live status of the DRBD device,
262 but the configuration value)
264 The node that the minor is connected to on the other end
266 This command can be used as a reverse lookup (from node and minor) to a
267 given instance, which can be useful when debugging DRBD issues.
269 Note that this command queries Ganeti via **ganeti-confd**\(8), so
270 it won't be available if support for ``confd`` has not been enabled at
271 build time; furthermore, in Ganeti 2.6 this is only available via the
272 Haskell version of confd (again selected at build time).
277 **list-fields** [field...]
279 Lists available fields for nodes.
285 | **migrate** [-f] [\--non-live] [\--migration-mode=live\|non-live]
286 | [\--ignore-ipolicy] [\--submit] [\--print-job-id] {*node*}
288 This command will migrate all instances having the given node as
289 primary to their secondary nodes. This works only for instances
290 having a drbd disk template.
292 As for the **gnt-instance migrate** command, the options
293 ``--no-live``, ``--migration-mode`` and ``--no-runtime-changes``
294 can be given to influence the migration type.
296 If ``--ignore-ipolicy`` is given any instance policy violations
297 occurring during this operation are ignored.
299 See **ganeti**\(7) for a description of ``--submit`` and other common
304 # gnt-node migrate node1.example.com
310 | **modify** [-f] [\--submit] [\--print-job-id]
311 | [{-C|\--master-candidate} ``yes|no``]
312 | [{-D|\--drained} ``yes|no``] [{-O|\--offline} ``yes|no``]
313 | [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``] [\--auto-promote]
314 | [{-s|\--secondary-ip} *secondary_ip*]
315 | [\--node-parameters *ndparams*]
316 | [\--node-powered=``yes|no``]
317 | [\--hypervisor-state *hvstate*]
318 | [\--disk-state *diskstate*]
321 This command changes the role of the node. Each options takes
322 either a literal yes or no, and only one option should be given as
323 yes. The meaning of the roles and flags are described in the
324 manpage **ganeti**\(7).
326 The option ``--node-powered`` can be used to modify state-of-record if
327 it doesn't reflect the reality anymore.
329 In case a node is demoted from the master candidate role, the
330 operation will be refused unless you pass the ``--auto-promote``
331 option. This option will cause the operation to lock all cluster nodes
332 (thus it will not be able to run in parallel with most other jobs),
333 but it allows automated maintenance of the cluster candidate pool. If
334 locking all cluster node is too expensive, another option is to
335 promote manually another node to master candidate before demoting the
338 Example (setting a node offline, which will demote it from master
339 candidate role if is in that role)::
341 # gnt-node modify --offline=yes node1.example.com
343 The ``-s (--secondary-ip)`` option can be used to change the node's
344 secondary ip. No drbd instances can be running on the node, while this
345 operation is taking place. Remember that the secondary ip must be
346 reachable from the master secondary ip, when being changed, so be sure
347 that the node has the new IP already configured and active. In order to
348 convert a cluster from single homed to multi-homed or vice versa
349 ``--force`` is needed as well, and the target node for the first change
352 See **ganeti**\(7) for a description of ``--submit`` and other common
355 Example (setting the node back to online and master candidate)::
357 # gnt-node modify --offline=no --master-candidate=yes node1.example.com
363 **remove** {*nodename*}
365 Removes a node from the cluster. Instances must be removed or
366 migrated to another cluster before.
370 # gnt-node remove node5.example.com
376 | **volumes** [\--no-headers] [\--human-readable]
377 | [\--separator=*SEPARATOR*] [{-o|\--output} *FIELDS*]
380 Lists all logical volumes and their physical disks from the node(s)
383 The ``--no-headers`` option will skip the initial header line. The
384 ``--separator`` option takes an argument which denotes what will be
385 used between the output fields. Both these options are to help
388 The units used to display the numeric values in the output varies,
389 depending on the options given. By default, the values will be
390 formatted in the most appropriate unit. If the ``--separator``
391 option is given, then the values are shown in mebibytes to allow
392 parsing by scripts. In both cases, the ``--units`` option can be
393 used to enforce a given output unit.
395 The ``-o (--output)`` option takes a comma-separated list of output
396 fields. The available fields and their meaning are:
399 the node name on which the volume exists
402 the physical drive (on which the LVM physical volume lives)
405 the volume group name
408 the logical volume name
411 the logical volume size
414 The name of the instance to which this volume belongs, or (in case
415 it's an orphan volume) the character "-"
420 # gnt-node volumes node5.example.com
421 Node PhysDev VG Name Size Instance
422 node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128 instance1.example.com
423 node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256 instance1.example.com
429 | **list-storage** [\--no-headers] [\--human-readable]
430 | [\--separator=*SEPARATOR*] [\--storage-type=*STORAGE\_TYPE*]
431 | [{-o|\--output} *FIELDS*]
434 Lists the available storage units and their details for the given
437 The ``--no-headers`` option will skip the initial header line. The
438 ``--separator`` option takes an argument which denotes what will be
439 used between the output fields. Both these options are to help
442 The units used to display the numeric values in the output varies,
443 depending on the options given. By default, the values will be
444 formatted in the most appropriate unit. If the ``--separator``
445 option is given, then the values are shown in mebibytes to allow
446 parsing by scripts. In both cases, the ``--units`` option can be
447 used to enforce a given output unit.
449 The ``--storage-type`` option can be used to choose a storage unit
450 type. Possible choices are lvm-pv, lvm-vg or file.
452 The ``-o (--output)`` option takes a comma-separated list of output
453 fields. The available fields and their meaning are:
456 the node name on which the volume exists
459 the type of the storage unit (currently just what is passed in via
463 the path/identifier of the storage unit
466 total size of the unit; for the file type see a note below
469 used space in the unit; for the file type see a note below
475 whether we the unit is available for allocation (only lvm-pv can
476 change this setting, the other types always report true)
479 Note that for the "file" type, the total disk space might not equal
480 to the sum of used and free, due to the method Ganeti uses to
481 compute each of them. The total and free values are computed as the
482 total and free space values for the filesystem to which the
483 directory belongs, but the used space is computed from the used
484 space under that directory *only*, which might not be necessarily
485 the root of the filesystem, and as such there could be files
486 outside the file storage directory using disk space and causing a
487 mismatch in the values.
491 node1# gnt-node list-storage node2
492 Node Type Name Size Used Free Allocatable
493 node2 lvm-pv /dev/sda7 673.8G 1.5G 672.3G Y
494 node2 lvm-pv /dev/sdb1 698.6G 0M 698.6G Y
500 | **modify-storage** [\--allocatable={yes|no}] [\--submit] [\--print-job-id]
501 | {*node*} {*storage-type*} {*volume-name*}
503 Modifies storage volumes on a node. Only LVM physical volumes can
504 be modified at the moment. They have a storage type of "lvm-pv".
508 # gnt-node modify-storage --allocatable no node5.example.com lvm-pv /dev/sdb1
514 | **repair-storage** [\--ignore-consistency] ]\--submit]
515 | {*node*} {*storage-type*} {*volume-name*}
517 Repairs a storage volume on a node. Only LVM volume groups can be
518 repaired at this time. They have the storage type "lvm-vg".
520 On LVM volume groups, **repair-storage** runs ``vgreduce
525 **Caution:** Running this command can lead to data loss. Use it with
528 The ``--ignore-consistency`` option will ignore any inconsistent
529 disks (on the nodes paired with this one). Use of this option is
530 most likely to lead to data-loss.
534 # gnt-node repair-storage node5.example.com lvm-vg xenvg
540 **powercycle** [\--yes] [\--force] [\--submit] [\--print-job-id] {*node*}
542 This command (tries to) forcefully reboot a node. It is a command
543 that can be used if the node environment is broken, such that the
544 admin can no longer login over SSH, but the Ganeti node daemon is
547 Note that this command is not guaranteed to work; it depends on the
548 hypervisor how effective is the reboot attempt. For Linux, this
549 command requires the kernel option ``CONFIG_MAGIC_SYSRQ`` to be
552 The ``--yes`` option can be used to skip confirmation, while the
553 ``--force`` option is needed if the target node is the master
556 See **ganeti**\(7) for a description of ``--submit`` and other common
562 **power** [``--force``] [``--ignore-status``] [``--all``]
563 [``--power-delay``] on|off|cycle|status [*nodes*]
565 This command calls out to out-of-band management to change the power
566 state of given node. With ``status`` you get the power status as reported
567 by the out-of-band management script.
569 Note that this command will only work if the out-of-band functionality
570 is configured and enabled on the cluster. If this is not the case,
571 please use the **powercycle** command above.
573 Using ``--force`` you skip the confirmation to do the operation.
574 Currently this only has effect on ``off`` and ``cycle``. On those two
575 you can *not* operate on the master. However, the command will provide
576 you with the command to invoke to operate on the master nerver-mind.
577 This is considered harmful and Ganeti does not support the use of it.
579 Providing ``--ignore-status`` will ignore the offline=N state of a node
580 and continue with power off.
582 ``--power-delay`` specifies the time in seconds (factions allowed)
583 waited between powering on the next node. This is by default 2 seconds
584 but can increased if needed with this option.
586 *nodes* are optional. If not provided it will call out for every node in
587 the cluster. Except for the ``off`` and ``cycle`` command where you've
588 to explicit use ``--all`` to select all.
596 This command calls out to out-of-band management to ask for the health status
597 of all or given nodes. The health contains the node name and then the items
598 element with their status in a ``item=status`` manner. Where ``item`` is script
599 specific and ``status`` can be one of ``OK``, ``WARNING``, ``CRITICAL`` or
600 ``UNKNOWN``. Items with status ``WARNING`` or ``CRITICAL`` are logged and
601 annotated in the command line output.
607 | **restricted-command** [-M] [\--sync]
608 | { -g *group* *command* | *command* *nodes*... }
610 Executes a restricted command on the specified nodes. Restricted commands are
611 not arbitrary, but must reside in
612 ``@SYSCONFDIR@/ganeti/restricted-commands`` on a node, either as a regular
613 file or as a symlink. The directory must be owned by root and not be
614 world- or group-writable. If a command fails verification or otherwise
615 fails to start, the node daemon log must be consulted for more detailed
618 Example for running a command on two nodes::
620 # gnt-node restricted-command mycommand \
621 node1.example.com node2.example.com
623 The ``-g`` option can be used to run a command only on a specific node
626 # gnt-node restricted-command -g default mycommand
628 The ``-M`` option can be used to prepend the node name to all command
629 output lines. ``--sync`` forces the opcode to acquire the node lock(s)
638 **add-tags** [\--from *file*] {*nodename*} {*tag*...}
640 Add tags to the given node. If any of the tags contains invalid
641 characters, the entire operation will abort.
643 If the ``--from`` option is given, the list of tags will be
644 extended with the contents of that file (each line becomes a tag).
645 In this case, there is not need to pass tags on the command line
646 (if you do, both sources will be used). A file name of - will be
647 interpreted as stdin.
652 **list-tags** {*nodename*}
654 List the tags of the given node.
659 **remove-tags** [\--from *file*] {*nodename*} {*tag*...}
661 Remove tags from the given node. If any of the tags are not
662 existing on the node, the entire operation will abort.
664 If the ``--from`` option is given, the list of tags to be removed will
665 be extended with the contents of that file (each line becomes a tag).
666 In this case, there is not need to pass tags on the command line (if
667 you do, tags from both sources will be removed). A file name of - will
668 be interpreted as stdin.
670 .. vim: set textwidth=72 :