Add SkipTest in hv_kvm psutil-specific test cases
[ganeti-github.git] / man / hcheck.rst
1 HCHECK(1) Ganeti | Version @GANETI_VERSION@
2 ===========================================
3
4 NAME
5 ----
6
7 hcheck \- Cluster checker
8
9 SYNOPSIS
10 --------
11
12 **hcheck** {backend options...} [algorithm options...] [reporting options...]
13
14 **hcheck** \--version
15
16
17 Backend options:
18
19 { **-m** *cluster* | **-L[** *path* **] | **-t** *data-file* |
20 **-I** *path* }
21
22 Algorithm options:
23
24 **[ \--no-simulation ]**
25 **[ \--max-cpu *cpu-ratio* ]**
26 **[ \--min-disk *disk-ratio* ]**
27 **[ -l *limit* ]**
28 **[ -e *score* ]**
29 **[ -g *delta* ]** **[ \--min-gain-limit *threshold* ]**
30 **[ -O *name...* ]**
31 **[ \--no-disk-moves ]**
32 **[ \--no-instance-moves ]**
33 **[ -U *util-file* ]**
34 **[ \--ignore-dynu ]**
35 **[ \--ignore-soft-errors ]**
36 **[ \--evac-mode ]**
37 **[ \--select-instances *inst...* ]**
38 **[ \--exclude-instances *inst...* ]**
39 **[ \--no-capacity-checks ]**
40
41 Reporting options:
42
43 **[\--machine-readable**[=*CHOICE*] **]**
44 **[ -p[ *fields* ] ]**
45 **[ \--print-instances ]**
46 **[ -v... | -q ]**
47
48
49 DESCRIPTION
50 -----------
51
52 hcheck is the cluster checker. It prints information about cluster's
53 health and checks whether a rebalance done using **hbal** would help.
54
55 This information can be presented in both human-readable and
56 machine-readable way.
57
58 Note that it does not take any action, only performs a rebalance
59 simulation if necessary.
60
61 For more information about the algorithm details check **hbal**\(1).
62
63 Additionally, hcheck also checks if the cluster is globally N+1 redundant.
64 That is, it checks for every node, if after failing over the DRBD instances
65 all instances on that node that with disks externally stored can be restarted
66 on some other node.
67
68 OPTIONS
69 -------
70
71 \--no-simulation
72   Only perform checks based on current cluster state, without trying
73   to simulate rebalancing.
74
75 \--no-capacity-checks
76   Do not check for global N+1 redundancy, i.e., do not warn if the
77   shared-storage instances of one node cannot be moved to the others
78   should that node fail.
79
80 For a detailed description about the options listed above have a look at
81 **htools**\(1), **hspace**\(1) and **hbal**\(1).
82
83 .. vim: set textwidth=72 :
84 .. Local Variables:
85 .. mode: rst
86 .. fill-column: 72
87 .. End: