Statistics
| Branch: | Tag: | Revision:

root / hscan.1 @ 66ea8434

History | View | Annotate | Download (3.2 kB)

1
.TH HSCAN 1 2009-03-23 htools "Ganeti H-tools"
2
.SH NAME
3
hscan \- Scan clusters via RAPI and save node/instance data
4

    
5
.SH SYNOPSIS
6
.B hscan
7
.B "[-p]"
8
.B "[--no-headers]"
9
.BI "[-d " path "]"
10
.I cluster...
11

    
12
.B hscan
13
.B --version
14

    
15
.SH DESCRIPTION
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 " hspace "(1)."
19
It will also show a one\(hyline score for each cluster scanned or, if
20
desired, the cluster state as show by the \fB-p\fR option to the other
21
tools.
22

    
23
For each cluster, one file named \fIcluster\fB.data\ will be generated
24
holding the node and instance data. This file can then be used in
25
\fBhbal\fR(1) or \fBhspace\fR(1) via the \fB-t\fR option. In case the
26
cluster name contains slashes (as it can happen when the cluster is a
27
fully-specified URL), these will be replaced with underscores.
28

    
29
The one\(hyline output for each cluster will show the following:
30
.RS
31
.TP
32
.B Name
33
The name of the cluster (or the IP address that was given, etc.)
34
.TP
35
.B Nodes
36
The number of nodes in the cluster
37
.TP
38
.B Inst
39
The number of instances in the cluster
40
.TP
41
.B BNode
42
The number of nodes failing N+1
43
.TP
44
.B BInst
45
The number of instances living on N+1\(hyfailed nodes
46
.TP
47
.B t_mem
48
Total memory in the cluster
49
.TP
50
.B f_mem
51
Free memory in the cluster
52
.TP
53
.B t_disk
54
Total disk in the cluster
55
.TP
56
.B f_disk
57
Free disk space in the cluster
58
.TP
59
.B Score
60
The score of the cluster, as would be reported by \fBhbal\fR(1) if
61
run on the generated data files.
62

    
63
.RE
64

    
65
In case of errors while collecting data, all fields after the name of
66
the cluster are replaced with the error display.
67

    
68
.B Note:
69
this output format is not yet final so it should not be used for
70
scripting yet.
71

    
72
.SH OPTIONS
73
The options that can be passed to the program are as follows:
74

    
75
.TP
76
.B -p, --print-nodes
77
Prints the node status for each cluster after the cluster's one\(hyline
78
status display, in a format designed to allow the user to understand
79
the node's most important parameters. For details, see the man page
80
for \fBhbal\fR(1).
81

    
82
.TP
83
.BI "-d " path
84
Save the node and instance data for each cluster under \fIpath\fR,
85
instead of the current directory.
86

    
87
.TP
88
.B -V, --version
89
Just show the program version and exit.
90

    
91
.SH EXIT STATUS
92

    
93
The exist status of the command will be zero, unless for some reason
94
loading the input data failed fatally (e.g. wrong node or instance
95
data).
96

    
97
.SH BUGS
98

    
99
The program does not check its input data for consistency, and aborts
100
with cryptic errors messages in this case.
101

    
102
.SH EXAMPLE
103

    
104
.in +4n
105
.nf
106
.RB "$ " "hscan cluster1"
107
Name     Nodes  Inst BNode BInst  t_mem  f_mem t_disk f_disk      Score
108
cluster1     2     2     0     0   1008    652    255    253 0.24404762
109
.RB "$ " "ls -l cluster1.data"
110
\-rw\-r\-\-r\-\- 1 root root 364 2009\-03\-23 07:26 cluster1.data
111
.fi
112
.in
113

    
114
.SH SEE ALSO
115
.BR hbal "(1), " hspace "(1), " hail "(1), "
116
.BR ganeti "(7), " gnt-instance "(8), " gnt-node "(8)"
117

    
118
.SH "COPYRIGHT"
119
.PP
120
Copyright (C) 2009 Google Inc. Permission is granted to copy,
121
distribute and/or modify under the terms of the GNU General Public
122
License as published by the Free Software Foundation; either version 2
123
of the License, or (at your option) any later version.
124
.PP
125
On Debian systems, the complete text of the GNU General Public License
126
can be found in /usr/share/common-licenses/GPL.