sd_alias: use DEVPATH instead of path_id to extract SCSI ID
[nas-tools.git] / sd_alias / README
1 Introduction
2 ------------
3
4 On multi-disk devices, there is no warranty about the disk node names.
5 For example, on a given system the node names for disk {0,1} could be
6 /dev/sd{a,b}. On the same system, with an extra eSATA or USB disk plugged, the
7 same disks could hold very different node names. This can be quite confusing
8 for the userspace applications.
9
10 On NAS devices, there is an additional constraints: a way must be available to
11 associate a disk with a casing slot. For example, if a disk is defective, the
12 corresponding fail LED must be set up. One will have to translate a disk node
13 name into a slot or a LED number.
14
15 Example: /dev/sdb => /sys/class/leds/net5big-v2:blue:sata4
16
17 On a given device, each SATA disk have an unique and constant SCSI ID. This ID
18 can be used to create some helpful aliases.
19
20 What is sd_alias ?
21 ------------------
22
23 sd_alias is an udev script which can be used to create SCSI disks aliases.
24 An alias is associated with a single SCSI ID. Aliases are stored under
25 /dev/disk/by-alias/. Each alias is a symlink pointing the real device node.
26
27 SCSI disk aliases example on a 5Big Network v2:
28
29 # ls -l /dev/disk/
30
31 How to configure sd_alias ?
32 ---------------------------
33
34 Configuration must be stored in the /etc/sd_alias.conf file.
35 Each sd_alias.conf line must respect the syntax "${scsi_id} ${alias_name}".
36 The SCSI ID format is "host:channel:id:lun"
37
38 Configuration file example for a 5Big Network v2:
39
40 0:3:0:0 sata0
41 0:2:0:0 sata1
42 0:1:0:0 sata2
43 1:2:0:0 sata3
44 1:1:0:0 sata4
45
46 Some possible configurations files for the Kirkwood based LaCie NASes are
47 available under the "conf" repository in sd_alias sources.
48
49 How to install ?
50 ----------------
51
52 Just go in the sd_alias source repository and do
53
54         make install
55
56 and add a /etc/sd_alias.conf file (refer to the previous section).