1 .TH HSCAN 1 2009-03-23 htools "Ganeti H-tools"
3 hscan \- Scan clusters via RAPI and save node/instance data
16 hscan is a tool for scanning clusters via RAPI and saving their data
17 in the input format used by
18 .BR hbal "(1) and " hn1 "(1)."
19 It will also show a one-line score for each cluster scanned or, if
20 desired, the cluster state as show by the \fB-p\fR option to the other
23 For each cluster, two files named \fIcluster\fB.instances\fR and
24 \fIcluster\fB.nodes\fR will be generated holding the instance and node
25 data. These files can then be used in \fBhbal\fR(1) or \fBhn1\fR(1)
26 via the \fB-i\fR and \fB-n\fR options. In case the cluster name
27 contains slashes (as it can happen when the cluster is a
28 fully-specified URL), these will be replaced with underscores.
30 The one-line output for each cluster will show the following:
34 The name of the cluster (or the IP address that was given, etc.)
37 The number of nodes in the cluster
40 The number of instances in the cluster
43 The number of nodes failing N+1
46 The number of instances living on N+1-failed nodes
49 Total memory in the cluster
52 Free memory in the cluster
55 Total disk in the cluster
58 Free disk space in the cluster
61 The score of the cluster, as would be reported by \fBhscan\fR(1) if
62 run on the generated data files.
66 In case of errors while collecting data, all fields after the name of
67 the cluster are replaced with the error display.
70 this output format is not yet final so it should not be used for
74 The options that can be passed to the program are as follows:
78 Prints the node status for each cluster after the cluster's one-line
79 status display, in a format designed to allow the user to understand
80 the node's most important parameters. For details, see the man page
85 Save the node and instance data for each cluster under \fIpath\fR,
86 instead of the current directory.
90 Just show the program version and exit.
94 The exist status of the command will be zero, unless for some reason
95 loading the input data failed fatally (e.g. wrong node or instance
100 The program does not check its input data for consistency, and aborts
101 with cryptic errors messages in this case.
103 The RAPI collection doesn't deal with non-\fBdrbd\fR instances, and
104 chokes on input data which has such instances.
110 .RB "$ " "hscan cluster1"
111 Name Nodes Inst BNode BInst t_mem f_mem t_disk f_disk Score
112 cluster1 2 2 0 0 1008 652 255 253 0.24404762
113 .RB "$ " "ls -l cluster1.*"
114 -rw-r--r-- 1 root root 163 2009-03-23 07:26 cluster1.instances
115 -rw-r--r-- 1 root root 90 2009-03-23 07:26 cluster1.nodes
120 .BR hbal "(1), " hn1 "(1), " ganeti "(7), " gnt-instance "(8), " gnt-node "(8)"