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
  54 .SH OPTIONS
  55 .TP
  56 .BI \-b
  57 The default behaviour - treat the device as black listed, and do nothing
  58 unless a white listed device is found in the scsi_id config-file.
  59 .TP
  60 .BI \-d "\| device\^"
  61 Instead
  62 of determining and creating a device node based on a sysfs dev
  63 entry as done for the \fB-s\fP, send SG_IO commands to
  64 \fBdevice\fP, such as \fB/dev/sdc\fP.
  65 .TP
  66 .BI \-e
  67 Send all output to standard error even if
  68 .B scsi_id
  69 is running in hotplug mode.
  70 .TP
  71 .BI \-f "\| config-file"
  72 Read configuration and black/white list entries from
  73 .B config-file
  74 rather than the default
  75 .B /etc/scsi_id.config
  76 file.
  77 .TP
  78 .BI \-g
  79 Treat the device as white listed. The \fB\-g\fP option must be specified
  80 on the command line or in the scsi_id configuration file for
  81 .B scsi_id
  82 to generate any output.
  83 .TP
  84 .BI \-i
  85 Prefix the identification string with the  driver model (sysfs) bus id of
  86 the SCSI device.
  87 .TP
  88 .BI \-p "\| 0x80 | 0x83"
  89 Use SCSI INQUIRY VPD page code 0x80 or 0x83. The default behaviour is to
  90 query the available VPD pages, and use page 0x83 if found, else page 0x80
  91 if found, else nothing.
  92 .TP
  93 .BI \-s "\|sysfs-device"
  94 Generate an id for the
  95 .B sysfs-device.
  96 The sysfs mount point must not be included. For example, use /block/sd,
  97 not /sys/block/sd.
  98 .TP
  99 .BI \-v
 100 Generate verbose debugging output.
 101 .TP
 102 .BI \-V
 103 Display version number and exit.
 104 .RE
 105 .SH "FILES"
 106 .nf
 107 .ft B
 108 .ft
 109 /etc/scsi_id.config                  configuration and black/white list entries
 110 .fi
 111 .LP
 112 .SH "SEE ALSO"
 113 .BR udev (8)
 114 , especially the CALLOUT method.
 115 .SH AUTHORS
 116 Developed by Patrick Mansfield <patmans@us.ibm.com> based on SCSI ID
 117 source included in earlier linux 2.5 kernels, sg_utils source, and SCSI
 118 specifications.