]>
Commit | Line | Data |
---|---|---|
821b6834 NB |
1 | .TH vdev_id 8 |
2 | .SH NAME | |
3 | vdev_id \- generate user-friendly names for JBOD disks | |
4 | .SH SYNOPSIS | |
5 | .LP | |
6 | .nf | |
7 | \fBvdev_id\fR <-d dev> [-c config_file] [-g sas_direct|sas_switch] | |
8 | [-m] [-p phys_per_port] | |
9 | \fBvdev_id\fR -h | |
10 | .fi | |
11 | .SH DESCRIPTION | |
12 | The \fBvdev_id\fR command is a udev helper which parses the file | |
13 | .BR /etc/zfs/vdev_id.conf (5) | |
14 | to map a physical path in a storage topology to a channel name. The | |
15 | channel name is combined with a disk enclosure slot number to create an | |
16 | alias that reflects the physical location of the drive. This is | |
17 | particularly helpful when it comes to tasks like replacing failed | |
18 | drives. Slot numbers may also be re-mapped in case the default | |
19 | numbering is unsatisfactory. The drive aliases will be created as | |
20 | symbolic links in /dev/disk/by-vdev. | |
21 | ||
2957f38d NB |
22 | The currently supported topologies are sas_direct and sas_switch. A |
23 | multipath mode is supported in which dm-mpath devices are handled by | |
24 | examining the first-listed running component disk as reported by the | |
821b6834 NB |
25 | .BR multipath (8) |
26 | command. In multipath mode the configuration file should contain a | |
27 | channel definition with the same name for each path to a given | |
28 | enclosure. | |
29 | ||
2957f38d NB |
30 | .BR vdev_id |
31 | also supports creating aliases based on existing udev links in the /dev | |
32 | hierarchy using the \fIalias\fR configuration file keyword. See the | |
33 | .BR vdev_id.conf (5) | |
34 | man page for details. | |
35 | ||
821b6834 NB |
36 | .SH OPTIONS |
37 | .TP | |
38 | \fB\-c\fR <config_file> | |
39 | Specifies the path to an alternate configuration file. The default is | |
40 | /etc/zfs/vdev_id.conf. | |
41 | .TP | |
42 | \fB\-d\fR <device> | |
43 | This is the only mandatory argument. Specifies the name of a device | |
44 | in /dev, i.e. "sda". | |
45 | .TP | |
46 | \fB\-g\fR <sas_direct|sas_switch> | |
47 | Identifies a physical topology that governs how physical paths are | |
48 | mapped to channels. | |
49 | ||
50 | \fIsas_direct\fR - in this mode a channel is uniquely identified by | |
51 | a PCI slot and a HBA port number | |
52 | ||
53 | \fIsas_switch\fR - in this mode a channel is uniquely identified by | |
54 | a SAS switch port number | |
55 | .TP | |
56 | \fB\-m\fR | |
57 | Specifies that | |
58 | .BR vdev_id (8) | |
59 | will handle only dm-multipath devices. If set to "yes" then | |
60 | .BR vdev_id (8) | |
61 | will examine the first running component disk of a dm-multipath | |
62 | device as listed by the | |
63 | .BR multipath (8) | |
64 | command to determine the physical path. | |
65 | .TP | |
66 | \fB\-p\fR <phys_per_port> | |
67 | Specifies the number of PHY devices associated with a SAS HBA port or SAS | |
68 | switch port. | |
69 | .BR vdev_id (8) | |
70 | internally uses this value to determine which HBA or switch port a | |
71 | device is connected to. The default is 4. | |
72 | .TP | |
73 | \fB\-h\fR | |
74 | Print a usage summary. | |
75 | .SH SEE ALSO | |
76 | .LP | |
77 | \fBvdev_id.conf\fR(5) |