code.grnet.gr Git - ganeti-local/blob - man/gnt-group.rst

   1 gnt-group(8) Ganeti | Version @GANETI_VERSION@
   2 ==============================================
   3
   4 Name
   5 ----
   6
   7 gnt-group - Ganeti node-group administration
   8
   9 Synopsis
  10 --------
  11
  12 **gnt-group** {command} [arguments...]
  13
  14 DESCRIPTION
  15 -----------
  16
  17 The **gnt-group** command is used for node group administration in
  18 the Ganeti system.
  19
  20 COMMANDS
  21 --------
  22
  23 ADD
  24 ~~~
  25
  26 | **add**
  27 | [--node-parameters=*NDPARAMS*]
  28 | [--alloc-policy=*POLICY*]
  29 | {*group*}
  30
  31 Creates a new group with the given name. The node group will be
  32 initially empty.
  33
  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.
  37
  38 The ``--alloc-policy`` option allows you to set an allocation policy for
  39 the group at creation time. Possible values are:
  40
  41 unallocable
  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.
  45
  46 last_resort
  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.
  49
  50 preferred
  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.
  54
  55
  56 MODIFY
  57 ~~~~~~
  58
  59 | **modify**
  60 | [--node-parameters=*NDPARAMS*]
  61 | [--alloc-policy=*POLICY*]
  62 | {*group*}
  63
  64 Modifies some parameters from the node group.
  65
  66 The ``--node-parameters`` and ``--alloc-policy`` optiosn are documented
  67 in the **add** command above.
  68
  69 REMOVE
  70 ~~~~~~
  71
  72 | **remove** {*group*}
  73
  74 Deletes the indicated node group, which must be empty.
  75
  76 LIST
  77 ~~~~
  78
  79 | **list** [--no-headers] [--separator=*SEPARATOR*]
  80 | [-o *[+]FIELD,...*] [group...]
  81
  82 Lists all existing node groups in the cluster.
  83
  84 The ``--no-headers`` option will skip the initial header line. The
  85 ``--separator`` option takes an argument which denotes what will be
  86 used between the output fields. Both these options are to help
  87 scripting.
  88
  89 The ``-o`` option takes a comma-separated list of output fields.
  90 If the value of the option starts with the character ``+``, the new
  91 fields will be added to the default list. This allows to quickly
  92 see the default list plus a few other fields, instead of retyping
  93 the entire list of fields.
  94
  95 The available fields and their meaning are:
  96
  97 name
  98     the group name
  99
 100 uuid
 101     the group's UUID
 102
 103 node_cnt
 104     the number of nodes in the node group
 105
 106 node_list
 107     the list of nodes that belong to this group
 108
 109 pinst_cnt
 110     the number of primary instances in the group (i.e., the number of
 111     primary instances nodes in this group have)
 112
 113 pinst_list
 114     the list of primary instances in the group
 115
 116 alloc_policy
 117     the current allocation policy for the group
 118
 119 ctime
 120     the creation time of the group; note that this field contains spaces
 121     and as such it's harder to parse
 122
 123     if this attribute is not present (e.g. when upgrading from older
 124     versions), then "N/A" will be shown instead
 125
 126 mtime
 127     the last modification time of the group; note that this field
 128     contains spaces and as such it's harder to parse
 129
 130 serial_no
 131     the so called 'serial number' of the group; this is a numeric field
 132     that is incremented each time the node is modified, and it can be
 133     used to detect modifications
 134
 135 If no group names are given, then all groups are included. Otherwise,
 136 only the named groups will be listed.
 137
 138 LIST-FIELDS
 139 ~~~~~~~~~~~
 140
 141 **list-fields** [field...]
 142
 143 List available fields for node groups.
 144
 145 RENAME
 146 ~~~~~~
 147
 148 | **rename** {*oldname*} {*newname*}
 149
 150 Renames a given group from *oldname* to *newname*.