summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-balance.txt
blob: 7edc44b150dd07a9706600ab5f53ae21c51f3e26 (plain)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
btrfs-balance(8)
================

NAME
----
btrfs-balance - balance btrfs filesystem

SYNOPSIS
--------
'btrfs [filesystem] balance' <subcommand>|<args>

DESCRIPTION
-----------
'btrfs balance' is used to balance chunks in a btrfs filesystem across
multiple or even single device.

See `btrfs-device`(8) for more details about the effect on device management.

SUBCOMMAND
----------
<path>::
Balance chunks across the devices *online*.
+
'btrfs balance <path>' is deprecated,
please use 'btrfs balance start' command instead.

'start' [options] <path>::
Balance chunks across the devices *online*.
+
Balance and/or convert (change allocation profile of) chunks that
passed all filters in a comma-separated list of filters for a
particular chunk type.
If filter list is not given balance all chunks of that type.
In case none of the -d, -m or -s options is
given balance all chunks in a filesystem.
+
`Options`
+
-d[<filters>]::::
act on data chunks
-m[<filters>]::::
act on metadata chunks
-s[<filters>]::::
act on system chunks (only under -f)
-v::::
be verbose
-f::::
force reducing of metadata integrity

'pause' <path>::
Pause running balance.

'cancel' <path>::
Cancel running or paused balance.

'resume' <path>::
Resume interrupted balance.

'status' [-v] <path>::
Show status of running or paused balance.
+
If '-v' option is given, output will be verbose.

EXIT STATUS
-----------
'btrfs balance' returns a zero exist status if it succeeds. Non zero is
returned in case of failure.

AVAILABILITY
------------
'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
development,
and not suitable for any uses other than benchmarking and review.
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
further details.

SEE ALSO
--------
`mkfs.btrfs`(8),
`btrfs-device`(8)