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\-\-whitelisted\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 --page=0x80 --devpath=/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 --page=0x83 --devpath=/block/sdg
  49 3600a0b80000b174b000000d63efc5c8c
  50 .fi
  51 .P
  52
  53 .SH OPTIONS
  54 .TP
  55 .BI \-\-fallback-to-sysfs
  56 Always print information (model, vendor strings) about the device even
  57 if it does not support VPD pages.
  58 .TP
  59 .BI \-\-ignore-sysfs
  60 Ignore sysfs entries. Used for devices which are not represented as SCSI
  61 devices, but understand SG_IO commands.
  62 .TP
  63 .BI \-\-blacklisted
  64 The default behaviour \- treat the device as black listed, and do nothing
  65 unless a white listed device is found in the scsi_id config\-file.
  66 .TP
  67 .BI \-\-device=\| device\^
  68 Instead
  69 of determining and creating a device node based on a sysfs dev
  70 entry as done for the \fB\-s\fP, send SG_IO commands to
  71 \fBdevice\fP, such as \fB/dev/sdc\fP.
  72 This argument should also be used when invoked via udev to avoid problems
  73 with creation of temporary files on not-yet writable directories.
  74 .TP
  75 .BI \-\-config=\| config\-file
  76 Read configuration and black/white list entries from
  77 .B config\-file
  78 rather than the default
  79 .B /etc/scsi_id.config
  80 file.
  81 .TP
  82 .BI \-\-whitelisted
  83 Treat the device as white listed. The \fB\-\-whitelisted\fP option must be specified
  84 on the command line or in the scsi_id configuration file for
  85 .B scsi_id
  86 to generate any output.
  87 .TP
  88 .BI \-\-prefix-bus-id
  89 Prefix the identification string with the  driver model (sysfs) bus id of
  90 the SCSI device.
  91 .TP
  92 .BI \-\-page=\| 0x80 | 0x83 | pre-spc3-83
  93 Use SCSI INQUIRY VPD page code 0x80, 0x83, or pre-spc3-83.
  94 .sp
  95 The default
  96 behaviour is to query the available VPD pages, and use page 0x83 if found,
  97 else page 0x80 if found, else nothing.
  98 .sp
  99 Page pre-spc3-83 should only be utilized for those scsi devices which
 100 are not compliant with the SPC-2 or SPC-3 format for page 83.  While this
 101 option is used for older model 4, 5, and 6 EMC Symmetrix devices, its
 102 use with SPC-2 or SPC-3 compliant devices will fallback to the page 83
 103 format supported by these devices.
 104 .TP
 105 .BI \-\-devpath=\| sysfs\-devpath
 106 Generate an id for the
 107 .B sysfs\-devpath.
 108 The sysfs mount point must not be included.
 109 .TP
 110 .BI \-\-replace-whitespace
 111 Reformat the output : replace all whitespaces by underscores.
 112 .TP
 113 .BI \-\-export
 114 Export all data in KEY=<value> format used to import in other programs.
 115 .TP
 116 .BI \-\-verbose
 117 Generate verbose debugging output.
 118 .TP
 119 .BI \-\-version
 120 Display version number and exit.
 121 .RE
 122
 123 .SH ENVIRONMENT
 124
 125 If the DEVPATH environment variable is set, scsi_id assumes it has been
 126 invoked via udev (or some other hotplug program), and all errors or
 127 warnings are sent using syslog.
 128 .P
 129
 130 .SH "FILES"
 131 .nf
 132 .ft B
 133 .ft
 134 /etc/scsi_id.config                  configuration and black/white list entries
 135 .fi
 136 .LP
 137 .SH "SEE ALSO"
 138 .BR udev (7)
 139 .SH AUTHORS
 140 Developed by Patrick Mansfield <patmans@us.ibm.com> based on SCSI ID
 141 source included in earlier linux 2.5 kernels, sg_utils source, and SCSI
 142 specifications.