1 gnt-group(8) Ganeti | Version @GANETI_VERSION@
2 ==============================================
7 gnt-group - Ganeti node-group administration
12 **gnt-group** {command} [arguments...]
17 The **gnt-group** command is used for node group administration in
27 | [--node-parameters=*NDPARAMS*]
28 | [--alloc-policy=*POLICY*]
31 Creates a new group with the given name. The node group will be
32 initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
34 The ``--node-parameters`` option allows you to set default node
35 parameters for nodes in the group. Please see **ganeti**(7) for more
36 information about supported key=value pairs.
38 The ``--alloc-policy`` option allows you to set an allocation policy for
39 the group at creation time. Possible values are:
42 nodes in the group should not be candidates for instance allocation,
43 and the operation (e.g., instance creation) should fail if only
44 groups in this state could be found to satisfy the requirements.
47 nodes in the group should not be used for instance allocations,
48 unless this would be the only way to have the operation succeed.
51 nodes in the group can be used freely for allocation of instances
52 (this is the default). Note that prioritization among groups in this
53 state will be deferred to the iallocator plugin that's being used.
60 | {*group*} {*node*...}
62 Assigns one or more nodes to the specified group, moving them from their
63 original group (or groups).
65 By default, this command will refuse to proceed if the move would split
66 between groups any instance that was not previously split (a split
67 instance is an instance with a mirrored disk template, e.g. DRBD, that
68 has the primary and secondary nodes in different node groups). You can
69 force the operation with ``--force``.
75 | [--node-parameters=*NDPARAMS*]
76 | [--alloc-policy=*POLICY*]
79 Modifies some parameters from the node group.
81 The ``--node-parameters`` and ``--alloc-policy`` optiosn are documented
82 in the **add** command above.
87 | **remove** {*group*}
89 Deletes the indicated node group, which must be empty. There must always be at
90 least one group, so the last group cannot be removed.
95 | **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
96 | [-o *[+]FIELD,...*] [--filter] [group...]
98 Lists all existing node groups in the cluster.
100 The ``--no-headers`` option will skip the initial header line. The
101 ``--separator`` option takes an argument which denotes what will be
102 used between the output fields. Both these options are to help
105 The ``-v`` option activates verbose mode, which changes the display of
106 special field states (see **ganeti(7)**).
108 The ``-o`` option takes a comma-separated list of output fields.
109 If the value of the option starts with the character ``+``, the new
110 fields will be added to the default list. This allows one to quickly
111 see the default list plus a few other fields, instead of retyping
112 the entire list of fields.
114 The available fields and their meaning are:
118 If exactly one argument is given and it appears to be a query filter
119 (see **ganeti(7)**), the query result is filtered accordingly. For
120 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
121 (``-F``) option forces the argument to be treated as a filter.
123 If no group names are given, then all groups are included. Otherwise,
124 only the named groups will be listed.
129 **list-fields** [field...]
131 List available fields for node groups.
136 | **rename** {*oldname*} {*newname*}
138 Renames a given group from *oldname* to *newname*.
144 **evacuate** [--iallocator *NAME*] [--to *GROUP*...] {*group*}
146 This command will move all instances out of the given node group.
147 Instances are placed in a new group by an iallocator, either given on
148 the command line or as a cluster default.
150 If no specific destination groups are specified using ``--to``, all
151 groups except the evacuated group are considered.
155 # gnt-group evacuate -I hail --to rack4 rack1
164 **add-tags** [--from *file*] {*groupname*} {*tag*...}
166 Add tags to the given node group. If any of the tags contains invalid
167 characters, the entire operation will abort.
169 If the ``--from`` option is given, the list of tags will be extended
170 with the contents of that file (each line becomes a tag). In this case,
171 there is not need to pass tags on the command line (if you do, both
172 sources will be used). A file name of ``-`` will be interpreted as
178 **list-tags** {*groupname*}
180 List the tags of the given node group.
185 **remove-tags** [--from *file*] {*groupname*} {*tag*...}
187 Remove tags from the given node group. If any of the tags are not
188 existing on the node, the entire operation will abort.
190 If the ``--from`` option is given, the list of tags to be removed will
191 be extended with the contents of that file (each line becomes a tag). In
192 this case, there is not need to pass tags on the command line (if you
193 do, tags from both sources will be removed). A file name of ``-`` will
194 be interpreted as stdin.
196 .. vim: set textwidth=72 :