root / man / hscan.rst @ 2c7a0373
History | View | Annotate | Download (2.8 kB)
1 |
HSCAN(1) Ganeti | Version @GANETI_VERSION@ |
---|---|
2 |
========================================== |
3 |
|
4 |
NAME |
5 |
---- |
6 |
|
7 |
hscan - Scan clusters via RAPI and save node/instance data |
8 |
|
9 |
SYNOPSIS |
10 |
-------- |
11 |
|
12 |
**hscan** [-p] [--no-headers] [-d *path* ] *cluster...* |
13 |
|
14 |
**hscan** --version |
15 |
|
16 |
DESCRIPTION |
17 |
----------- |
18 |
|
19 |
hscan is a tool for scanning clusters via RAPI and saving their data |
20 |
in the input format used by **hbal**(1) and **hspace**(1). It will |
21 |
also show a one-line score for each cluster scanned or, if desired, |
22 |
the cluster state as show by the **-p** option to the other tools. |
23 |
|
24 |
For each cluster, one file named *cluster***.data** will be generated |
25 |
holding the node and instance data. This file can then be used in |
26 |
**hbal**(1) or **hspace**(1) via the *-t* option. In case the |
27 |
cluster name contains slashes (as it can happen when the cluster is a |
28 |
fully-specified URL), these will be replaced with underscores. |
29 |
|
30 |
The one-line output for each cluster will show the following: |
31 |
|
32 |
Name |
33 |
The name of the cluster (or the IP address that was given, etc.) |
34 |
|
35 |
Nodes |
36 |
The number of nodes in the cluster |
37 |
|
38 |
Inst |
39 |
The number of instances in the cluster |
40 |
|
41 |
BNode |
42 |
The number of nodes failing N+1 |
43 |
|
44 |
BInst |
45 |
The number of instances living on N+1-failed nodes |
46 |
|
47 |
t_mem |
48 |
Total memory in the cluster |
49 |
|
50 |
f_mem |
51 |
Free memory in the cluster |
52 |
|
53 |
t_disk |
54 |
Total disk in the cluster |
55 |
|
56 |
f_disk |
57 |
Free disk space in the cluster |
58 |
|
59 |
Score |
60 |
The score of the cluster, as would be reported by **hbal**(1) if run |
61 |
on the generated data files. |
62 |
|
63 |
In case of errors while collecting data, all fields after the name of |
64 |
the cluster are replaced with the error display. |
65 |
|
66 |
**Note:** this output format is not yet final so it should not be used |
67 |
for scripting yet. |
68 |
|
69 |
OPTIONS |
70 |
------- |
71 |
|
72 |
The options that can be passed to the program are as follows: |
73 |
|
74 |
-p, --print-nodes |
75 |
Prints the node status for each cluster after the cluster's one-line |
76 |
status display, in a format designed to allow the user to understand |
77 |
the node's most important parameters. For details, see the man page |
78 |
for **htools**(1). |
79 |
|
80 |
-d *path* |
81 |
Save the node and instance data for each cluster under *path*, |
82 |
instead of the current directory. |
83 |
|
84 |
-V, --version |
85 |
Just show the program version and exit. |
86 |
|
87 |
EXIT STATUS |
88 |
----------- |
89 |
|
90 |
The exist status of the command will be zero, unless for some reason |
91 |
loading the input data failed fatally (e.g. wrong node or instance |
92 |
data). |
93 |
|
94 |
BUGS |
95 |
---- |
96 |
|
97 |
The program does not check its input data for consistency, and aborts |
98 |
with cryptic errors messages in this case. |
99 |
|
100 |
EXAMPLE |
101 |
------- |
102 |
|
103 |
:: |
104 |
|
105 |
$ hscan cluster1 |
106 |
Name Nodes Inst BNode BInst t_mem f_mem t_disk f_disk Score |
107 |
cluster1 2 2 0 0 1008 652 255 253 0.24404762 |
108 |
$ ls -l cluster1.data |
109 |
-rw-r--r-- 1 root root 364 2009-03-23 07:26 cluster1.data |
110 |
|
111 |
.. vim: set textwidth=72 : |
112 |
.. Local Variables: |
113 |
.. mode: rst |
114 |
.. fill-column: 72 |
115 |
.. End: |