1
0
mirror of git://sourceware.org/git/lvm2.git synced 2024-12-25 01:34:38 +03:00
lvm2/man/dmsetup.8.in

222 lines
4.8 KiB
Groff
Raw Normal View History

.TH DMSETUP 8 "Sep 17 2003" "Linux" "MAINTENTANCE COMMANDS"
2001-12-13 16:46:21 +03:00
.SH NAME
dmsetup \- low level logical volume management
.SH SYNOPSIS
.ad l
.B dmsetup create
2003-11-17 17:24:22 +03:00
.I device_name [-u uuid] [--notable] [table_file]
2001-12-13 16:46:21 +03:00
.br
.B dmsetup remove
.I device_name
2001-12-13 16:46:21 +03:00
.br
.B dmsetup load
2003-11-17 17:24:22 +03:00
.I device_name [table_file]
.br
.B dmsetup clear
2003-11-17 17:24:22 +03:00
.I device_name
.br
2001-12-13 16:46:21 +03:00
.B dmsetup suspend
.I device_name
2001-12-13 16:46:21 +03:00
.br
.B dmsetup resume
.I device_name
2001-12-13 16:46:21 +03:00
.br
.B dmsetup reload
2003-11-17 17:24:22 +03:00
.I device_name [table_file]
2001-12-13 16:46:21 +03:00
.br
.B dmsetup rename
.I device_name new_name
.br
.B dmsetup ls
.br
2001-12-13 16:46:21 +03:00
.B dmsetup info
.I [device_name]
.br
.B dmsetup deps
.I [device_name]
.br
2003-11-17 17:24:22 +03:00
.B dmsetup mknodes
.I [device_name]
.br
.B dmsetup status
.I [device_name]
.br
.B dmsetup table
.I [device_name]
.br
.B dmsetup wait
.I device_name
.br
.B dmsetup remove_all
.br
.B dmsetup version
2001-12-13 16:46:21 +03:00
.ad b
.SH DESCRIPTION
dmsetup manages logical devices that use the device-mapper driver.
Devices are created by loading a table that specifies a target for
each sector (512 bytes) in the logical device.
2001-12-13 16:46:21 +03:00
The first argument to dmsetup is a command.
The second argument is the logical device name or uuid.
.SH OPTIONS
.IP \fB-j|--major\ \fImajor
.br
Specify the major number to use on creation.
.IP \fB-j|--minor\ \fIminor
.br
Specify the minor number to use on creation.
.IP \fB-r|--readonly
.br
Set the table being loaded read-only.
.IP \fB-v|--verbose [-v|--verbose]
.br
Produce additional output.
.IP \fB--version
.br
Display the library and kernel driver version.
.SH COMMANDS
2001-12-13 16:46:21 +03:00
.IP \fBcreate
2003-11-17 17:24:22 +03:00
.I device_name [-u uuid] [--notable] [table_file]
2001-12-13 16:46:21 +03:00
.br
Creates a device with the given name.
2003-11-17 17:24:22 +03:00
If table_file is supplied, the table is loaded and made live.
Otherwise a table is read from standard input unless --notable is used.
The optional uuid can be used in place of
2003-11-17 17:24:22 +03:00
device_name in subsequent dmsetup commands.
If successful a device will appear as
/dev/device-mapper/<device-name>.
See below for information on the table format.
.IP \fBdeps
.I device_name
2001-12-13 16:46:21 +03:00
.br
Outputs a list of (major, minor) pairs for devices referenced by the
live table for the specified device.
.IP \fBinfo
.I device_name
2001-12-13 16:46:21 +03:00
.br
Outputs some brief information about the device in the form:
2001-12-13 16:46:21 +03:00
.br
State: SUSPENDED|ACTIVE, READ-ONLY
2001-12-13 16:46:21 +03:00
.br
Tables present: LIVE and/or INACTIVE
2001-12-13 16:46:21 +03:00
.br
Open reference count
2001-12-13 16:46:21 +03:00
.br
Last event sequence number (used by \fBwait\fP)
2001-12-13 16:46:21 +03:00
.br
Major and minor device number
2001-12-13 16:46:21 +03:00
.br
Number of targets in the live table
2003-11-17 17:24:22 +03:00
.br
UUID
.IP \fBls
2001-12-13 16:46:21 +03:00
.br
List device names.
.IP \fBload|reload
2003-11-17 17:24:22 +03:00
.I device_name [table_file]
.br
Loads table_file into the inactive table slot for device_name.
2003-11-17 17:24:22 +03:00
If table_file is not supplied, reads a table from standard input.
.IP \fBremove
.I device_name
.br
Removes a device. It will no longer be visible to dmsetup and
will be deleted when its open_count is zero.
.IP \fBremove_all
.br
Attempts to remove all device definitions i.e. reset the driver.
Use with care!
.IP \fBrename
.I device_name new_name
.br
Renames a device.
.IP \fBresume
.I device_name
.br
Un-suspends a device.
If an inactive table has been loaded, it becomes live.
Postponed I/O then gets re-queued for processing.
.IP \fBstatus
.I device_name
.br
Outputs status information for each of the device's targets.
.IP \fBsuspend
.I device_name
.br
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.
.IP \fBtable
.I device_name
.br
Outputs the current table for the device in a format that can be fed
back in using the create or load commands.
.IP \fBversion
.I device_name
.br
Outputs version information.
.IP \fBwait
.I device_name
.br
Sleeps until an event is triggered against a device.
.SH TABLE FORMAT
Each line of the table specifies a single target and is of the form:
2001-12-13 16:46:21 +03:00
.br
logical_start_sector num_sectors target_type target_args
2001-12-13 16:46:21 +03:00
.br
.br
There are currently three simple target types available together
with more complex optional ones that implement snapshots and mirrors.
2001-12-13 16:46:21 +03:00
.IP \fBlinear
.I destination_device start_sector
2001-12-13 16:46:21 +03:00
.br
The traditional linear mapping.
.IP \fBstriped
.I num_stripes chunk_size [destination start_sector]+
2001-12-13 16:46:21 +03:00
.br
Creates a striped area.
2001-12-13 16:46:21 +03:00
.br
e.g. striped 2 32 /dev/hda1 0 /dev/hdb1 0
will map the first chunk (16k) as follows:
2001-12-13 16:46:21 +03:00
.br
LV chunk 1 -> hda1, chunk 1
.br
LV chunk 2 -> hdb1, chunk 1
.br
LV chunk 3 -> hda1, chunk 2
.br
LV chunk 4 -> hdb1, chunk 2
.br
etc.
.IP \fBerror
2001-12-13 16:46:21 +03:00
.br
Errors any I/O that goes to this area. Useful for testing or
for creating devices with holes in them.
2001-12-13 16:46:21 +03:00
.SH EXAMPLES
2001-12-13 16:46:21 +03:00
# A table to join two disks together
.br
.br
2001-12-13 16:46:21 +03:00
0 1028160 linear /dev/hda 0
.br
1028160 3903762 linear /dev/hdb 0
# A table to stripe across the two disks,
.br
# and add the spare space from
.br
# hdb to the back of the volume
0 2056320 striped 2 32 /dev/hda 0 /dev/hdb 0
.br
2056320 2875602 linear /dev/hdb 1028160
.SH AUTHORS
Original version: Joe Thornber (thornber@sistina.com)