2007-12-28 18:13:38 +03:00
.TH DMSETUP 8 "Apr 06 2006" "Linux" "MAINTENANCE COMMANDS"
2015-09-23 12:25:00 +03:00
.
2001-12-13 16:46:21 +03:00
.SH NAME
2015-09-23 12:25:00 +03:00
.
2014-06-11 13:06:30 +04:00
dmsetup \(em low level logical volume management
2015-09-23 12:25:00 +03:00
.
2001-12-13 16:46:21 +03:00
.SH SYNOPSIS
2015-09-23 12:25:00 +03:00
.
.\".nh
2001-12-13 16:46:21 +03:00
.ad l
2015-09-18 15:34:34 +03:00
.PD 0
2015-09-23 12:25:00 +03:00
.HP 9
.B dmsetup
.de CMD_CLEAR
. BR clear
. IR device_name
..
.CMD_CLEAR
.
.HP
.B dmsetup
.de CMD_CREATE
. ad l
2021-04-11 01:15:51 +03:00
. nh
2015-09-23 12:25:00 +03:00
. BR create
. IR device_name
2021-04-11 01:15:51 +03:00
. RB [ -n | --notable |\: --table
. IR table |\: table_file ]
2017-03-27 17:45:48 +03:00
. RB [ --readahead
2021-04-11 01:15:51 +03:00
. RB [ + ] \fIsectors |\: auto | none ]
2021-04-13 16:26:54 +03:00
. RB [ -u | --uuid
. IR uuid ]
. RB [ --addnodeoncreate |\: --addnodeonresume ]
2021-04-11 01:15:51 +03:00
. hy
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_CREATE
.
.HP
.B dmsetup
2017-08-04 21:38:34 +03:00
.de CMD_CREATE_CONCISE
. ad l
. BR create
. BR --concise
. RI [ concise_device_specification ]
. ad b
..
.CMD_CREATE_CONCISE
.
.HP
.B dmsetup
2015-09-23 12:25:00 +03:00
.de CMD_DEPS
. ad l
. BR deps
2017-03-27 17:45:48 +03:00
. RB [ -o
2015-09-23 12:25:00 +03:00
. IR options ]
2017-02-21 14:25:18 +03:00
. RI [ device_name ...]
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_DEPS
.
.HP
.B dmsetup
.de CMD_HELP
. BR help
2017-03-27 17:45:48 +03:00
. RB [ -c | -C | --columns ]
2015-09-23 12:25:00 +03:00
..
.CMD_HELP
.
.HP
.B dmsetup
.de CMD_INFO
. BR info
2017-02-21 14:25:18 +03:00
. RI [ device_name ...]
2015-09-23 12:25:00 +03:00
..
.CMD_INFO
.
.HP
.B dmsetup
.de CMD_INFOLONG
. ad l
2021-04-11 01:15:51 +03:00
. nh
2015-09-23 12:25:00 +03:00
. BR info
2017-03-27 17:45:48 +03:00
. BR -c | -C | --columns
. RB [ --count
2015-09-23 12:25:00 +03:00
. IR count ]
2017-03-27 17:45:48 +03:00
. RB [ --interval
2015-09-23 12:25:00 +03:00
. IR seconds ]
2021-04-11 01:15:51 +03:00
. RB [ --noheadings ]
2017-03-27 17:45:48 +03:00
. RB [ -o
2015-09-23 12:25:00 +03:00
. IR fields ]
2017-03-27 17:45:48 +03:00
. RB [ -O | --sort
2015-09-23 12:25:00 +03:00
. IR sort_fields ]
2021-04-13 16:26:54 +03:00
. RB [ --nameprefixes ]
2017-03-27 17:45:48 +03:00
. RB [ --separator
2015-09-23 12:25:00 +03:00
. IR separator ]
. RI [ device_name ]
2021-04-11 01:15:51 +03:00
. hy
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_INFOLONG
.
.HP
.B dmsetup
.de CMD_LOAD
. ad l
. BR load
. IR device_name
2017-03-27 17:45:48 +03:00
. RB [ --table
2017-02-19 17:50:49 +03:00
. IR table | table_file ]
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_LOAD
.
.HP
.B dmsetup
.de CMD_LS
. ad l
2021-04-11 01:15:51 +03:00
. nh
2015-09-23 12:25:00 +03:00
. BR ls
2017-03-27 17:45:48 +03:00
. RB [ --target
2015-09-23 12:25:00 +03:00
. IR target_type ]
2021-04-13 16:26:54 +03:00
. RB [ -o
. IR options ]
2017-03-27 17:45:48 +03:00
. RB [ --exec
2015-09-23 12:25:00 +03:00
. IR command ]
2017-03-27 17:45:48 +03:00
. RB [ --tree ]
2021-04-11 01:15:51 +03:00
. hy
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_LS
.
.HP
.B dmsetup
.de CMD_MANGLE
. BR mangle
2017-02-21 14:25:18 +03:00
. RI [ device_name ...]
2015-09-23 12:25:00 +03:00
..
.CMD_MANGLE
.
.HP
.B dmsetup
.de CMD_MESSAGE
. BR message
. IR device_name
. IR sector
. IR message
..
.CMD_MESSAGE
.
.HP
.B dmsetup
.de CMD_MKNODES
. BR mknodes
2017-02-21 14:25:18 +03:00
. RI [ device_name ...]
2015-09-23 12:25:00 +03:00
..
.CMD_MKNODES
.
.HP
.B dmsetup
.de CMD_RELOAD
. ad l
. BR reload
. IR device_name
2017-03-27 17:45:48 +03:00
. RB [ --table
2017-02-19 17:50:49 +03:00
. IR table | table_file ]
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_RELOAD
.
.HP
.B dmsetup
.de CMD_REMOVE
. ad l
. BR remove
2017-03-27 17:45:48 +03:00
. RB [ -f | --force ]
. RB [ --retry ]
. RB [ --deferred ]
2017-02-21 14:25:18 +03:00
. IR device_name ...
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_REMOVE
.
.HP
.B dmsetup
.de CMD_REMOVE_ALL
. BR remove_all
2017-03-27 17:45:48 +03:00
. RB [ -f | --force ]
. RB [ --deferred ]
2015-09-23 12:25:00 +03:00
..
.CMD_REMOVE_ALL
.
.HP
.B dmsetup
.de CMD_RENAME
. BR rename
. IR device_name
. IR new_name
..
.CMD_RENAME
.
.HP
.B dmsetup
.de CMD_RENAME_UUID
. BR rename
. IR device_name
2017-03-27 17:45:48 +03:00
. BR --setuuid
2015-09-23 12:25:00 +03:00
. IR uuid
..
.CMD_RENAME_UUID
.
.HP
.B dmsetup
.de CMD_RESUME
. ad l
. BR resume
2017-02-21 14:25:18 +03:00
. IR device_name ...
2017-03-27 17:45:48 +03:00
. RB [ --addnodeoncreate | --addnodeonresume ]
. RB [ --noflush ]
. RB [ --nolockfs ]
. RB \%[ --readahead
2017-02-19 17:50:49 +03:00
. RB \%[ + ] \fIsectors | auto | none ]
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_RESUME
.
.HP
.B dmsetup
.de CMD_SETGEOMETRY
. ad l
2021-04-11 01:15:51 +03:00
. nh
2015-09-23 12:25:00 +03:00
. BR setgeometry
. IR device_name
. IR cyl
. IR head
. IR sect
. IR start
2021-04-11 01:15:51 +03:00
. hy
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_SETGEOMETRY
.
.HP
.B dmsetup
.de CMD_SPLITNAME
. BR splitname
. IR device_name
. RI [ subsystem ]
..
.CMD_SPLITNAME
.
.HP
.B dmsetup
.de CMD_STATS
. BR stats
. IR command
. RI [ options ]
..
.CMD_STATS
.
.HP
.B dmsetup
.de CMD_STATUS
. ad l
. BR status
2017-03-27 17:45:48 +03:00
. RB [ --target
2015-09-23 12:25:00 +03:00
. IR target_type ]
2017-03-27 17:45:48 +03:00
. RB [ --noflush ]
2017-02-21 14:25:18 +03:00
. RI [ device_name ...]
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_STATUS
.
.HP
.B dmsetup
.de CMD_SUSPEND
. ad l
2021-04-11 01:15:51 +03:00
. nh
2015-09-23 12:25:00 +03:00
. BR suspend
2017-03-27 17:45:48 +03:00
. RB [ --nolockfs ]
. RB [ --noflush ]
2017-02-21 14:25:18 +03:00
. IR device_name ...
2021-04-11 01:15:51 +03:00
. hy
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_SUSPEND
.
.HP
.B dmsetup
.de CMD_TABLE
. ad l
2021-04-11 01:15:51 +03:00
. nh
2015-09-23 12:25:00 +03:00
. BR table
2017-07-25 03:13:14 +03:00
. RB [ --concise ]
2017-03-27 17:45:48 +03:00
. RB [ --target
2015-09-23 12:25:00 +03:00
. IR target_type ]
2017-03-27 17:45:48 +03:00
. RB [ --showkeys ]
2017-02-21 14:25:18 +03:00
. RI [ device_name ...]
2021-04-11 01:15:51 +03:00
. hy
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_TABLE
.
.HP
.B dmsetup
.de CMD_TARGETS
. BR targets
..
.CMD_TARGETS
.
.HP
.B dmsetup
.de CMD_UDEVCOMPLETE
. BR udevcomplete
. IR cookie
..
.CMD_UDEVCOMPLETE
.
.HP
.B dmsetup
.de CMD_UDEVCOMPLETE_ALL
. BR udevcomplete_all
. RI [ age_in_minutes ]
..
.CMD_UDEVCOMPLETE_ALL
.
.HP
.B dmsetup
.de CMD_UDEVCOOKIES
. BR udevcookie
..
.CMD_UDEVCOOKIES
.
.HP
.B dmsetup
2016-01-21 13:36:26 +03:00
.de CMD_UDEVCREATECOOKIE
2015-09-23 12:25:00 +03:00
. BR udevcreatecookie
..
2016-01-21 13:36:26 +03:00
.CMD_UDEVCREATECOOKIE
2015-09-23 12:25:00 +03:00
.
.HP
.B dmsetup
.de CMD_UDEVFLAGS
. BR udevflags
. IR cookie
..
.CMD_UDEVFLAGS
.
.HP
.B dmsetup
.de CMD_UDEVRELEASECOOKIE
. BR udevreleasecookie
. RI [ cookie ]
..
.CMD_UDEVRELEASECOOKIE
.
.HP
.B dmsetup
.de CMD_VERSION
. BR version
..
.CMD_VERSION
.
.HP
.B dmsetup
.de CMD_WAIT
. ad l
2021-04-11 01:15:51 +03:00
. nh
2015-09-23 12:25:00 +03:00
. BR wait
2017-03-27 17:45:48 +03:00
. RB [ --noflush ]
2015-09-23 12:25:00 +03:00
. IR device_name
. RI [ event_nr ]
2021-04-11 01:15:51 +03:00
. hy
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_WAIT
.
.HP
.B dmsetup
.de CMD_WIPE_TABLE
. ad l
2021-04-11 01:15:51 +03:00
. nh
2015-09-23 12:25:00 +03:00
. BR wipe_table
2017-02-21 14:25:18 +03:00
. IR device_name ...
2017-03-27 17:45:48 +03:00
. RB [ -f | --force ]
. RB [ --noflush ]
. RB [ --nolockfs ]
2021-04-11 01:15:51 +03:00
. hy
2015-09-23 12:25:00 +03:00
. ad b
..
.CMD_WIPE_TABLE
2021-04-15 14:16:41 +03:00
.
.TP
\ \&
.
2021-04-13 16:26:54 +03:00
.TP
2015-09-23 12:25:00 +03:00
.B devmap_name \fImajor minor
2021-04-13 16:26:54 +03:00
.TP
2015-09-23 12:25:00 +03:00
.B devmap_name \fImajor:minor
2015-09-18 15:34:34 +03:00
.PD
2015-09-23 12:25:00 +03:00
.ad b
.
2001-12-13 16:46:21 +03:00
.SH DESCRIPTION
2015-09-23 12:25:00 +03:00
.
2017-03-27 17:45:48 +03:00
dmsetup manages logical devices that use the device-mapper driver.
2001-12-14 16:30:04 +03:00
Devices are created by loading a table that specifies a target for
2004-01-23 17:08:09 +03:00
each sector (512 bytes) in the logical device.
2021-04-13 16:26:54 +03:00
.P
2011-11-13 02:48:44 +04:00
The first argument to dmsetup is a command.
2002-06-27 01:50:53 +04:00
The second argument is the logical device name or uuid.
2021-04-13 16:26:54 +03:00
.P
2015-09-23 12:25:00 +03:00
Invoking the dmsetup tool as \fBdevmap_name\fP
(which is not normally distributed and is supported
only for historical reasons) is equivalent to
2017-03-27 17:45:48 +03:00
.BI \%dmsetup\ info\ -c\ --noheadings\ -j \ major\ -m \ minor \c
2015-09-23 12:25:00 +03:00
\fR.
.\" dot above here fixes -Thtml rendering for next HP option
.
2003-09-17 17:23:49 +04:00
.SH OPTIONS
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --addnodeoncreate
2015-09-23 12:25:00 +03:00
Ensure \fI/dev/mapper\fP node exists after \fBdmsetup create\fP.
.
2021-04-13 16:26:54 +03:00
.TP
.B --addnodeonresume
2021-04-15 14:16:41 +03:00
Ensure \fI/dev/mapper\fP node exists after \fBdmsetup\ resume\fP (default with udev).
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --checks
2011-07-01 18:09:19 +04:00
Perform additional checks on the operations requested and report
potential problems. Useful when debugging scripts.
In some cases these checks may slow down operations noticeably.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
2017-03-27 17:45:48 +03:00
.BR -c | -C | --columns
2005-03-29 18:46:30 +04:00
Display output in columns rather than as Field: Value lines.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --count \fIcount
2015-07-31 23:59:34 +03:00
Specify the number of times to repeat a report. Set this to zero
continue until interrupted. The default interval is one second.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
2017-03-27 17:45:48 +03:00
.BR -f | --force
2015-09-18 15:34:34 +03:00
Try harder to complete operation.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
2017-03-27 17:45:48 +03:00
.BR -h | --help
2010-03-08 19:05:07 +03:00
Outputs a summary of the commands available, optionally including
the list of report fields (synonym with \fBhelp\fP command).
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --inactive
2011-11-13 02:48:44 +04:00
When returning any table information from the kernel report on the
2009-11-06 03:43:08 +03:00
inactive table instead of the live table.
Requires kernel driver version 4.16.0 or above.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --interval \fIseconds
2015-07-31 23:59:34 +03:00
Specify the interval in seconds between successive iterations for
2017-03-27 17:45:48 +03:00
repeating reports. If \fB--interval\fP is specified but \fB--count\fP
2015-09-18 15:34:34 +03:00
is not, reports will continue to repeat until interrupted.
2015-07-31 23:59:34 +03:00
The default interval is one second.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.BR --manglename " " auto | hex | none
2012-02-15 16:25:23 +04:00
Mangle any character not on a whitelist using mangling_mode when
2017-03-27 17:45:48 +03:00
processing device-mapper device names and UUIDs. The names and UUIDs
2014-06-11 12:52:16 +04:00
are mangled on input and unmangled on output where the mangling mode
is one of:
2015-09-18 15:34:34 +03:00
\fBauto\fP (only do the mangling if not mangled yet, do nothing
2015-09-23 12:25:00 +03:00
if already mangled, error on mixed),
\fBhex\fP (always do the mangling) and
\fBnone\fP (no mangling).
2015-09-18 15:34:34 +03:00
Default mode is \fB#DEFAULT_MANGLING#\fP.
2021-04-15 14:16:41 +03:00
Character whitelist: 0-9, A-Z, a-z, #+\-.:=@_. This whitelist is
2012-02-15 16:25:23 +04:00
also supported by udev. Any character not on a whitelist is replaced
with its hex value (two digits) prefixed by \\x.
2014-06-05 19:26:53 +04:00
Mangling mode could be also set through
2015-09-23 12:25:00 +03:00
\fBDM_DEFAULT_NAME_MANGLING_MODE\fP
2014-06-05 19:26:53 +04:00
environment variable.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.BR -j | --major " " \fImajor
2005-03-29 18:46:30 +04:00
Specify the major number.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.BR -m | --minor " " \fIminor
2005-03-29 18:46:30 +04:00
Specify the minor number.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
2017-03-27 17:45:48 +03:00
.BR -n | --notable
2014-08-21 12:26:16 +04:00
When creating a device, don't load any table.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --nameprefixes
2015-09-18 15:34:34 +03:00
Add a "DM_" prefix plus the field name to the output. Useful with
2017-03-27 17:45:48 +03:00
\fB--noheadings\fP to produce a list of
2015-09-18 15:34:34 +03:00
field=value pairs that can be used to set environment variables
(for example, in
.BR udev (7)
rules).
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --noheadings
2005-03-29 18:46:30 +04:00
Suppress the headings line when using columnar output.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --noflush
2020-10-03 14:52:37 +03:00
Do not flush outstanding I/O when suspending a device, or do not
2017-03-27 17:45:48 +03:00
commit thin-pool metadata when obtaining thin-pool status.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --nolockfs
2015-09-18 15:34:34 +03:00
Do not attempt to synchronize filesystem eg, when suspending a device.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --noopencount
2005-03-29 18:46:30 +04:00
Tell the kernel not to supply the open reference count for the device.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --noudevrules
2017-03-27 17:45:48 +03:00
Do not allow udev to manage nodes for devices in device-mapper directory.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --noudevsync
2009-07-31 21:51:45 +04:00
Do not synchronise with udev when creating, renaming or removing devices.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.BR -o | --options " " \fIoptions
2007-01-29 22:35:24 +03:00
Specify which fields to display.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.BR --readahead \ [ + ] \fIsectors | auto | none
2007-11-27 23:57:05 +03:00
Specify read ahead size in units of sectors.
2015-09-18 15:34:34 +03:00
The default value is \fBauto\fP which allows the kernel to choose
a suitable value automatically. The \fB+\fP prefix lets you
2007-11-29 17:44:28 +03:00
specify a minimum value which will not be used if it is
smaller than the value chosen by the kernel.
2015-09-18 15:34:34 +03:00
The value \fBnone\fP is equivalent to specifying zero.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
2017-03-27 17:45:48 +03:00
.BR -r | --readonly
Set the table being loaded read-only.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.BR -S | --select " " \fIselection
2017-09-15 01:41:17 +03:00
Process only items that match \fIselection\fP criteria. If the command is
producing report output, adding the "selected" column (\fB-o
selected\fP) displays all rows and shows 1 if the row matches the
\fIselection\fP and 0 otherwise. The selection criteria are defined by
specifying column names and their valid values while making use of supported
comparison operators. As a quick help and to see full list of column names that
can be used in selection and the set of supported selection operators, check
the output of \fBdmsetup\ info\ -c\ -S\ help\fP command.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --table \fItable
2017-03-27 17:45:48 +03:00
Specify a one-line table directly on the command line.
2015-09-18 15:34:34 +03:00
See below for more information on the table format.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --udevcookie \fIcookie
2011-11-13 02:48:44 +04:00
Use cookie for udev synchronisation.
2014-05-27 00:51:04 +04:00
Note: Same cookie should be used for same type of operations i.e. creation of
multiple different devices. It's not adviced to combine different
operations on the single device.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.BR -u | --uuid " " \fIuuid
2015-09-18 15:34:34 +03:00
Specify the \fIuuid\fP.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
2017-03-27 17:45:48 +03:00
.BR -y | --yes
2009-09-23 16:52:52 +04:00
Answer yes to all prompts automatically.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.BR -v | --verbose " [" -v | --verbose ]
2003-09-17 17:23:49 +04:00
Produce additional output.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --verifyudev
2011-06-28 01:43:58 +04:00
If udev synchronisation is enabled, verify that udev operations get performed
correctly and try to fix up the device nodes afterwards if not.
2015-09-23 12:25:00 +03:00
.
2021-04-13 16:26:54 +03:00
.TP
.B --version
2003-09-17 17:23:49 +04:00
Display the library and kernel driver version.
2015-09-23 12:25:00 +03:00
.
2001-12-14 16:30:04 +03:00
.SH COMMANDS
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_CLEAR
2010-05-27 23:00:14 +04:00
.br
Destroys the table in the inactive table slot for device_name.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_CREATE
2001-12-13 16:46:21 +03:00
.br
2003-09-17 17:23:49 +04:00
Creates a device with the given name.
2015-09-18 15:34:34 +03:00
If \fItable\fP or \fItable_file\fP is supplied, the table is loaded and made live.
2017-03-27 17:45:48 +03:00
Otherwise a table is read from standard input unless \fB--notable\fP is used.
2015-09-18 15:34:34 +03:00
The optional \fIuuid\fP can be used in place of
2011-11-13 02:48:44 +04:00
device_name in subsequent dmsetup commands.
2015-09-18 15:34:34 +03:00
If successful the device will appear in table and for live
2015-09-23 12:25:00 +03:00
device the node \fI/dev/mapper/device_name\fP is created.
2015-09-18 15:34:34 +03:00
See below for more information on the table format.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2017-08-04 21:38:34 +03:00
.CMD_CREATE_CONCISE
.br
Creates one or more devices from a concise device specification.
Each device is specified by a comma-separated list: name, uuid, minor number, flags, comma-separated table lines.
Flags defaults to read-write (rw) or may be read-only (ro).
Uuid, minor number and flags are optional so those fields may be empty.
A semi-colon separates specifications of different devices.
Use a backslash to escape the following character, for example a comma or semi-colon in a name or table. See also CONCISE FORMAT below.
2021-04-13 16:26:54 +03:00
.
2017-08-04 21:38:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_DEPS
2001-12-13 16:46:21 +03:00
.br
2012-01-11 16:46:19 +04:00
Outputs a list of devices referenced by the live table for the specified
2015-09-18 15:34:34 +03:00
device. Device names on output can be customised by following \fIoptions\fP:
\fBdevno\fP (major and minor pair, used by default),
\fBblkdevname\fP (block device name),
2017-03-27 17:45:48 +03:00
\fBdevname\fP (map name for device-mapper devices, equal to blkdevname otherwise).
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_HELP
2007-01-29 22:35:24 +03:00
.br
Outputs a summary of the commands available, optionally including
the list of report fields.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_INFO
2001-12-13 16:46:21 +03:00
.br
2011-11-13 02:48:44 +04:00
Outputs some brief information about the device in the form:
.RS
.RS
2017-03-27 17:45:48 +03:00
State: SUSPENDED|ACTIVE, READ-ONLY
2011-11-13 02:48:44 +04:00
Tables present: LIVE and/or INACTIVE
Open reference count
Last event sequence number (used by \fBwait\fP)
Major and minor device number
Number of targets in the live table
UUID
.RE
.RE
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_INFOLONG
2007-01-29 22:35:24 +03:00
.br
Output you can customise.
2017-03-27 17:45:48 +03:00
Fields are comma-separated and chosen from the following list:
2015-09-23 12:25:00 +03:00
.BR name ,
.BR major ,
.BR minor ,
.BR attr ,
.BR open ,
.BR segments ,
.BR events ,
.BR uuid .
Attributes are:
2021-04-13 16:26:54 +03:00
.RB ( L )ive,
.RB ( I )nactive,
.RB ( s )uspended,
.RB ( r )ead-only,
.RB read-( w )rite.
2015-09-18 15:34:34 +03:00
Precede the list with '\fB+\fP' to append
2007-01-29 22:35:24 +03:00
to the default selection of columns instead of replacing it.
2017-03-27 17:45:48 +03:00
Precede any sort field with '\fB-\fP' for a reverse sort on that column.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_LS
2001-12-13 16:46:21 +03:00
.br
2005-05-16 20:04:34 +04:00
List device names. Optionally only list devices that have at least
2005-05-17 00:46:46 +04:00
one target of the specified type. Optionally execute a command for
each device. The device name is appended to the supplied command.
2015-09-23 12:25:00 +03:00
Device names on output can be customised by following options:
\fBdevno\fP (major and minor pair, used by default),
\fBblkdevname\fP (block device name),
2017-03-27 17:45:48 +03:00
\fBdevname\fP (map name for device-mapper devices, equal to blkdevname otherwise).
\fB--tree\fP displays dependencies between devices as a tree.
It accepts a comma-separate list of \fIoptions\fP.
2006-04-06 20:20:40 +04:00
Some specify the information displayed against each node:
2015-09-18 15:34:34 +03:00
.BR device / nodevice ;
.BR blkdevname ;
.BR active ", " open ", " rw ", " uuid .
2006-04-06 20:20:40 +04:00
Others specify how the tree is displayed:
2015-09-18 15:34:34 +03:00
.BR ascii ", " utf ", " vt100 ;
.BR compact ", " inverted ", " notrunc .
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.BR load | \c
.CMD_RELOAD
2003-09-17 17:23:49 +04:00
.br
2015-09-18 15:34:34 +03:00
Loads \fItable\fP or \fItable_file\fP into the inactive table slot for device_name.
2006-08-10 18:11:03 +04:00
If neither is supplied, reads a table from standard input.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_MANGLE
2012-01-18 22:52:02 +04:00
.br
2017-03-27 17:45:48 +03:00
Ensure existing device-mapper \fIdevice_name\fP and UUID is in the correct mangled
2015-09-18 15:34:34 +03:00
form containing only whitelisted characters (supported by udev) and do
a rename if necessary. Any character not on the whitelist will be mangled
2017-03-27 17:45:48 +03:00
based on the \fB--manglename\fP setting. Automatic rename works only for device
2015-09-18 15:34:34 +03:00
names and not for device UUIDs because the kernel does not allow changing
the UUID of active devices. Any incorrect UUIDs are reported only and they
must be manually corrected by deactivating the device first and then
2017-03-27 17:45:48 +03:00
reactivating it with proper mangling mode used (see also \fB--manglename\fP).
2015-09-23 12:25:00 +03:00
.
2012-01-18 22:52:02 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_MESSAGE
2006-11-23 23:34:16 +03:00
.br
Send message to target. If sector not needed use 0.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_MKNODES
2002-06-27 01:50:53 +04:00
.br
2015-09-23 12:25:00 +03:00
Ensure that the node in \fI/dev/mapper\fP for \fIdevice_name\fP is correct.
If no device_name is supplied, ensure that all nodes in \fI/dev/mapper\fP
2017-03-27 17:45:48 +03:00
correspond to mapped devices currently loaded by the device-mapper kernel
2006-06-18 15:35:04 +04:00
driver, adding, changing or removing nodes as necessary.
2015-09-23 12:25:00 +03:00
.
2012-02-15 16:25:23 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_REMOVE
2006-06-18 15:35:04 +04:00
.br
2014-08-16 03:34:48 +04:00
Removes a device. It will no longer be visible to dmsetup. Open devices
2017-03-27 17:45:48 +03:00
cannot be removed, but adding \fB--force\fP will replace the table with one
that fails all I/O. \fB--deferred\fP will enable deferred removal of open
2014-08-16 03:34:48 +04:00
devices - the device will be removed when the last user closes it. The deferred
2017-03-27 17:45:48 +03:00
removal feature is supported since version 4.27.0 of the device-mapper
2014-08-16 03:34:48 +04:00
driver available in upstream kernel version 3.13. (Use \fBdmsetup version\fP
to check this.) If an attempt to remove a device fails, perhaps because a process run
2017-03-27 17:45:48 +03:00
from a quick udev rule temporarily opened the device, the \fB--retry\fP
2014-08-16 03:34:48 +04:00
option will cause the operation to be retried for a few seconds before failing.
Do NOT combine
2017-03-27 17:45:48 +03:00
\fB--force\fP and \fB--udevcookie\fP, as udev may start to process udev
2014-08-16 03:34:48 +04:00
rules in the middle of error target replacement and result in nondeterministic
result.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_REMOVE_ALL
2014-08-16 03:34:48 +04:00
.br
Attempts to remove all device definitions i.e. reset the driver. This also runs
\fBmknodes\fP afterwards. Use with care! Open devices cannot be removed, but
2017-03-27 17:45:48 +03:00
adding \fB--force\fP will replace the table with one that fails all I/O.
\fB--deferred\fP will enable deferred removal of open devices - the device
2014-08-16 03:34:48 +04:00
will be removed when the last user closes it. The deferred removal feature is
2017-03-27 17:45:48 +03:00
supported since version 4.27.0 of the device-mapper driver available in
2015-09-18 15:34:34 +03:00
upstream kernel version 3.13.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_RENAME
2003-09-17 17:23:49 +04:00
.br
Renames a device.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_RENAME_UUID
2010-10-15 05:10:27 +04:00
.br
Sets the uuid of a device that was created without a uuid.
After a uuid has been set it cannot be changed.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_RESUME
2011-11-13 02:48:44 +04:00
.br
2017-03-27 17:45:48 +03:00
Un-suspends a device.
2003-09-17 17:23:49 +04:00
If an inactive table has been loaded, it becomes live.
2017-03-27 17:45:48 +03:00
Postponed I/O then gets re-queued for processing.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_SETGEOMETRY
2006-11-23 23:34:16 +03:00
.br
Sets the device geometry to C/H/S.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_SPLITNAME
2009-09-23 16:52:52 +04:00
.br
2015-09-23 12:25:00 +03:00
Splits given \fIdevice name\fP into \fIsubsystem\fP constituents.
2015-09-18 15:34:34 +03:00
The default subsystem is LVM.
2014-06-23 17:01:31 +04:00
LVM currently generates device names by concatenating the names of the Volume
Group, Logical Volume and any internal Layer with a hyphen as separator.
Any hyphens within the names are doubled to escape them.
The precise encoding might change without notice in any future
release, so we recommend you always decode using the current version of
this command.
2015-09-18 15:34:34 +03:00
.HP
2016-09-26 13:36:04 +03:00
.CMD_STATS
2015-09-18 15:34:34 +03:00
.br
Manages IO statistics regions for devices.
2015-09-23 12:25:00 +03:00
See
2015-09-18 15:34:34 +03:00
.BR dmstats (8)
for more details.
.HP
2016-09-26 13:36:04 +03:00
.CMD_STATUS
2002-06-27 01:50:53 +04:00
.br
Outputs status information for each of the device's targets.
2017-03-27 17:45:48 +03:00
With \fB--target\fP, only information relating to the specified target type
any is displayed. With \fB--noflush\fP, the thin target (from version 1.3.0)
2012-07-27 23:03:07 +04:00
doesn't commit any outstanding changes to disk before reporting its statistics.
2021-04-13 16:26:54 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_SUSPEND
2002-06-27 01:50:53 +04:00
.br
2003-09-17 17:23:49 +04:00
Suspends a device. Any I/O that has already been mapped by the device
but has not yet completed will be flushed. Any further I/O to that
device will be postponed for as long as the device is suspended.
2011-11-13 02:48:44 +04:00
If there's a filesystem on the device which supports the operation,
2017-03-27 17:45:48 +03:00
an attempt will be made to sync it first unless \fB--nolockfs\fP is specified.
2006-10-12 19:42:25 +04:00
Some targets such as recent (October 2006) versions of multipath may support
2017-03-27 17:45:48 +03:00
the \fB--noflush\fP option. This lets outstanding I/O that has not yet reached the
2006-10-12 19:42:25 +04:00
device to remain unflushed.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_TABLE
2002-06-27 01:50:53 +04:00
.br
2003-09-17 17:23:49 +04:00
Outputs the current table for the device in a format that can be fed
back in using the create or load commands.
2017-03-27 17:45:48 +03:00
With \fB--target\fP, only information relating to the specified target type
2005-05-16 18:53:23 +04:00
is displayed.
2017-11-10 15:55:04 +03:00
Real encryption keys are suppressed in the table output for crypt and integrity
targets unless the \fB--showkeys\fP parameter is supplied. Kernel key
2017-02-10 15:19:22 +03:00
references prefixed with \fB:\fP are not affected by the parameter and get
2017-11-10 15:55:04 +03:00
displayed always (crypt target only).
2017-07-25 03:13:14 +03:00
With \fB--concise\fP, the output is presented concisely on a single line.
2017-07-25 14:22:46 +03:00
Commas then separate the name, uuid, minor device number, flags ('ro' or 'rw')
and the table (if present). Semi-colons separate devices. Backslashes escape
2017-08-04 21:38:34 +03:00
any commas, semi-colons or backslashes. See CONCISE FORMAT below.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_TARGETS
2004-02-27 22:36:49 +03:00
.br
2017-03-27 17:45:48 +03:00
Displays the names and versions of the currently-loaded targets.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_UDEVCOMPLETE
2011-11-13 02:48:44 +04:00
.br
Wake any processes that are waiting for udev to complete processing the specified cookie.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_UDEVCOMPLETE_ALL
2011-11-13 02:48:44 +04:00
.br
Remove all cookies older than the specified number of minutes.
Any process waiting on a cookie will be resumed immediately.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_UDEVCOOKIES
2011-11-13 02:48:44 +04:00
.br
2017-03-27 17:45:48 +03:00
List all existing cookies. Cookies are system-wide semaphores with keys
2011-11-13 02:48:44 +04:00
prefixed by two predefined bytes (0x0D4D).
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_UDEVCREATECOOKIE
2010-02-15 19:32:24 +03:00
.br
Creates a new cookie to synchronize actions with udev processing.
The output is a cookie value. Normally we don't need to create cookies since
dmsetup creates and destroys them for each action automatically. However, we can
generate one explicitly to group several actions together and use only one
cookie instead. We can define a cookie to use for each relevant command by using
2017-03-27 17:45:48 +03:00
\fB--udevcookie\fP option. Alternatively, we can export this value into the environment
2013-05-05 23:38:44 +04:00
of the dmsetup process as \fBDM_UDEV_COOKIE\fP variable and it will be used automatically
2010-02-15 19:32:24 +03:00
with all subsequent commands until it is unset.
2017-03-27 17:45:48 +03:00
Invoking this command will create system-wide semaphore that needs to be cleaned
2010-02-15 19:32:24 +03:00
up explicitly by calling udevreleasecookie command.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_UDEVFLAGS
2009-10-22 17:12:20 +04:00
.br
2015-09-23 12:25:00 +03:00
Parses given \fIcookie\fP value and extracts any udev control flags encoded.
2009-10-22 17:12:20 +04:00
The output is in environment key format that is suitable for use in udev
2011-03-10 16:11:45 +03:00
rules. If the flag has its symbolic name assigned then the output is
2015-09-23 12:25:00 +03:00
DM_UDEV_FLAG_<flag_name> = '1', DM_UDEV_FLAG<flag_position> = '1' otherwise.
2009-10-22 17:12:20 +04:00
Subsystem udev flags don't have symbolic names assigned and these ones are
2015-09-23 12:25:00 +03:00
always reported as DM_SUBSYSTEM_UDEV_FLAG<flag_position> = '1'. There are
2009-10-22 17:12:20 +04:00
16 udev flags altogether.
2015-09-23 12:25:00 +03:00
.
2011-11-13 02:48:44 +04:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_UDEVRELEASECOOKIE
2009-07-31 21:51:45 +04:00
.br
2011-11-13 02:48:44 +04:00
Waits for all pending udev processing bound to given cookie value and clean up
the cookie with underlying semaphore. If the cookie is not given directly,
2013-05-05 23:38:44 +04:00
the command will try to use a value defined by \fBDM_UDEV_COOKIE\fP environment variable.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_VERSION
2002-06-27 01:50:53 +04:00
.br
Outputs version information.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_WAIT
2003-09-17 17:23:49 +04:00
.br
2004-02-27 22:36:49 +03:00
Sleeps until the event counter for device_name exceeds event_nr.
2017-03-27 17:45:48 +03:00
Use \fB-v\fP to see the event number returned.
2004-02-27 22:36:49 +03:00
To wait until the next event is triggered, use \fBinfo\fP to find
2011-11-13 02:48:44 +04:00
the last event number.
2017-03-27 17:45:48 +03:00
With \fB--noflush\fP, the thin target (from version 1.3.0) doesn't commit
2012-07-27 23:03:07 +04:00
any outstanding changes to disk before reporting its statistics.
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.HP
2015-09-23 12:25:00 +03:00
.CMD_WIPE_TABLE
2015-09-18 15:34:34 +03:00
.br
2017-03-27 17:45:48 +03:00
Wait for any I/O in-flight through the device to complete, then
2015-09-18 15:34:34 +03:00
replace the table with a new table that fails any new I/O
sent to the device. If successful, this should release any devices
held open by the device's table(s).
2015-09-23 12:25:00 +03:00
.
2001-12-14 16:30:04 +03:00
.SH TABLE FORMAT
2015-09-23 12:25:00 +03:00
.
2001-12-14 16:30:04 +03:00
Each line of the table specifies a single target and is of the form:
2015-09-23 12:25:00 +03:00
.sp
2011-11-13 02:48:44 +04:00
.I logical_start_sector num_sectors
.B target_type
2015-09-18 15:34:34 +03:00
.I target_args
2015-09-23 12:25:00 +03:00
.sp
Simple target types and target args include:
.
.TP
.B linear \fIdestination_device start_sector
2001-12-13 16:46:21 +03:00
The traditional linear mapping.
2015-09-23 12:25:00 +03:00
.TP
.B striped \fInum_stripes chunk_size \fR[\fIdestination start_sector\fR]...
2001-12-14 16:30:04 +03:00
Creates a striped area.
2001-12-13 16:46:21 +03:00
.br
2001-12-14 16:30:04 +03:00
e.g. striped 2 32 /dev/hda1 0 /dev/hdb1 0
will map the first chunk (16k) as follows:
2011-11-13 02:48:44 +04:00
.RS
2021-04-13 16:26:54 +03:00
.IP
2021-04-15 14:16:41 +03:00
LV chunk 1 \[->] hda1, chunk 1
LV chunk 2 \[->] hdb1, chunk 1
LV chunk 3 \[->] hda1, chunk 2
LV chunk 4 \[->] hdb1, chunk 2
2011-11-13 02:48:44 +04:00
etc.
.RE
2015-09-23 12:25:00 +03:00
.TP
2011-11-13 02:48:44 +04:00
.B error
2001-12-14 16:30:04 +03:00
Errors any I/O that goes to this area. Useful for testing or
for creating devices with holes in them.
2015-09-23 12:25:00 +03:00
.TP
2011-12-01 02:32:37 +04:00
.B zero
Returns blocks of zeroes on reads. Any data written is discarded silently.
2017-03-27 17:45:48 +03:00
This is a block-device equivalent of the \fI/dev/zero\fP
character-device data sink described in \fBnull\fP(4).
2015-09-23 12:25:00 +03:00
.P
2011-12-01 02:32:37 +04:00
More complex targets include:
2015-09-23 12:25:00 +03:00
.TP
2015-09-18 15:34:34 +03:00
.B cache
Improves performance of a block device (eg, a spindle) by dynamically
migrating some of its data to a faster smaller device (eg, an SSD).
2015-09-23 12:25:00 +03:00
.TP
2011-11-13 02:48:44 +04:00
.B crypt
2011-12-01 02:32:37 +04:00
Transparent encryption of block devices using the kernel crypto API.
2015-09-23 12:25:00 +03:00
.TP
2011-11-13 02:48:44 +04:00
.B delay
2011-12-01 02:32:37 +04:00
Delays reads and/or writes to different devices. Useful for testing.
2015-09-23 12:25:00 +03:00
.TP
2011-11-13 02:48:44 +04:00
.B flakey
2011-12-01 02:32:37 +04:00
Creates a similar mapping to the linear target but
exhibits unreliable behaviour periodically.
Useful for simulating failing devices when testing.
2015-09-23 12:25:00 +03:00
.TP
2011-11-13 02:48:44 +04:00
.B mirror
2011-12-01 02:32:37 +04:00
Mirrors data across two or more devices.
2015-09-23 12:25:00 +03:00
.TP
2011-11-13 02:48:44 +04:00
.B multipath
2011-12-01 02:32:37 +04:00
Mediates access through multiple paths to the same device.
2015-09-23 12:25:00 +03:00
.TP
2015-09-18 15:34:34 +03:00
.B raid
2011-12-01 02:32:37 +04:00
Offers an interface to the kernel's software raid driver, md.
2015-09-23 12:25:00 +03:00
.TP
2011-12-01 02:32:37 +04:00
.B snapshot
Supports snapshots of devices.
2015-09-23 12:25:00 +03:00
.TP
2017-03-27 17:45:48 +03:00
.BR thin ", " thin-pool
2015-09-18 15:34:34 +03:00
Supports thin provisioning of devices and also provides a better snapshot support.
2011-12-01 02:32:37 +04:00
.P
To find out more about the various targets and their table formats and status
2017-03-27 17:45:48 +03:00
lines, please read the files in the Documentation/device-mapper directory in
2014-06-11 12:52:16 +04:00
the kernel source tree.
(Your distribution might include a copy of this information in the
2017-03-27 17:45:48 +03:00
documentation directory for the device-mapper package.)
2015-09-23 12:25:00 +03:00
.
2001-12-14 16:30:04 +03:00
.SH EXAMPLES
2015-09-23 12:25:00 +03:00
.
2021-04-15 14:16:41 +03:00
.nf
2001-12-13 16:46:21 +03:00
# A table to join two disks together
0 1028160 linear /dev/hda 0
1028160 3903762 linear /dev/hdb 0
2021-04-15 14:16:41 +03:00
.P
2011-11-13 02:48:44 +04:00
# A table to stripe across the two disks,
2001-12-13 16:46:21 +03:00
# and add the spare space from
# hdb to the back of the volume
0 2056320 striped 2 32 /dev/hda 0 /dev/hdb 0
2056320 2875602 linear /dev/hdb 1028160
2021-04-15 14:16:41 +03:00
.fi
2015-09-23 12:25:00 +03:00
.
2017-08-04 21:38:34 +03:00
.SH CONCISE FORMAT
.
A concise representation of one of more devices.
.sp
.br
- A comma separates the fields of each device.
.br
- A semi-colon separates devices.
.TP
The representation of a device takes the form:
2021-04-11 01:15:51 +03:00
.ad l
.nh
<name>,<uuid>,\:<minor>,<flags>,\:<table>\:[,<table>+]\:[;<dev_name>,<uuid>,\:<minor>,<flags>,<table>\:[,<table>+]]
.hy
.ad b
2017-08-04 21:38:34 +03:00
.TP
The fields are:
.
.TP
.B name
The name of the device.
.TP
.B uuid
The UUID of the device (or empty).
.TP
.B minor
The minor number of the device. If empty, the kernel assigns a suitable minor number.
.TP
.B flags
Supported flags are:
2021-04-15 14:16:41 +03:00
.br
.ad l
2017-08-04 21:38:34 +03:00
.B ro
Sets the table being loaded for the device read-only
.br
.B rw
Sets the table being loaded for the device read-write (default)
2021-04-15 14:16:41 +03:00
.ad b
2017-08-04 21:38:34 +03:00
.TP
.B table
One line of the table. See TABLE FORMAT above.
.
.SH EXAMPLES
.
2021-04-15 14:16:41 +03:00
.PD 0
2021-04-11 01:15:51 +03:00
.ad l
.nh
2021-04-15 14:16:41 +03:00
# A simple linear read-only device
.TP
2021-04-11 01:15:51 +03:00
test-linear-small,,,ro,\:0 2097152 linear /dev/loop0 0,\:2097152 2097152 linear /dev/loop1 0
2021-04-15 14:16:41 +03:00
.P
2017-08-04 21:38:34 +03:00
# Two linear devices
2021-04-15 14:16:41 +03:00
.TP
2021-04-11 01:15:51 +03:00
test-linear-small,,,,\:0 2097152 linear /dev/loop0 0;\:test-linear-large,\:,,,\:0 2097152 linear /dev/loop1 0, 2097152 2097152 linear /dev/loop2 0
.hy
.ad b
2021-04-15 14:16:41 +03:00
.PD
2017-08-04 21:38:34 +03:00
.
2007-10-09 16:14:48 +04:00
.SH ENVIRONMENT VARIABLES
2015-09-23 12:25:00 +03:00
.
2007-10-09 16:14:48 +04:00
.TP
2011-11-13 02:48:44 +04:00
.B DM_DEV_DIR
2007-10-09 16:14:48 +04:00
The device directory name.
2015-09-23 12:25:00 +03:00
Defaults to "\fI/dev\fP" and must be an absolute path.
2010-02-15 19:32:24 +03:00
.TP
2011-11-13 02:48:44 +04:00
.B DM_UDEV_COOKIE
2010-02-15 19:32:24 +03:00
A cookie to use for all relevant commands to synchronize with udev processing.
2017-03-27 17:45:48 +03:00
It is an alternative to using \fB--udevcookie\fP option.
2014-06-05 19:26:53 +04:00
.TP
.B DM_DEFAULT_NAME_MANGLING_MODE
2015-09-18 15:34:34 +03:00
A default mangling mode. Defaults to "\fB#DEFAULT_MANGLING#\fP"
2017-03-27 17:45:48 +03:00
and it is an alternative to using \fB--manglename\fP option.
2015-09-23 12:25:00 +03:00
.
2001-12-13 16:46:21 +03:00
.SH AUTHORS
2015-09-23 12:25:00 +03:00
.
Original version: Joe Thornber <thornber@redhat.com>
.
2004-02-27 22:36:49 +03:00
.SH SEE ALSO
2015-09-23 12:25:00 +03:00
.
2015-09-18 15:34:34 +03:00
.BR dmstats (8),
.BR udev (7),
.BR udevadm (8)
2015-09-23 12:25:00 +03:00
.P
2021-04-15 14:16:41 +03:00
LVM2 resource page:
.UR https://www.sourceware.org/lvm2
.UE
2014-06-11 12:52:16 +04:00
.br
2021-04-15 14:16:41 +03:00
Device-mapper resource page:
.UR http://sources.redhat.com/dm
.UE