Manpage/btrfs-device

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(update from git)
(remove content)
 
(10 intermediate revisions by one user not shown)
Line 1: Line 1:
 
+
{{GeneratedManpage
=btrfs-device(8) Manual Page=
+
|name=btrfs-device}}
{{GeneratedManpage}}
+
 
+
 
+
==NAME==
+
 
+
btrfs-device - control btrfs devices
+
 
+
==SYNOPSIS==
+
 
+
'''btrfs device''' <subcommand> <args>
+
 
+
==DESCRIPTION==
+
 
+
'''btrfs device''' is used to control the btrfs devices, since btrfs can be used across several devices, '''btrfs device''' is used for multiple device management.
+
 
+
==DEVICE MANAGEMENT==
+
 
+
Btrfs filesystem is capable to manage multiple devices.
+
 
+
Btrfs filesystem uses different profiles to manage different RAID level, and use balance to rebuild chunks, also devices can be added/removed/replace online.
+
 
+
; Profile
+
: Btrfs filesystem uses data/metadata profiles to manage allocation/duplication mechanism.<br /> Profiles like RAID level can be assigned to data and metadata separately. <br /> See [[Manpage/mkfs.btrfs|mkfs.btrfs(8)]] for more details.
+
; RAID level
+
: Btrfs filesystem supports most of the standard RAID level: 0/1/5/6/10.<br /> RAID levels can be assigned at mkfs time or online. <br /> See [[Manpage/mkfs.btrfs|mkfs.btrfs(8)]] for mkfs time RAID level assign and [[Manpage/btrfs-balance|btrfs-balance(8)]] for online RAID level assign. <br />'''Note:''' Since btrfs is under heavy development especially the RAID5/6 support, it is '''highly''' recommended to read the follow btrfs wiki page to get more updated details on RAID5/6:<br />https://btrfs.wiki.kernel.org/index.php/RAID56
+
; Balance
+
: [[Manpage/btrfs-balance|btrfs-balance(8)]] subcommand can be used to balance or rebuild chunks to the desired profile. <br /> Due to the fact that balance can rebuild/recovery chunks according to its RAID duplication if possible, so when using RAID1/5/6/10 with some devices failed and you just added a new device to btrfs using [[Manpage/btrfs-device|btrfs-device(8)]], you should run [[Manpage/btrfs-balance|btrfs-balance(8)]] to rebuild the chunks. <br /> See [[Manpage/btrfs-balance|btrfs-balance(8)]] for more details.
+
; Device add/remove/replace
+
: Device can be added/removed using [[Manpage/btrfs-replace|btrfs-replace(8)]] subcommand and replaced using [[Manpage/btrfs-replace|btrfs-replace(8)]]. <br /> When device is removed or replaced, btrfs will do the chunk rebuild if needed. <br /> See [[Manpage/btrfs-replace|btrfs-replace(8)]] and this man page for more details.
+
 
+
==SUBCOMMAND==
+
 
+
; '''add''' [-Kf] &lt;dev&gt; [&lt;dev&gt;…] &lt;path&gt;
+
: Add device(s) to the filesystem identified by &lt;path&gt;. <br /> If applicable, a whole device discard (TRIM) operation is performed. <br /><code>Options</code><br />
+
:; -K|--nodiscard
+
:: do not perform discard by default
+
:; -f|--force
+
:: force overwrite of existing filesystem on the given disk(s)
+
; '''delete''' &lt;dev&gt; [&lt;dev&gt;…] &lt;path&gt;
+
: Remove device(s) from a filesystem identified by &lt;path&gt;.
+
; '''ready''' &lt;device&gt;
+
: Check device to see if it has all of it’s devices in cache for mounting.
+
; '''scan''' [(--all-devices|-d)|&lt;device&gt; [&lt;device&gt;…]]
+
: Scan devices for a btrfs filesystem. <br /> If one or more devices are passed, these are scanned for a btrfs filesystem. If no devices are passed, btrfs uses block devices containing btrfs filesystem as listed by blkid. Finally, if '''--all-devices''' or '''-d''' is passed, all the devices under /dev are scanned.
+
; '''stats''' [-z] &lt;path&gt;|&lt;device&gt;
+
: Read and print the device IO stats for all mounted devices of the filesystem identified by &lt;path&gt; or for a single &lt;device&gt;. <br /><code>Options</code><br />
+
:; -z
+
:: Reset stats to zero after reading them.
+
; '''usage''' [options] &lt;path&gt; [&lt;path&gt;…]
+
: Show detailed information about internal allocations in devices. <br /><code>Options</code><br />
+
:; -b|--raw
+
:: raw numbers in bytes, without the '''B''' suffix
+
:; -h|--human-readable
+
:: print human friendly numbers, base 1024, this is the default
+
:; -H
+
:: print human friendly numbers, base 1000
+
:; --iec
+
:: select the 1024 base for the following options, according to the IEC standard
+
:; --si
+
:: select the 1000 base for the following options, according to the SI standard
+
:; -k|--kbytes
+
:: show sizes in KiB, or kB with --si
+
:; -m|--mbytes
+
:: show sizes in MiB, or MB with --si
+
:; -g|--gbytes
+
:: show sizes in GiB, or GB with --si
+
:; -t|--tbytes
+
:: show sizes in TiB, or TB with --si
+
 
+
If conflicting options are passed, the last one takes precedence.
+
 
+
==EXIT STATUS==
+
 
+
'''btrfs device''' returns a zero exit status if it succeeds. Non zero is returned in case of failure.
+
 
+
==AVAILABILITY==
+
 
+
'''btrfs''' is part of btrfs-progs. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for further details.
+
 
+
==SEE ALSO==
+
 
+
[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]], [[Manpage/btrfs-replace|btrfs-replace(8)]], [[Manpage/btrfs-balance|btrfs-balance(8)]]
+
 
+
 
+
[[Category:Manpage]]
+

Latest revision as of 12:29, 12 January 2022

Note: manual pages are located at read-the-docs site, please update your links.


Personal tools