Manpage/btrfs-replace

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
m (Protected "Manpage/btrfs-replace": Counter-productive edit warring (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
(git 5.4)
 
Line 41: Line 41:
 
<blockquote><b>Note:</b>
 
<blockquote><b>Note:</b>
 
the filesystem has to be resized to fully take advantage of a
 
the filesystem has to be resized to fully take advantage of a
larger target device, this can be achieved with
+
larger target device; this can be achieved with
 
<tt>btrfs filesystem resize &lt;devid&gt;:max /path</tt></blockquote>
 
<tt>btrfs filesystem resize &lt;devid&gt;:max /path</tt></blockquote>
 
<p><tt>Options</tt></p>
 
<p><tt>Options</tt></p>
Line 59: Line 59:
 
<p>
 
<p>
 
force using and overwriting <em>&lt;targetdev&gt;</em> even if it looks like
 
force using and overwriting <em>&lt;targetdev&gt;</em> even if it looks like
containing a valid btrfs filesystem.
+
it contains a valid btrfs filesystem.
 
</p>
 
</p>
 
<p>A valid filesystem is assumed if a btrfs superblock is found which contains a
 
<p>A valid filesystem is assumed if a btrfs superblock is found which contains a
correct checksum. Devices which are currently mounted are
+
correct checksum. Devices that are currently mounted are
 
never allowed to be used as the <em>&lt;targetdev&gt;</em>.</p>
 
never allowed to be used as the <em>&lt;targetdev&gt;</em>.</p>
  
Line 93: Line 93:
  
 
</dl>
 
</dl>
 +
==EXAMPLES==
 +
 +
===Replacing an online drive with a bigger one===
 +
 +
<p>Given the filesystem:</p>
 +
<pre>Label: 'MyVault'  uuid: ae20903e-b72d-49ba-b944-901fc6d888a1
 +
        Total devices 2 FS bytes used 1TiB
 +
        devid    1 size 1TiB used 500.00GiB path /dev/sda
 +
        devid    2 size 1TiB used 500.00GiB path /dev/sdb</pre>
 +
<p>In order to replace <em>/dev/sda</em> (<em>devid 1</em>) with a bigger drive located at
 +
<em>/dev/sdc</em> you would run the following:</p>
 +
<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td><!-- Generator: GNU source-highlight
 +
by Lorenzo Bettini
 +
http://www.lorenzobettini.it
 +
http://www.gnu.org/software/src-highlite -->
 +
<pre><tt>btrfs replace start <font color="#993399">1</font> /dev/sdc /mnt/my-vault<font color="#990000">/</font></tt></pre></td></tr></table>
 +
<p>You can monitor progress by:</p>
 +
<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td><!-- Generator: GNU source-highlight
 +
by Lorenzo Bettini
 +
http://www.lorenzobettini.it
 +
http://www.gnu.org/software/src-highlite -->
 +
<pre><tt>btrfs replace status /mnt/my-vault<font color="#990000">/</font></tt></pre></td></tr></table>
 +
<p>After the replacement is complete, as per the docs at [[Manpage/btrfs-filesystem|btrfs-filesystem(8)]] in
 +
order to use the entire storage space of the new drive you need to run:</p>
 +
<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td><!-- Generator: GNU source-highlight
 +
by Lorenzo Bettini
 +
http://www.lorenzobettini.it
 +
http://www.gnu.org/software/src-highlite -->
 +
<pre><tt>btrfs filesystem resize <font color="#993399">1</font><font color="#990000">:</font>max /mnt/my-vault<font color="#990000">/</font></tt></pre></td></tr></table>
 
==EXIT STATUS==
 
==EXIT STATUS==
  
Line 105: Line 134:
  
 
<p>[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]],
 
<p>[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]],
[[Manpage/btrfs-device|btrfs-device(8)]],</p>
+
[[Manpage/btrfs-device|btrfs-device(8)]],
 +
[[Manpage/btrfs-filesystem|btrfs-filesystem(8)]],</p>
 
[[Category:Manpage]]
 
[[Category:Manpage]]

Latest revision as of 17:46, 16 January 2020

Contents

[edit] btrfs-replace(8) manual page

Warning: this page is automatically generated from git, all edits will be lost. Current git version.


[edit] NAME

btrfs-replace - replace devices managed by btrfs with other device.

[edit] SYNOPSIS

btrfs replace <subcommand> <args>

[edit] DESCRIPTION

btrfs replace is used to replace btrfs managed devices with other device.

[edit] SUBCOMMAND

cancel <mount_point>

Cancel a running device replace operation.

start [-Bfr] <srcdev>|<devid> <targetdev> <path>

Replace device of a btrfs filesystem.

On a live filesystem, duplicate the data to the target device which is currently stored on the source device. If the source device is not available anymore, or if the -r option is set, the data is built only using the RAID redundancy mechanisms. After completion of the operation, the source device is removed from the filesystem. If the <srcdev> is a numerical value, it is assumed to be the device id of the filesystem which is mounted at <path>, otherwise it is the path to the source device. If the source device is disconnected, from the system, you have to use the devid parameter format. The <targetdev> needs to be same size or larger than the <srcdev>.

Note: the filesystem has to be resized to fully take advantage of a larger target device; this can be achieved with btrfs filesystem resize <devid>:max /path

Options

-r

only read from <srcdev> if no other zero-defect mirror exists. (enable this if your drive has lots of read errors, the access would be very slow)

-f

force using and overwriting <targetdev> even if it looks like it contains a valid btrfs filesystem.

A valid filesystem is assumed if a btrfs superblock is found which contains a correct checksum. Devices that are currently mounted are never allowed to be used as the <targetdev>.

-B

no background replace.

status [-1] <mount_point>

Print status and progress information of a running device replace operation.

Options

-1

print once instead of print continuously until the replace operation finishes (or is cancelled)

[edit] EXAMPLES

[edit] Replacing an online drive with a bigger one

Given the filesystem:

Label: 'MyVault'  uuid: ae20903e-b72d-49ba-b944-901fc6d888a1
        Total devices 2 FS bytes used 1TiB
        devid    1 size 1TiB used 500.00GiB path /dev/sda
        devid    2 size 1TiB used 500.00GiB path /dev/sdb

In order to replace /dev/sda (devid 1) with a bigger drive located at /dev/sdc you would run the following:

<tt>btrfs replace start <font color="#993399">1</font> /dev/sdc /mnt/my-vault<font color="#990000">/</font></tt>

You can monitor progress by:

<tt>btrfs replace status /mnt/my-vault<font color="#990000">/</font></tt>

After the replacement is complete, as per the docs at btrfs-filesystem(8) in order to use the entire storage space of the new drive you need to run:

<tt>btrfs filesystem resize <font color="#993399">1</font><font color="#990000">:</font>max /mnt/my-vault<font color="#990000">/</font></tt>

[edit] EXIT STATUS

btrfs replace returns a zero exit status if it succeeds. Non zero is returned in case of failure.

[edit] AVAILABILITY

btrfs is part of btrfs-progs. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for further details.

[edit] SEE ALSO

mkfs.btrfs(8), btrfs-device(8), btrfs-filesystem(8),

Personal tools