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 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 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]
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 ``gnt-instance
118 failover/migration`` for non-DRBD instances, but for DRBD instances
119 it's different, and usually is a slow process (it will change the
120 primary to another node while keeping the secondary, this requiring
121 data copies, whereas failover/migrate will only toggle the
122 primary/secondary roles, a fast process)
123 - ``--secondary-only`` is equivalent to ``gnt-instance replace-disks``
124 in the secondary node change mode (only valid for DRBD instances)
125 - when neither of the above is done a combination of the two cases is run
127 See **ganeti**\(7) for a description of ``--submit`` and other common
132 # gnt-node evacuate -I hail node3.example.com
138 **failover** [-f] [\--ignore-consistency] {*node*}
140 This command will fail over all instances having the given node as
141 primary to their secondary nodes. This works only for instances having
142 a drbd disk template.
144 Normally the failover will check the consistency of the disks before
145 failing over the instance. If you are trying to migrate instances off
146 a dead node, this will fail. Use the ``--ignore-consistency`` option
151 # gnt-node failover node1.example.com
159 Show detailed information about the nodes in the cluster. If you
160 don't give any arguments, all nodes will be shows, otherwise the
161 output will be restricted to the given names.
167 | [\--no-headers] [\--separator=*SEPARATOR*]
168 | [\--units=*UNITS*] [-v] [{-o|\--output} *[+]FIELD,...*]
172 Lists the nodes in the cluster.
174 The ``--no-headers`` option will skip the initial header line. The
175 ``--separator`` option takes an argument which denotes what will be
176 used between the output fields. Both these options are to help
179 The units used to display the numeric values in the output varies,
180 depending on the options given. By default, the values will be
181 formatted in the most appropriate unit. If the ``--separator``
182 option is given, then the values are shown in mebibytes to allow
183 parsing by scripts. In both cases, the ``--units`` option can be
184 used to enforce a given output unit.
186 Queries of nodes will be done in parallel with any running jobs. This might
187 give inconsistent results for the free disk/memory.
189 The ``-v`` option activates verbose mode, which changes the display of
190 special field states (see **ganeti**\(7)).
192 The ``-o (--output)`` option takes a comma-separated list of output
193 fields. The available fields and their meaning are:
197 If the value of the option starts with the character ``+``, the new
198 fields will be added to the default list. This allows one to quickly
199 see the default list plus a few other fields, instead of retyping
200 the entire list of fields.
202 Note that some of these fields are known from the configuration of the
203 cluster (e.g. ``name``, ``pinst``, ``sinst``, ``pip``, ``sip``) and thus
204 the master does not need to contact the node for this data (making the
205 listing fast if only fields from this set are selected), whereas the
206 other fields are "live" fields and require a query to the cluster nodes.
208 Depending on the virtualization type and implementation details, the
209 ``mtotal``, ``mnode`` and ``mfree`` fields may have slightly varying
210 meanings. For example, some solutions share the node memory with the
211 pool of memory used for instances (KVM), whereas others have separate
212 memory for the node and for the instances (Xen).
214 If exactly one argument is given and it appears to be a query filter
215 (see **ganeti**\(7)), the query result is filtered accordingly. For
216 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
217 (``-F``) option forces the argument to be treated as a filter (e.g.
218 ``gnt-node list -F master_candidate``).
220 If no node names are given, then all nodes are queried. Otherwise,
221 only the given nodes will be listed.
227 **list-drbd** [\--no-headers] [\--separator=*SEPARATOR*] node
229 Lists the mapping of DRBD minors for a given node. This outputs a static
230 list of fields (it doesn't accept the ``--output`` option), as follows:
233 The (full) name of the node we are querying
237 The instance the DRBD minor belongs to
239 The disk index that the DRBD minor belongs to
241 Either ``primary`` or ``secondary``, denoting the role of the node for
242 the instance (note: this is not the live status of the DRBD device,
243 but the configuration value)
245 The node that the minor is connected to on the other end
247 This command can be used as a reverse lookup (from node and minor) to a
248 given instance, which can be useful when debugging DRBD issues.
250 Note that this command queries Ganeti via **ganeti-confd**\(8), so
251 it won't be available if support for ``confd`` has not been enabled at
252 build time; furthermore, in Ganeti 2.6 this is only available via the
253 Haskell version of confd (again selected at build time).
258 **list-fields** [field...]
260 Lists available fields for nodes.
266 | **migrate** [-f] [\--non-live] [\--migration-mode=live\|non-live]
267 | [\--ignore-ipolicy] [\--submit] {*node*}
269 This command will migrate all instances having the given node as
270 primary to their secondary nodes. This works only for instances
271 having a drbd disk template.
273 As for the **gnt-instance migrate** command, the options
274 ``--no-live``, ``--migration-mode`` and ``--no-runtime-changes``
275 can be given to influence the migration type.
277 If ``--ignore-ipolicy`` is given any instance policy violations
278 occurring during this operation are ignored.
280 See **ganeti**\(7) for a description of ``--submit`` and other common
285 # gnt-node migrate node1.example.com
291 | **modify** [-f] [\--submit]
292 | [{-C|\--master-candidate} ``yes|no``]
293 | [{-D|\--drained} ``yes|no``] [{-O|\--offline} ``yes|no``]
294 | [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``] [\--auto-promote]
295 | [{-s|\--secondary-ip} *secondary_ip*]
296 | [\--node-parameters *ndparams*]
297 | [\--node-powered=``yes|no``]
298 | [\--hypervisor-state *hvstate*]
299 | [\--disk-state *diskstate*]
302 This command changes the role of the node. Each options takes
303 either a literal yes or no, and only one option should be given as
304 yes. The meaning of the roles and flags are described in the
305 manpage **ganeti**\(7).
307 The option ``--node-powered`` can be used to modify state-of-record if
308 it doesn't reflect the reality anymore.
310 In case a node is demoted from the master candidate role, the
311 operation will be refused unless you pass the ``--auto-promote``
312 option. This option will cause the operation to lock all cluster nodes
313 (thus it will not be able to run in parallel with most other jobs),
314 but it allows automated maintenance of the cluster candidate pool. If
315 locking all cluster node is too expensive, another option is to
316 promote manually another node to master candidate before demoting the
319 Example (setting a node offline, which will demote it from master
320 candidate role if is in that role)::
322 # gnt-node modify --offline=yes node1.example.com
324 The ``-s (--secondary-ip)`` option can be used to change the node's
325 secondary ip. No drbd instances can be running on the node, while this
326 operation is taking place. Remember that the secondary ip must be
327 reachable from the master secondary ip, when being changed, so be sure
328 that the node has the new IP already configured and active. In order to
329 convert a cluster from single homed to multi-homed or vice versa
330 ``--force`` is needed as well, and the target node for the first change
333 See **ganeti**\(7) for a description of ``--submit`` and other common
336 Example (setting the node back to online and master candidate)::
338 # gnt-node modify --offline=no --master-candidate=yes node1.example.com
344 **remove** {*nodename*}
346 Removes a node from the cluster. Instances must be removed or
347 migrated to another cluster before.
351 # gnt-node remove node5.example.com
357 | **volumes** [\--no-headers] [\--human-readable]
358 | [\--separator=*SEPARATOR*] [{-o|\--output} *FIELDS*]
361 Lists all logical volumes and their physical disks from the node(s)
364 The ``--no-headers`` option will skip the initial header line. The
365 ``--separator`` option takes an argument which denotes what will be
366 used between the output fields. Both these options are to help
369 The units used to display the numeric values in the output varies,
370 depending on the options given. By default, the values will be
371 formatted in the most appropriate unit. If the ``--separator``
372 option is given, then the values are shown in mebibytes to allow
373 parsing by scripts. In both cases, the ``--units`` option can be
374 used to enforce a given output unit.
376 The ``-o (--output)`` option takes a comma-separated list of output
377 fields. The available fields and their meaning are:
380 the node name on which the volume exists
383 the physical drive (on which the LVM physical volume lives)
386 the volume group name
389 the logical volume name
392 the logical volume size
395 The name of the instance to which this volume belongs, or (in case
396 it's an orphan volume) the character "-"
401 # gnt-node volumes node5.example.com
402 Node PhysDev VG Name Size Instance
403 node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128 instance1.example.com
404 node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256 instance1.example.com
410 | **list-storage** [\--no-headers] [\--human-readable]
411 | [\--separator=*SEPARATOR*] [\--storage-type=*STORAGE\_TYPE*]
412 | [{-o|\--output} *FIELDS*]
415 Lists the available storage units and their details for the given
418 The ``--no-headers`` option will skip the initial header line. The
419 ``--separator`` option takes an argument which denotes what will be
420 used between the output fields. Both these options are to help
423 The units used to display the numeric values in the output varies,
424 depending on the options given. By default, the values will be
425 formatted in the most appropriate unit. If the ``--separator``
426 option is given, then the values are shown in mebibytes to allow
427 parsing by scripts. In both cases, the ``--units`` option can be
428 used to enforce a given output unit.
430 The ``--storage-type`` option can be used to choose a storage unit
431 type. Possible choices are lvm-pv, lvm-vg or file.
433 The ``-o (--output)`` option takes a comma-separated list of output
434 fields. The available fields and their meaning are:
437 the node name on which the volume exists
440 the type of the storage unit (currently just what is passed in via
444 the path/identifier of the storage unit
447 total size of the unit; for the file type see a note below
450 used space in the unit; for the file type see a note below
456 whether we the unit is available for allocation (only lvm-pv can
457 change this setting, the other types always report true)
460 Note that for the "file" type, the total disk space might not equal
461 to the sum of used and free, due to the method Ganeti uses to
462 compute each of them. The total and free values are computed as the
463 total and free space values for the filesystem to which the
464 directory belongs, but the used space is computed from the used
465 space under that directory *only*, which might not be necessarily
466 the root of the filesystem, and as such there could be files
467 outside the file storage directory using disk space and causing a
468 mismatch in the values.
472 node1# gnt-node list-storage node2
473 Node Type Name Size Used Free Allocatable
474 node2 lvm-pv /dev/sda7 673.8G 1.5G 672.3G Y
475 node2 lvm-pv /dev/sdb1 698.6G 0M 698.6G Y
481 | **modify-storage** [\--allocatable={yes|no}] [\--submit]
482 | {*node*} {*storage-type*} {*volume-name*}
484 Modifies storage volumes on a node. Only LVM physical volumes can
485 be modified at the moment. They have a storage type of "lvm-pv".
489 # gnt-node modify-storage --allocatable no node5.example.com lvm-pv /dev/sdb1
495 | **repair-storage** [\--ignore-consistency] ]\--submit]
496 | {*node*} {*storage-type*} {*volume-name*}
498 Repairs a storage volume on a node. Only LVM volume groups can be
499 repaired at this time. They have the storage type "lvm-vg".
501 On LVM volume groups, **repair-storage** runs ``vgreduce
506 **Caution:** Running this command can lead to data loss. Use it with
509 The ``--ignore-consistency`` option will ignore any inconsistent
510 disks (on the nodes paired with this one). Use of this option is
511 most likely to lead to data-loss.
515 # gnt-node repair-storage node5.example.com lvm-vg xenvg
521 **powercycle** [\--yes] [\--force] [\--submit] {*node*}
523 This command (tries to) forcefully reboot a node. It is a command
524 that can be used if the node environment is broken, such that the
525 admin can no longer login over SSH, but the Ganeti node daemon is
528 Note that this command is not guaranteed to work; it depends on the
529 hypervisor how effective is the reboot attempt. For Linux, this
530 command requires the kernel option ``CONFIG_MAGIC_SYSRQ`` to be
533 The ``--yes`` option can be used to skip confirmation, while the
534 ``--force`` option is needed if the target node is the master
537 See **ganeti**\(7) for a description of ``--submit`` and other common
543 **power** [``--force``] [``--ignore-status``] [``--all``]
544 [``--power-delay``] on|off|cycle|status [*nodes*]
546 This command calls out to out-of-band management to change the power
547 state of given node. With ``status`` you get the power status as reported
548 by the out-of-band management script.
550 Note that this command will only work if the out-of-band functionality
551 is configured and enabled on the cluster. If this is not the case,
552 please use the **powercycle** command above.
554 Using ``--force`` you skip the confirmation to do the operation.
555 Currently this only has effect on ``off`` and ``cycle``. On those two
556 you can *not* operate on the master. However, the command will provide
557 you with the command to invoke to operate on the master nerver-mind.
558 This is considered harmful and Ganeti does not support the use of it.
560 Providing ``--ignore-status`` will ignore the offline=N state of a node
561 and continue with power off.
563 ``--power-delay`` specifies the time in seconds (factions allowed)
564 waited between powering on the next node. This is by default 2 seconds
565 but can increased if needed with this option.
567 *nodes* are optional. If not provided it will call out for every node in
568 the cluster. Except for the ``off`` and ``cycle`` command where you've
569 to explicit use ``--all`` to select all.
577 This command calls out to out-of-band management to ask for the health status
578 of all or given nodes. The health contains the node name and then the items
579 element with their status in a ``item=status`` manner. Where ``item`` is script
580 specific and ``status`` can be one of ``OK``, ``WARNING``, ``CRITICAL`` or
581 ``UNKNOWN``. Items with status ``WARNING`` or ``CRITICAL`` are logged and
582 annotated in the command line output.
588 | **restricted-command** [-M] [\--sync]
589 | { -g *group* *command* | *command* *nodes*... }
591 Executes a restricted command on the specified nodes. Restricted commands are
592 not arbitrary, but must reside in
593 ``@SYSCONFDIR@/ganeti/restricted-commands`` on a node, either as a regular
594 file or as a symlink. The directory must be owned by root and not be
595 world- or group-writable. If a command fails verification or otherwise
596 fails to start, the node daemon log must be consulted for more detailed
599 Example for running a command on two nodes::
601 # gnt-node restricted-command mycommand \
602 node1.example.com node2.example.com
604 The ``-g`` option can be used to run a command only on a specific node
607 # gnt-node restricted-command -g default mycommand
609 The ``-M`` option can be used to prepend the node name to all command
610 output lines. ``--sync`` forces the opcode to acquire the node lock(s)
619 **add-tags** [\--from *file*] {*nodename*} {*tag*...}
621 Add tags to the given node. If any of the tags contains invalid
622 characters, the entire operation will abort.
624 If the ``--from`` option is given, the list of tags will be
625 extended with the contents of that file (each line becomes a tag).
626 In this case, there is not need to pass tags on the command line
627 (if you do, both sources will be used). A file name of - will be
628 interpreted as stdin.
633 **list-tags** {*nodename*}
635 List the tags of the given node.
640 **remove-tags** [\--from *file*] {*nodename*} {*tag*...}
642 Remove tags from the given node. If any of the tags are not
643 existing on the node, the entire operation will abort.
645 If the ``--from`` option is given, the list of tags to be removed will
646 be extended with the contents of that file (each line becomes a tag).
647 In this case, there is not need to pass tags on the command line (if
648 you do, tags from both sources will be removed). A file name of - will
649 be interpreted as stdin.
651 .. vim: set textwidth=72 :