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*]
29 | [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
30 | [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
31 | [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
32 | [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
33 | [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
34 | [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
35 | [--ipol-disk-templates *template* [,*template*...]]
36 | [--disk-state *diskstate*]
37 | [--hypervisor-state *hvstate*]
40 Creates a new group with the given name. The node group will be
41 initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
43 The ``--node-parameters`` option allows you to set default node
44 parameters for nodes in the group. Please see **ganeti**(7) for more
45 information about supported key=value pairs and their corresponding
48 The ``--alloc-policy`` option allows you to set an allocation policy for
49 the group at creation time. Possible values are:
52 nodes in the group should not be candidates for instance allocation,
53 and the operation (e.g., instance creation) should fail if only
54 groups in this state could be found to satisfy the requirements.
57 nodes in the group should not be used for instance allocations,
58 unless this would be the only way to have the operation succeed.
61 nodes in the group can be used freely for allocation of instances
62 (this is the default). Note that prioritization among groups in this
63 state will be deferred to the iallocator plugin that's being used.
65 The ``-D (--disk-parameters)`` option allows you to set the disk
66 parameters for the node group; please see the section about
67 **gnt-cluster add** in **gnt-cluster**(8) for more information about
70 The ``--specs-...`` and ``--ipol-disk-templates`` options specify
71 instance policies on the node group, and are documented in the
72 **gnt-cluster**(8) man page.
79 | {*group*} {*node*...}
81 Assigns one or more nodes to the specified group, moving them from their
82 original group (or groups).
84 By default, this command will refuse to proceed if the move would split
85 between groups any instance that was not previously split (a split
86 instance is an instance with a mirrored disk template, e.g. DRBD, that
87 has the primary and secondary nodes in different node groups). You can
88 force the operation with ``--force``.
94 | [--node-parameters=*NDPARAMS*]
95 | [--alloc-policy=*POLICY*]
96 | [--hypervisor-state *hvstate*]
97 | [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
98 | [--disk-state *diskstate*]
99 | [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
100 | [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
101 | [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
102 | [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
103 | [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
104 | [--ipol-disk-templates *template* [,*template*...]]
107 Modifies some parameters from the node group.
109 The ``--node-parameters`` and ``--alloc-policy`` options are documented
110 in the **add** command above. ``--hypervisor-state`` as well as
111 ``--disk-state`` are documented in detail in **ganeti**(7).
113 The ``--node-parameters``, ``--alloc-policy``, ``-D
114 (--disk-parameters)`` options are documented in the **add** command
117 The ``--specs-...`` and ``--ipol-disk-templates`` options specify
118 instance policies on the node group, and are documented in the
119 **gnt-cluster**(8) man page.
124 | **remove** {*group*}
126 Deletes the indicated node group, which must be empty. There must always be at
127 least one group, so the last group cannot be removed.
132 | **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
133 | [-o *[+]FIELD,...*] [--filter] [group...]
135 Lists all existing node groups in the cluster.
137 The ``--no-headers`` option will skip the initial header line. The
138 ``--separator`` option takes an argument which denotes what will be
139 used between the output fields. Both these options are to help
142 The ``-v`` option activates verbose mode, which changes the display of
143 special field states (see **ganeti(7)**).
145 The ``-o`` option takes a comma-separated list of output fields.
146 If the value of the option starts with the character ``+``, the new
147 fields will be added to the default list. This allows one to quickly
148 see the default list plus a few other fields, instead of retyping
149 the entire list of fields.
151 The available fields and their meaning are:
155 If exactly one argument is given and it appears to be a query filter
156 (see **ganeti(7)**), the query result is filtered accordingly. For
157 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
158 (``-F``) option forces the argument to be treated as a filter.
160 If no group names are given, then all groups are included. Otherwise,
161 only the named groups will be listed.
166 **list-fields** [field...]
168 List available fields for node groups.
173 | **rename** {*oldname*} {*newname*}
175 Renames a given group from *oldname* to *newname*.
181 **evacuate** [--iallocator *NAME*] [--to *GROUP*...] {*group*}
183 This command will move all instances out of the given node group.
184 Instances are placed in a new group by an iallocator, either given on
185 the command line or as a cluster default.
187 If no specific destination groups are specified using ``--to``, all
188 groups except the evacuated group are considered.
192 # gnt-group evacuate -I hail --to rack4 rack1
201 **add-tags** [--from *file*] {*groupname*} {*tag*...}
203 Add tags to the given node group. If any of the tags contains invalid
204 characters, the entire operation will abort.
206 If the ``--from`` option is given, the list of tags will be extended
207 with the contents of that file (each line becomes a tag). In this case,
208 there is not need to pass tags on the command line (if you do, both
209 sources will be used). A file name of ``-`` will be interpreted as
215 **list-tags** {*groupname*}
217 List the tags of the given node group.
222 **remove-tags** [--from *file*] {*groupname*} {*tag*...}
224 Remove tags from the given node group. If any of the tags are not
225 existing on the node, the entire operation will abort.
227 If the ``--from`` option is given, the list of tags to be removed will
228 be extended with the contents of that file (each line becomes a tag). In
229 this case, there is not need to pass tags on the command line (if you
230 do, tags from both sources will be removed). A file name of ``-`` will
231 be interpreted as stdin.
233 .. vim: set textwidth=72 :