2 .\" This file and its contents are supplied under the terms of the
3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 .\" You may only use this file in accordance with the terms of version
7 .\" A full copy of the text of the CDDL should have accompanied this
8 .\" source. A copy of the CDDL is also available via the Internet at
9 .\" http://www.illumos.org/license/CDDL.
17 .Nd generate user-friendly names for JBOD disks
22 .Fl g Sy sas_direct Ns | Ns Sy sas_switch Ns | Ns Sy scsi
24 .Fl p Ar phys_per_port
28 is an udev helper which parses
30 to map a physical path in a storage topology to a channel name.
31 The channel name is combined with a disk enclosure slot number to create
32 an alias that reflects the physical location of the drive.
33 This is particularly helpful when it comes to tasks like replacing failed drives.
34 Slot numbers may also be remapped in case the default numbering is unsatisfactory.
35 The drive aliases will be created as symbolic links in
36 .Pa /dev/disk/by-vdev .
38 The currently supported topologies are
43 A multipath mode is supported in which dm-mpath devices are handled by
44 examining the first running component disk as reported by the driver.
45 In multipath mode the configuration file should contain a
46 channel definition with the same name for each path to a given
50 also supports creating aliases based on existing udev links in the /dev
53 configuration file keyword.
61 The device node to classify, like
63 .It Fl c Ar config_file
64 Specifies the path to an alternate configuration file.
66 .Pa /etc/zfs/vdev_id.conf .
67 .It Fl g Sy sas_direct Ns | Ns Sy sas_switch Ns | Ns Sy scsi
68 Identifies a physical topology that governs how physical paths are
70 .Bl -tag -compact -width "sas_direct and scsi"
71 .It Sy sas_direct No and Sy scsi
72 channels are uniquely identified by a PCI slot and HBA port number
74 channels are uniquely identified by a SAS switch port number
77 Only handle dm-multipath devices.
78 If specified, examine the first running component disk of a dm-multipath
79 device as provided by the driver to determine the physical path.
80 .It Fl p Ar phys_per_port
81 Specifies the number of PHY devices associated with a SAS HBA port or SAS
84 internally uses this value to determine which HBA or switch port a
85 device is connected to.
89 Print a usage summary.