code.grnet.gr Git - ganeti-local/blob - hscan.1

   1 .TH HSCAN 1 2009-03-22 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 " 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
  21 tools.
  22
  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.
  27
  28 .SH OPTIONS
  29 The options that can be passed to the program are as follows:
  30
  31 .TP
  32 .B -p, --print-nodes
  33 Prints the node status for each cluster after the cluster's one-line
  34 status display, in a format designed to allow the user to understand
  35 the node's most important parameters. For details, see the man page
  36 for \fBhbal\fR(1).
  37
  38 .TP
  39 .BI "-d " path
  40 Save the node and instance data for each cluster under \fIpath\fR,
  41 instead of the current directory.
  42
  43 .TP
  44 .B -V, --version
  45 Just show the program version and exit.
  46
  47 .SH EXIT STATUS
  48
  49 The exist status of the command will be zero, unless for some reason
  50 loading the input data failed fatally (e.g. wrong node or instance
  51 data).
  52
  53 .SH BUGS
  54
  55 The program does not check its input data for consistency, and aborts
  56 with cryptic errors messages in this case.
  57
  58 .SH SEE ALSO
  59 .BR hbal "(1), " hn1 "(1), " ganeti "(7), " gnt-instance "(8), " gnt-node "(8)"