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 | [\--ipolicy-bounds-specs *bound_ispecs*]
31 | [\--ipolicy-disk-templates *template* [,*template*...]]
32 | [\--ipolicy-spindle-ratio *ratio*]
33 | [\--ipolicy-vcpu-ratio *ratio*]
34 | [\--disk-state *diskstate*]
35 | [\--hypervisor-state *hvstate*]
38 Creates a new group with the given name. The node group will be
39 initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
41 The ``--node-parameters`` option allows you to set default node
42 parameters for nodes in the group. Please see **ganeti**\(7) for more
43 information about supported key=value pairs and their corresponding
46 The ``--alloc-policy`` option allows you to set an allocation policy for
47 the group at creation time. Possible values are:
50 nodes in the group should not be candidates for instance allocation,
51 and the operation (e.g., instance creation) should fail if only
52 groups in this state could be found to satisfy the requirements.
55 nodes in the group should not be used for instance allocations,
56 unless this would be the only way to have the operation succeed.
59 nodes in the group can be used freely for allocation of instances
60 (this is the default). Note that prioritization among groups in this
61 state will be deferred to the iallocator plugin that's being used.
63 The ``-D (--disk-parameters)`` option allows you to set the disk
64 parameters for the node group; please see the section about
65 **gnt-cluster add** in **gnt-cluster**\(8) for more information about
68 The ``--ipolicy-...`` options specify instance policies on the node
69 group, and are documented in the **gnt-cluster**\(8) man page.
71 See **ganeti**\(7) for a description of ``--submit`` and other common
78 | [\--force] [\--submit]
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``.
90 See **ganeti**\(7) for a description of ``--submit`` and other common
96 | **modify** [\--submit]
97 | [\--node-parameters=*NDPARAMS*]
98 | [\--alloc-policy=*POLICY*]
99 | [\--hypervisor-state *hvstate*]
100 | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
101 | [\--disk-state *diskstate*]
102 | [\--ipolicy-bounds-specs *bound_ispecs*]
103 | [\--ipolicy-disk-templates *template* [,*template*...]]
104 | [\--ipolicy-spindle-ratio *ratio*]
105 | [\--ipolicy-vcpu-ratio *ratio*]
108 Modifies some parameters from the node group.
110 The ``--node-parameters`` and ``--alloc-policy`` options are documented
111 in the **add** command above. ``--hypervisor-state`` as well as
112 ``--disk-state`` are documented in detail in **ganeti**\(7).
114 The ``--node-parameters``, ``--alloc-policy``, ``-D
115 (--disk-parameters)`` options are documented in the **add** command
118 The ``--ipolicy-...`` options specify instance policies on the node
119 group, and are documented in the **gnt-cluster**\(8) man page.
121 See **ganeti**\(7) for a description of ``--submit`` and other common
127 | **remove** [\--submit] {*group*}
129 Deletes the indicated node group, which must be empty. There must always be at
130 least one group, so the last group cannot be removed.
132 See **ganeti**\(7) for a description of ``--submit`` and other common
138 | **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
139 | [-o *[+]FIELD,...*] [\--filter] [group...]
141 Lists all existing node groups in the cluster.
143 The ``--no-headers`` option will skip the initial header line. The
144 ``--separator`` option takes an argument which denotes what will be
145 used between the output fields. Both these options are to help
148 The ``-v`` option activates verbose mode, which changes the display of
149 special field states (see **ganeti**\(7)).
151 The ``-o`` option takes a comma-separated list of output fields.
152 If the value of the option starts with the character ``+``, the new
153 fields will be added to the default list. This allows one to quickly
154 see the default list plus a few other fields, instead of retyping
155 the entire list of fields.
157 The available fields and their meaning are:
161 If exactly one argument is given and it appears to be a query filter
162 (see **ganeti**\(7)), the query result is filtered accordingly. For
163 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
164 (``-F``) option forces the argument to be treated as a filter.
166 If no group names are given, then all groups are included. Otherwise,
167 only the named groups will be listed.
172 **list-fields** [field...]
174 List available fields for node groups.
179 | **rename** [\--submit] {*oldname*} {*newname*}
181 Renames a given group from *oldname* to *newname*.
183 See **ganeti**\(7) for a description of ``--submit`` and other common
190 **evacuate** [\--submit] [\--iallocator *NAME*] [\--to *GROUP*...] {*group*}
192 This command will move all instances out of the given node group.
193 Instances are placed in a new group by an iallocator, either given on
194 the command line or as a cluster default.
196 If no specific destination groups are specified using ``--to``, all
197 groups except the evacuated group are considered.
199 See **ganeti**\(7) for a description of ``--submit`` and other common
204 # gnt-group evacuate -I hail --to rack4 rack1
213 **add-tags** [\--from *file*] {*groupname*} {*tag*...}
215 Add tags to the given node group. If any of the tags contains invalid
216 characters, the entire operation will abort.
218 If the ``--from`` option is given, the list of tags will be extended
219 with the contents of that file (each line becomes a tag). In this case,
220 there is not need to pass tags on the command line (if you do, both
221 sources will be used). A file name of ``-`` will be interpreted as
227 **list-tags** {*groupname*}
229 List the tags of the given node group.
234 **remove-tags** [\--from *file*] {*groupname*} {*tag*...}
236 Remove tags from the given node group. If any of the tags are not
237 existing on the node, the entire operation will abort.
239 If the ``--from`` option is given, the list of tags to be removed will
240 be extended with the contents of that file (each line becomes a tag). In
241 this case, there is not need to pass tags on the command line (if you
242 do, tags from both sources will be removed). A file name of ``-`` will
243 be interpreted as stdin.
248 **info** [*group*...]
250 Shows config information for all (or given) groups.
255 **show-ispecs-cmd** [\--include-defaults] [*group*...]
257 Shows the command line that can be used to recreate the given groups (or
258 all groups, if none is given) with the same options relative to specs in
259 the instance policies.
261 If ``--include-defaults`` is specified, include also the default values
262 (i.e. the cluster-level settings), and not only the configuration items
263 that a group overrides.
266 .. vim: set textwidth=72 :