Package: sasutils
sasutils is a set of command-line tools and a Python library to ease the administration of Serial Attached SCSI (SAS) storage networks.sasutils command-line toolssas_counterssas_devicessas_discoverses_reportAlso, a few “zeroconf” udev scripts for use in udev rules that create friendly device aliases using SES-2 subenclosure nicknames.sas_mpath_snic_aliassas_sd_snic_aliassas_st_snic_aliasNoteWhilesasutilsgets most of the system data from sysfs (/sys),sg_ses(available in sg3_utils or sg3-utils)
andsmp_discover(available in smp_utils or smp-utils) are required for some SES features to work.sas_counterssas_countersreports SAS/SES/SD I/O and phy error counters and provides SAS topology information in an output suitable for Carbon/Graphite.
This command also supports SES-2 nicknames as seen in the example below (io1-sassw1is the nickname of a SAS switch andio1-jbod1-0is the nickname of a JBOD SIM).$ sas_counters
...
oak-io1-s1.SAS9300-8e.0x500605b00ab01234.Switch184.io1-sassw1.JB4602_SIM_0.io1-jbod1-0.bays.41.ST8000NM0075.0x5000c50084c79876.ioerr_cnt 2 1487457378
oak-io1-s1.SAS9300-8e.0x500605b00ab01234.Switch184.io1-sassw1.JB4602_SIM_0.io1-jbod1-0.bays.41.ST8000NM0075.0x5000c50084c79876.iodone_cnt 7154904 1487457378
oak-io1-s1.SAS9300-8e.0x500605b00ab01234.Switch184.io1-sassw1.JB4602_SIM_0.io1-jbod1-0.bays.41.ST8000NM0075.0x5000c50084c79876.iorequest_cnt 7154906 1487457378
...
oak-io1-s1.SAS9300-8e.0x500605b00ab05678.Switch184.io1-sassw2.phys.15.invalid_dword_count 5 1487457378
oak-io1-s1.SAS9300-8e.0x500605b00ab05678.Switch184.io1-sassw2.phys.15.loss_of_dword_sync_count 1 1487457378
oak-io1-s1.SAS9300-8e.0x500605b00ab05678.Switch184.io1-sassw2.phys.15.phy_reset_problem_count 0 1487457378
oak-io1-s1.SAS9300-8e.0x500605b00ab05678.Switch184.io1-sassw2.phys.15.running_disparity_error_count 1 1487457378
...sas_discoverDisplay SAS topology. By default,sas_discovertries to fold common devices (like disks). Use-v,-vvor-vvvand--addrto display more details.
Below is an example with a large topology with multiple SAS HBAs, SAS switches and SAS JBODs.$ sas_discover -v
oak-io8-s2
|--host1 HBA 9500-16e
|  `--8x--expander-1:0 ASTEK
|         |--1x--end_device-1:0:0
|         |      `--enclosure io8-sassw2 ASTEK
|         |--4x--expander-1:1 HGST
|         |      |--1x--end_device-1:1:0
|         |      |      `--enclosure io8-jbod1 HGST
|         |      |--10x--expander-1:9 HGST
|         |      |  `-- 50 x end_device -- disk
|         |      `--10x--expander-1:10 HGST
|         |         `-- 51 x end_device -- disk
|         |--4x--expander-1:2 HGST
|         |      |--1x--end_device-1:2:0
|         |      |      `--enclosure io8-jbod2 HGST
|         |      |--10x--expander-1:11 HGST
|         |      |  `-- 51 x end_device -- disk
|         |      `--10x--expander-1:12 HGST
|         |         `-- 51 x end_device -- disk
|         |--4x--expander-1:3 HGST
|         |      |--1x--end_device-1:3:0
|         |      |      `--enclosure io8-jbod3 HGST
|         |      |--10x--expander-1:13 HGST
|         |      |  `-- 51 x end_device -- disk
|         |      `--10x--expander-1:14 HGST
|         |         `-- 51 x end_device -- disk
|         |--4x--expander-1:4 HGST
|         |      |--1x--end_device-1:4:0
|         |      |      `--enclosure io8-jbod4 HGST
|         |      |--10x--expander-1:15 HGST
|         |      |  `-- 51 x end_device -- disk
|         |      `--10x--expander-1:16 HGST
|         |         `-- 51 x end_device -- disk
|         |--4x--expander-1:5 HGST
|         |      |--1x--end_device-1:5:0
|         |      |      `--enclosure io8-jbod5 HGST
|         |      |--10x--expander-1:17 HGST
|         |      |  `-- 51 x end_device -- disk
|         |      `--10x--expander-1:18 HGST
|         |         `-- 51 x end_device -- disk
|         |--4x--expander-1:6 HGST
|         |      |--1x--end_device-1:6:0
|         |      |      `--enclosure io8-jbod6 HGST
|         |      |--10x--expander-1:19 HGST
|         |      |  `-- 51 x end_device -- disk
|         |      `--10x--expander-1:20 HGST
|         |         `-- 51 x end_device -- disk
|         |--4x--expander-1:7 HGST
|         |      |--1x--end_device-1:7:0
|         |      |      `--enclosure io8-jbod7 HGST
|         |      |--10x--expander-1:21 HGST
|         |      |  `-- 51 x end_device -- disk
|         |      `--10x--expander-1:22 HGST
|         |         `-- 51 x end_device -- disk
|         `--4x--expander-1:8 HGST
|                |--1x--end_device-1:8:0
|                |      `--enclosure io8-jbod8 HGST
|                |--10x--expander-1:23 HGST
|                |  `-- 51 x end_device -- disk
|                `--10x--expander-1:24 HGST
|                   `-- 51 x end_device -- disk
`--host10 HBA 9500-16e
   `--8x--expander-10:0 ASTEK
          |--1x--end_device-10:0:0
          |      `--enclosure io8-sassw1 ASTEK
          |--4x--expander-10:1 HGST
          |      |--1x--end_device-10:1:0
          |      |      `--enclosure io8-jbod1 HGST
          |      |--10x--expander-10:9 HGST
          |      |  `-- 50 x end_device -- disk
          |      `--10x--expander-10:10 HGST
          |         `-- 51 x end_device -- disk
          |--4x--expander-10:2 HGST
          |      |--1x--end_device-10:2:0
          |      |      `--enclosure io8-jbod2 HGST
          |      |--10x--expander-10:11 HGST
          |      |  `-- 51 x end_device -- disk
          |      `--10x--expander-10:12 HGST
          |         `-- 51 x end_device -- disk
          |--4x--expander-10:3 HGST
          |      |--1x--end_device-10:3:0
          |      |      `--enclosure io8-jbod3 HGST
          |      |--10x--expander-10:13 HGST
          |      |  `-- 51 x end_device -- disk
          |      `--10x--expander-10:14 HGST
          |         `-- 51 x end_device -- disk
          |--4x--expander-10:4 HGST
          |      |--1x--end_device-10:4:0
          |      |      `--enclosure io8-jbod4 HGST
          |      |--10x--expander-10:15 HGST
          |      |  `-- 51 x end_device -- disk
          |      `--10x--expander-10:16 HGST
          |         `-- 51 x end_device -- disk
          |--4x--expander-10:5 HGST
          |      |--1x--end_device-10:5:0
          |      |      `--enclosure io8-jbod5 HGST
          |      |--10x--expander-10:17 HGST
          |      |  `-- 51 x end_device -- disk
          |      `--10x--expander-10:18 HGST
          |         `-- 51 x end_device -- disk
          |--4x--expander-10:6 HGST
          |      |--1x--end_device-10:6:0
          |      |      `--enclosure io8-jbod6 HGST
          |      |--10x--expander-10:19 HGST
          |      |  `-- 51 x end_device -- disk
          |      `--10x--expander-10:20 HGST
          |         `-- 51 x end_device -- disk
          |--4x--expander-10:7 HGST
          |      |--1x--end_device-10:7:0
          |      |      `--enclosure io8-jbod7 HGST
          |      |--10x--expander-10:21 HGST
          |      |  `-- 51 x end_device -- disk
          |      `--10x--expander-10:22 HGST
          |         `-- 51 x end_device -- disk
          `--4x--expander-10:8 HGST
                 |--1x--end_device-10:8:0
                 |      `--enclosure io8-jbod8 HGST
                 |--10x--expander-10:23 HGST
                 |  `-- 51 x end_device -- disk
                 `--10x--expander-10:24 HGST
                    `-- 51 x end_device -- diskUsesas_discover--countersto display the number of SCSI commands issued (req), completed or rejected (done) and the ones that completed with an error (error).sas_devicesZeroconf tool that scans SAS devices and resolves associated enclosures. Useful to quickly check cabling and hardware setup.When used with -v,sas_deviceswill also display all disk devices with serial numbers.The following example shows a proper detection of a 60-disk JBOD with 2 SIMs/IOMs (an “enclosure group”).$ sas_devices
Found 2 SAS hosts
Found 4 SAS expanders
Found 1 enclosure groups
        Enclosure group: [io1-jbod1-0][io1-jbod1-1]
        NUM         VENDOR            MODEL    REV     SIZE  PATHS
         60 x      SEAGATE     ST8000NM0075   E004    8.0TB      2
Total: 60 block devices in enclosure groupThe following example shows a proper detection of four Seagate Exos E JBOFs with 15.4TB SSDs. Note that 2 IOMs are detected for each JBOF and they have the same SES-2 nickname (this is normal with this hardware).$ sas_devices
Found 2 SAS hosts
Found 8 SAS expanders
Found 4 enclosure groups
Enclosure group: [io1-jbof4][io1-jbof4]
NUM         VENDOR            MODEL    REV     SIZE  PATHS
 24 x      SEAGATE   XS15360SE70084   0003   15.4TB      2
Total: 24 block devices in enclosure group
Enclosure group: [io1-jbof2][io1-jbof2]
NUM         VENDOR            MODEL    REV     SIZE  PATHS
 24 x      SEAGATE   XS15360SE70084   0003   15.4TB      2
Total: 24 block devices in enclosure group
Enclosure group: [io1-jbof3][io1-jbof3]
NUM         VENDOR            MODEL    REV     SIZE  PATHS
 24 x      SEAGATE   XS15360SE70084   0003   15.4TB      2
Total: 24 block devices in enclosure group
Enclosure group: [io1-jbof1][io1-jbof1]
NUM         VENDOR            MODEL    REV     SIZE  PATHS
 24 x      SEAGATE   XS15360SE70084   0003   15.4TB      2
Total: 24 block devices in enclosure groupses_reportSES status and environmental metrics.Used with -c, this command will find all enclosures and then use SES-2 nicknames and use sg_ses to output results suitable for Carbon/Graphite.$ ses_report -c --prefix=datacenter.stanford
datacenter.stanford.io1-sassw1.Cooling.Left_Fan.speed_rpm 19560 1476486766
datacenter.stanford.io1-sassw1.Cooling.Right_Fan.speed_rpm 19080 1476486766
datacenter.stanford.io1-sassw1.Cooling.Center_Fan.speed_rpm 19490 1476486766
...Use -s to get the status of all detected SES Element Descriptors.# ses_report -s --prefix=datacenter.stanford | grep SIM
datacenter.stanford.io1-jbod1-0.Enclosure_services_controller_electronics.SIM_00 OK
datacenter.stanford.io1-jbod1-0.Enclosure_services_controller_electronics.SIM_01 OK
datacenter.stanford.io1-jbod1-0.SAS_expander.SAS_Expander_SIM_0 OK
datacenter.stanford.io1-jbod1-0.SAS_expander.SAS_Expander_ISIM_2 OK
datacenter.stanford.io1-jbod1-0.SAS_expander.SAS_Expander_ISIM_0 OK
datacenter.stanford.io1-jbod1-1.Enclosure_services_controller_electronics.SIM_00 OK
datacenter.stanford.io1-jbod1-1.Enclosure_services_controller_electronics.SIM_01 OK
datacenter.stanford.io1-jbod1-1.SAS_expander.SAS_Expander_SIM_1 OK
datacenter.stanford.io1-jbod1-1.SAS_expander.SAS_Expander_ISIM_3 OK
datacenter.stanford.io1-jbod1-1.SAS_expander.SAS_Expander_ISIM_1 OKWarningses_reportrequires a recent version ofsg3_utilsand won’t work with the version shipped with CentOS 6 for example.sas_sd_snic_alias and sas_st_snic_aliasGenerate udev aliases using the SES-2 subenclosure nickname and bay identifier of each device.
These scripts can also be used as examples and adapted to your specific needs.For example, for block devices, add the following to your udev rules:KERNEL=="sd*", PROGRAM="/usr/bin/sas_sd_snic_alias %k", SYMLINK+="%c"Or, for SAS tape drives behind SAS switches (that act as enclosures):KERNEL=="st*", PROGRAM="/usr/bin/sas_st_snic_alias %k", SYMLINK+="%c"This should generate udev aliases made of the device subenclosure nickname followed by the bay identifier. In the following case,io1-jbod1-0is the subenclosure nickname (here SIM 0 of JBOD #1).$ ls -l /dev/io1-jbod1-0-bay26
lrwxrwxrwx 1 root root 4 Oct 14 21:00 /dev/io1-jbod1-0-bay26 -> sdabNoteUsesg_ses –nickname=…to define SES-2 subenclosure nicknames.sas_mpath_snic_aliasThis utility is very similar tosas_sd_snic_aliasbut only accepts device-mapper devices. Add the following line to your udev rules:KERNEL=="dm-[0-9]*", PROGRAM="/usr/bin/sas_mpath_snic_alias %k", SYMLINK+="mapper/%c"This will result in useful symlinks.$ ls -l /dev/mapper/io1-jbod1-bay26
lrwxrwxrwx 1 root root 8 Oct 14 21:00 /dev/mapper/io1-jbod1-bay26 -> ../dm-31NoteForsas_mpath_snic_aliasto work with a JBOD having two SIMs, both enclosure nicknames should have a common prefix (eg. “myjbodX-”) that will be automatically used.sasutils Python libraryDocumentation will be available on thewiki.the following example will list all SAS hosts (controllers) found in sysfsfromsasutils.sasimportSASHostfromsasutils.sysfsimportsysfs# sysfs is a helper to walk through sysfs (/sys)fornodeinsysfs.node('class').node('sas_host'):# Instantiate SASHost with the sas_host sysfs device classhost=SASHost(node.node('device'))# To get its sysfs name, use:print(host.name)# To get attributes from scsi_host, use:print('%s'%host.scsi_host.attrs.host_sas_address)print('%s'%host.scsi_host.attrs.version_fw)See alsohttps://github.com/stanford-rc/sasutils/wiki/Code-snippetsAuthor:Stephane Thiell - Stanford Research Computing Center