extras/scsi_id/scsi_id.8

   1 .TH SCSI_ID 8 "December 2003" "" "Linux Administrator's Manual"
   2 .SH NAME
   3 scsi_id \- retrieve and generate a unique SCSI identifier
   4 .SH SYNOPSIS
   5 .BI scsi_id
   6 [\fIoptions\fP]
   7 .SH "DESCRIPTION"
   8 .B scsi_id
   9 queries a SCSI device via the SCSI INQUIRY vital product data (VPD) page 0x80 or
  10 0x83 and uses the resulting data to generate a value that is unique across
  11 all SCSI devices that properly support page 0x80 or page 0x83.
  12
  13 If a result is generated it is sent to standard output, and the program
  14 exits with a zero value. If no identifier is output, the program exits
  15 with a non\-zero value.
  16
  17 \fBscsi_id\fP is primarily for use by other utilities such as \fBudev\fP
  18 that require a unique SCSI identifier.
  19
  20 By default all devices are assume black listed, the \fB\-g\fP option must
  21 be specified on the command line or in the config file for any useful
  22 behaviour.
  23
  24 SCSI commands are sent directly to the device via the SG_IO ioctl
  25 interface.
  26
  27 In order to generate unique values for either page 0x80 or page 0x83, the
  28 serial numbers or world wide names are prefixed as follows.
  29
  30 Identifiers based on page 0x80 are prefixed by the character 'S', the SCSI
  31 vendor, the SCSI product (model) and then the the serial number returned
  32 by page 0x80. For example:
  33
  34 .sp
  35 .nf
  36 # scsi_id -p 0x80 -s /block/sdg
  37 SIBM     3542           1T05078453
  38 .fi
  39 .P
  40
  41 Identifiers based on page 0x83 are prefixed by the identifier type
  42 followed by the page 0x83 identifier. For example, a device with a NAA
  43 (Name Address Authority) type of 3 (also in this case the page 0x83
  44 identifier starts with the NAA value of 6):
  45
  46 .sp
  47 .nf
  48 # /sbin/scsi_id -p 0x83 -s /block/sdg
  49 3600a0b80000b174b000000d63efc5c8c
  50 .fi
  51 .P
  52
  53 .SH OPTIONS
  54 .TP
  55 .BI subsystem
  56 Deprecated method: when called with only a single argument without a
  57 leading \-, runs in a hotplug mode, and expects the environment variable
  58 DEVPATH to specify the corresponding sysfs device. See section below on
  59 usage with \fBudev\fP.
  60 .TP
  61 .BI \-b
  62 The default behaviour \- treat the device as black listed, and do nothing
  63 unless a white listed device is found in the scsi_id config\-file.
  64 .TP
  65 .BI \-d "\| device\^"
  66 Instead
  67 of determining and creating a device node based on a sysfs dev
  68 entry as done for the \fB\-s\fP, send SG_IO commands to
  69 \fBdevice\fP, such as \fB/dev/sdc\fP.
  70 This argument should also be used when invoked via udev to avoid problems
  71 with creation of temporary files on not-yet writable directories.
  72 .TP
  73 .BI \-f "\| config\-file"
  74 Read configuration and black/white list entries from
  75 .B config\-file
  76 rather than the default
  77 .B /etc/scsi_id.config
  78 file.
  79 .TP
  80 .BI \-g
  81 Treat the device as white listed. The \fB\-g\fP option must be specified
  82 on the command line or in the scsi_id configuration file for
  83 .B scsi_id
  84 to generate any output.
  85 .TP
  86 .BI \-i
  87 Prefix the identification string with the  driver model (sysfs) bus id of
  88 the SCSI device.
  89 .TP
  90 .BI \-p "\| 0x80 | 0x83"
  91 Use SCSI INQUIRY VPD page code 0x80 or 0x83. The default behaviour is to
  92 query the available VPD pages, and use page 0x83 if found, else page 0x80
  93 if found, else nothing.
  94 .TP
  95 .BI \-s "\| sysfs\-device"
  96 Generate an id for the
  97 .B sysfs\-device.
  98 The sysfs mount point must not be included. For example, use /block/sd,
  99 not /sys/block/sd.
 100 .TP
 101 .BI \-u
 102 Reformat the output : replace all whitespaces by underscores
 103 .TP
 104 .BI \-v
 105 Generate verbose debugging output.
 106 .TP
 107 .BI \-V
 108 Display version number and exit.
 109 .RE
 110
 111 .SH USAGE WITH UDEV
 112
 113 If \fBscsi_id\fP is invoked with one argument without a leading \-, it
 114 assumes it is called for a hotplug event, and looks for the sysfs device
 115 in the DEVPATH environment variable. This mode is deprecated, but
 116 available for backwards compatibility.
 117
 118 If the DEVPATH environment variable is set, scsi_id assumes it has been
 119 invoked via udev (or some other hotplug program), and all errors or
 120 warnings are sent using syslog.
 121
 122 To determine the specific value needed in a RESULT key, use the \-s option,
 123 for example:
 124
 125 .sp
 126 .nf
 127 /sbin/scsi_id -s /block/sda
 128 .fi
 129 .P
 130
 131 An example \fBudev\fP rule using \fBscsi_id\fP, that will name a block
 132 device and any partitions for the device matching the \fBscsi_id\fP output
 133 of 312345:
 134
 135 .sp
 136 .nf
 137 BUS="scsi", PROGRAM="/sbin/scsi_id -d %N -s %p", RESULT="312345", NAME="disk%n"
 138 .fi
 139 .P
 140
 141 .SH "FILES"
 142 .nf
 143 .ft B
 144 .ft
 145 /etc/scsi_id.config                  configuration and black/white list entries
 146 .fi
 147 .LP
 148 .SH "SEE ALSO"
 149 .BR udev (8), hotplug (8)
 150 .SH AUTHORS
 151 Developed by Patrick Mansfield <patmans@us.ibm.com> based on SCSI ID
 152 source included in earlier linux 2.5 kernels, sg_utils source, and SCSI
 153 specifications.