hcheck.rst 1.59 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
HCHECK(1) Ganeti | Version @GANETI_VERSION@
===========================================

NAME
----

hcheck \- Cluster checker

SYNOPSIS
--------

**hcheck** {backend options...} [algorithm options...] [reporting options...]

**hcheck** \--version


Backend options:

{ **-m** *cluster* | **-L[** *path* **] | **-t** *data-file* |
**-I** *path* }

Algorithm options:

**[ \--no-simulation ]**
**[ \--max-cpu *cpu-ratio* ]**
**[ \--min-disk *disk-ratio* ]**
**[ -l *limit* ]**
**[ -e *score* ]**
**[ -g *delta* ]** **[ \--min-gain-limit *threshold* ]**
**[ -O *name...* ]**
**[ \--no-disk-moves ]**
**[ \--no-instance-moves ]**
**[ -U *util-file* ]**
**[ \--evac-mode ]**
**[ \--select-instances *inst...* ]**
**[ \--exclude-instances *inst...* ]**

Reporting options:

**[\--machine-readable**[=*CHOICE*] **]**
**[ -p[ *fields* ] ]**
**[ \--print-instances ]**
**[ -v... | -q ]**


DESCRIPTION
-----------

hcheck is the cluster checker. It prints information about cluster's
health and checks whether a rebalance done using **hbal** would help.
Iustin Pop's avatar
Iustin Pop committed
51

52 53
This information can be presented in both human-readable and
machine-readable way.
Iustin Pop's avatar
Iustin Pop committed
54

55 56
Note that it does not take any action, only performs a rebalance
simulation if necessary.
Iustin Pop's avatar
Iustin Pop committed
57

58
For more information about the algorithm details check **hbal**\(1).
59 60 61 62 63 64 65 66 67

OPTIONS
-------

\--no-simulation
  Only perform checks based on current cluster state, without trying
  to simulate rebalancing.

For a detailed description about the options listed above have a look at
68
**htools**\(1), **hspace**\(1) and **hbal**\(1).
69 70 71 72 73 74

.. vim: set textwidth=72 :
.. Local Variables:
.. mode: rst
.. fill-column: 72
.. End: