SCSI_ID

Section: Linux Administrator's Manual (8)
Updated: December 2003
Index Return to Main Contents

NAME

scsi_id - retrieve and generate a unique SCSI identifier

SYNOPSIS

scsi_id [options]

DESCRIPTION

scsi_id queries a SCSI device via the SCSI INQUIRY vital product data (VPD) page 0x80 or 0x83 and uses the resulting data to generate a value that is unique across all SCSI devices that properly support page 0x80 or page 0x83.

If a result is generated it is sent to standard output, and the program exits with a zero value. If no identifier is output, the program exits with a non-zero value.

scsi_id is primarily for use by other utilities such as udev that require a unique SCSI identifier.

By default all devices are assumed black listed, the --whitelisted option must be specified on the command line or in the config file for any useful behaviour.

SCSI commands are sent directly to the device via the SG_IO ioctl interface.

In order to generate unique values for either page 0x80 or page 0x83, the serial numbers or world wide names are prefixed as follows.

Identifiers based on page 0x80 are prefixed by the character 'S', the SCSI vendor, the SCSI product (model) and then the the serial number returned by page 0x80. For example:

# /lib/udev/scsi_id --page=0x80 --whitelisted --device=/dev/sda
SIBM     3542           1T05078453

Identifiers based on page 0x83 are prefixed by the identifier type followed by the page 0x83 identifier. For example, a device with a NAA (Name Address Authority) type of 3 (also in this case the page 0x83 identifier starts with the NAA value of 6):

# /lib/udev/scsi_id --page=0x83 --whitelisted --device=/dev/sda
3600a0b80000b174b000000d63efc5c8c

OPTIONS

--blacklisted

The default behaviour - treat the device as black listed, and do nothing unless a white listed device is found in the scsi_id config-file.

--device=device

Send SG_IO commands to device, such as /dev/sdc.

--config=config-file

Read configuration and black/white list entries from config-file rather than the default /etc/scsi_id.config file.

--whitelisted

Treat the device as white listed. The --whitelisted option must be specified on the command line or in the scsi_id configuration file for scsi_id to generate any output.

--page=0x80|0x83|pre-spc3-83|0x80-0x83|0x83-0x80

Use SCSI INQUIRY VPD page code 0x80, 0x83, or pre-spc3-83.

The default behaviour is to query the available VPD pages, and use page 0x83 if found, else page 0x80 if found, else nothing.

Page pre-spc3-83 should only be utilized for those scsi devices which are not compliant with the SPC-2 or SPC-3 format for page 83. While this option is used for older model 4, 5, and 6 EMC Symmetrix devices, its use with SPC-2 or SPC-3 compliant devices will fallback to the page 83 format supported by these devices.

0x80-0x83 is like 0x80, and exports ID_SERIAL and ID_SERIAL_80, but also exports 0x83 in ID_SERIAL_83.

0x83-0x80 is like 0x83, and exports ID_SERIAL and ID_SERIAL_83, but also exports 0x80 in ID_SERIAL_80.

--replace-whitespace

Reformat the output : replace all whitespaces by underscores.

--export

Export all data in KEY=<value> format used to import in other programs.

--verbose

Generate verbose debugging output.

--version

Display version number and exit.

FILES


/etc/scsi_id.config
Configuration of black/white list entries and per device options:
# one config per line, short match strings match longer strings
# vendor=string[,model=string],options=<per-device scsi_id command line options>
vendor="ATA",options=-p 0x80

AUTHORS

Developed by Patrick Mansfield <patmans@us.ibm.com> based on SCSI ID source included in earlier linux 2.5 kernels, sg_utils source, and SCSI specifications.

This document was created by man2html, using the manual pages.
Time: 05:34:29 GMT, December 24, 2015