Revision acd9fa11 man/htools.rst

b/man/htools.rst
131 131
  lNet
132 132
    the dynamic net load (if the information is available)
133 133

  
134
-t *datafile*, --text-data=*datafile*
135
  Backend specification: the name of the file holding node and instance
136
  information (if not collecting via RAPI or LUXI). This or one of the
137
  other backends must be selected. The option is described in the man
138
  page **htools**(1).
139

  
140
  The file should contain text data, line-based, with two empty lines
141
  separating sections. The lines themselves are column-based, with the
142
  pipe symbol (``|``) acting as separator.
143

  
144
  The first section contains group data, with two columns:
145

  
146
  - group name
147
  - group uuid
148

  
149
  The second sections contains node data, with the following columns:
150

  
151
  - node name
152
  - node total memory
153
  - node free memory
154
  - node total disk
155
  - node free disk
156
  - node physical cores
157
  - offline field (as ``Y`` or ``N``)
158
  - group UUID
159

  
160
  The third section contains instance data, with the fields:
161

  
162
  - instance name
163
  - instance memory
164
  - instance disk size
165
  - instance vcpus
166
  - instance status (in Ganeti's format, e.g. ``running`` or ``ERROR_down``)
167
  - instance ``auto_balance`` flag (see man page **gnt-instance** (7))
168
  - instance primary node
169
  - instance secondary node(s), if any
170
  - instance disk type (e.g. ``plain`` or ``drbd``)
171
  - instance tags
172

  
173
  The fourth and last section contains the cluster tags, with one tag
174
  per line (no columns/no column processing).
175

  
176
-m *cluster*
177
  Backend specification: collect data directly from the *cluster* given
178
  as an argument via RAPI. If the argument doesn't contain a colon (:),
179
  then it is converted into a fully-built URL via prepending
180
  ``https://`` and appending the default RAPI port, otherwise it is
181
  considered a fully-specified URL and used as-is.
182

  
183
-L [*path*]
184
  Backend specification: collect data directly from the master daemon,
185
  which is to be contacted via LUXI (an internal Ganeti protocol). An
186
  optional *path* argument is interpreted as the path to the unix socket
187
  on which the master daemon listens; otherwise, the default path used
188
  by Ganeti (configured at build time) is used.
189

  
190
--simulate *description*
191
  Backend specification: instead of using actual data, build an empty
192
  cluster given a node description. The *description* parameter must be
193
  a comma-separated list of five elements, describing in order:
194

  
195
  - the allocation policy for this node group (*preferred*, *allocable*
196
    or *unallocable*, or alternatively the short forms *p*, *a* or *u*)
197
  - the number of nodes in the cluster
198
  - the disk size of the nodes (default in mebibytes, units can be used)
199
  - the memory size of the nodes (default in mebibytes, units can be used)
200
  - the cpu core count for the nodes
201

  
202
  An example description would be **preferred,B20,100G,16g,4**
203
  describing a 20-node cluster where each node has 100GB of disk
204
  space, 16GiB of memory and 4 CPU cores. Note that all nodes must
205
  have the same specs currently.
206

  
207
  This option can be given multiple times, and each new use defines a
208
  new node group. Hence different node groups can have different
209
  allocation policies and node count/specifications.
210

  
134 211
-v, --verbose
135 212
  Increase the output verbosity. Each usage of this option will
136 213
  increase the verbosity (currently more than 2 doesn't make sense)

Also available in: Unified diff