pySMART
Copyright (C) 2014 Marc Herndon
pySMART is a simple Python wrapper for the smartctl
component of
smartmontools
. It works under Linux and Windows, as long as smartctl is on
the system path. Running with administrative (root) privilege is strongly
recommended, as smartctl cannot accurately detect all device types or parse
all SMART information without full permissions.
With only a device's name (ie: /dev/sda, pd0), the API will create a
Device
object, populated with all relevant information about
that device. The documented API can then be used to query this object for
information, initiate device self-tests, and perform other functions.
Usage
The most common way to use pySMART is to create a logical representation of the physical storage device that you would like to work with, as shown:
#!bash
>>> from pySMART import Device
>>> sda = Device('/dev/sda')
>>> sda
<SATA device on /dev/sda mod:WDC WD5000AAKS-60Z1A0 sn:WD-WCAWFxxxxxxx>
Device
class members can be accessed directly, and a number of helper methods
are provided to retrieve information in bulk. Some examples are shown below:
#!bash
>>> sda.assessment # Query the SMART self-assessment
'PASS'
>>> sda.attributes[9] # Query a single SMART attribute
<SMART Attribute 'Power_On_Hours' 068/000 raw:23644>
>>> sda.all_attributes() # Print the entire SMART attribute table
ID# ATTRIBUTE_NAME CUR WST THR TYPE UPDATED WHEN_FAIL RAW
1 Raw_Read_Error_Rate 200 200 051 Pre-fail Always - 0
3 Spin_Up_Time 141 140 021 Pre-fail Always - 3908
4 Start_Stop_Count 098 098 000 Old_age Always - 2690
5 Reallocated_Sector_Ct 200 200 140 Pre-fail Always - 0
... # Edited for brevity
199 UDMA_CRC_Error_Count 200 200 000 Old_age Always - 0
200 Multi_Zone_Error_Rate 200 200 000 Old_age Offline - 0
>>> sda.tests[0] # Query the most recent self-test result
<SMART Self-test [Short offline|Completed without error] hrs:23734 lba:->
>>> sda.all_selftests() # Print the entire self-test log
ID Test_Description Status Left Hours 1st_Error@lba
1 Short offline Completed without error 00% 23734 -
2 Short offline Completed without error 00% 23734 -
... # Edited for brevity
7 Short offline Completed without error 00% 23726 -
8 Short offline Completed without error 00% 1 -
Alternatively, the package provides a DeviceList
class. When instantiated,
this will auto-detect all local storage devices and create a list containing
one Device
object for each detected storage device.
#!bash
>>> from pySMART import DeviceList
>>> devlist = DeviceList()
>>> devlist
<DeviceList contents:
<SAT device on /dev/sdb mod:WDC WD20EADS-00R6B0 sn:WD-WCAVYxxxxxxx>
<SAT device on /dev/sdc mod:WDC WD20EADS-00S2B0 sn:WD-WCAVYxxxxxxx>
<CSMI device on /dev/csmi0,0 mod:WDC WD5000AAKS-60Z1A0 sn:WD-WCAWFxxxxxxx>
>
>>> devlist.devices[0].attributes[5] # Access Device data as above
<SMART Attribute 'Reallocated_Sector_Ct' 173/140 raw:214>
In the above cases if a new DeviceList is empty or a specific Device reports an "UNKNOWN INTERFACE", you are likely running without administrative privileges. On POSIX systems, you can request smartctl is run as a superuser by setting the sudo attribute of the global SMARTCTL object to True. Note this may cause you to be prompted for a password.
#!bash
>>> from pySMART import DeviceList
>>> from pySMART import Device
>>> sda = Device('/dev/sda')
>>> sda
<UNKNOWN INTERFACE device on /dev/sda mod:None sn:None>
>>> devlist = DeviceList()
>>> devlist
<DeviceList contents:
>
>>> from pySMART import SMARTCTL
>>> SMARTCTL.sudo = True
>>> sda = Device('/dev/sda')
>>> sda
[sudo] password for user:
<SAT device on /dev/sda mod:ST10000DM0004-1ZC101 sn:ZA20VNPT>
>>> devlist = DeviceList()
>>> devlist
<DeviceList contents:
<NVME device on /dev/nvme0 mod:Sabrent Rocket 4.0 1TB sn:03850709185D88300410>
<NVME device on /dev/nvme1 mod:Samsung SSD 970 EVO Plus 2TB sn:S59CNM0RB05028D>
<NVME device on /dev/nvme2 mod:Samsung SSD 970 EVO Plus 2TB sn:S59CNM0RB05113H>
<SAT device on /dev/sda mod:ST10000DM0004-1ZC101 sn:ZA20VNPT>
<SAT device on /dev/sdb mod:ST10000DM0004-1ZC101 sn:ZA22W366>
<SAT device on /dev/sdc mod:ST10000DM0004-1ZC101 sn:ZA22SPLG>
<SAT device on /dev/sdd mod:ST10000DM0004-1ZC101 sn:ZA2215HL>
>
In general, it is recommended to run the base script with enough privileges to execute smartctl, but this is not possible in all cases, so this workaround is provided as a convenience. However, note that using sudo inside other non-terminal projects may cause dev-bugs/issues.
Using the pySMART wrapper, Python applications be be rapidly developed to take advantage of the powerful features of smartmontools.
Acknowledgements
I would like to thank the entire team behind smartmontools for creating and maintaining such a fantastic product.
In particular I want to thank Christian Franke, who maintains the Windows port of the software. For several years I have written Windows batch files that rely on smartctl.exe to automate evaluation and testing of large pools of storage devices under Windows. Without his work, my job would have been significantly more miserable. :)
Having recently migrated my development from Batch to Python for Linux portability, I thought a simple wrapper for smartctl would save time in the development of future automated test tools.
1# Copyright (C) 2014 Marc Herndon 2# 3# This program is free software; you can redistribute it and/or 4# modify it under the terms of the GNU General Public License, 5# version 2, as published by the Free Software Foundation. 6# 7# This program is distributed in the hope that it will be useful, 8# but WITHOUT ANY WARRANTY; without even the implied warranty of 9# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10# GNU General Public License for more details. 11# 12# You should have received a copy of the GNU General Public License 13# along with this program; if not, write to the Free Software 14# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 15# MA 02110-1301, USA. 16# 17################################################################ 18""" 19Copyright (C) 2014 Marc Herndon 20 21pySMART is a simple Python wrapper for the `smartctl` component of 22`smartmontools`. It works under Linux and Windows, as long as smartctl is on 23the system path. Running with administrative (root) privilege is strongly 24recommended, as smartctl cannot accurately detect all device types or parse 25all SMART information without full permissions. 26 27With only a device's name (ie: /dev/sda, pd0), the API will create a 28`Device` object, populated with all relevant information about 29that device. The documented API can then be used to query this object for 30information, initiate device self-tests, and perform other functions. 31 32Usage 33----- 34The most common way to use pySMART is to create a logical representation of the 35physical storage device that you would like to work with, as shown: 36 37 #!bash 38 >>> from pySMART import Device 39 >>> sda = Device('/dev/sda') 40 >>> sda 41 <SATA device on /dev/sda mod:WDC WD5000AAKS-60Z1A0 sn:WD-WCAWFxxxxxxx> 42 43`Device` class members can be accessed directly, and a number of helper methods 44are provided to retrieve information in bulk. Some examples are shown below: 45 46 #!bash 47 >>> sda.assessment # Query the SMART self-assessment 48 'PASS' 49 >>> sda.attributes[9] # Query a single SMART attribute 50 <SMART Attribute 'Power_On_Hours' 068/000 raw:23644> 51 >>> sda.all_attributes() # Print the entire SMART attribute table 52 ID# ATTRIBUTE_NAME CUR WST THR TYPE UPDATED WHEN_FAIL RAW 53 1 Raw_Read_Error_Rate 200 200 051 Pre-fail Always - 0 54 3 Spin_Up_Time 141 140 021 Pre-fail Always - 3908 55 4 Start_Stop_Count 098 098 000 Old_age Always - 2690 56 5 Reallocated_Sector_Ct 200 200 140 Pre-fail Always - 0 57 ... # Edited for brevity 58 199 UDMA_CRC_Error_Count 200 200 000 Old_age Always - 0 59 200 Multi_Zone_Error_Rate 200 200 000 Old_age Offline - 0 60 >>> sda.tests[0] # Query the most recent self-test result 61 <SMART Self-test [Short offline|Completed without error] hrs:23734 lba:-> 62 >>> sda.all_selftests() # Print the entire self-test log 63 ID Test_Description Status Left Hours 1st_Error@lba 64 1 Short offline Completed without error 00% 23734 - 65 2 Short offline Completed without error 00% 23734 - 66 ... # Edited for brevity 67 7 Short offline Completed without error 00% 23726 - 68 8 Short offline Completed without error 00% 1 - 69 70Alternatively, the package provides a `DeviceList` class. When instantiated, 71this will auto-detect all local storage devices and create a list containing 72one `Device` object for each detected storage device. 73 74 #!bash 75 >>> from pySMART import DeviceList 76 >>> devlist = DeviceList() 77 >>> devlist 78 <DeviceList contents: 79 <SAT device on /dev/sdb mod:WDC WD20EADS-00R6B0 sn:WD-WCAVYxxxxxxx> 80 <SAT device on /dev/sdc mod:WDC WD20EADS-00S2B0 sn:WD-WCAVYxxxxxxx> 81 <CSMI device on /dev/csmi0,0 mod:WDC WD5000AAKS-60Z1A0 sn:WD-WCAWFxxxxxxx> 82 > 83 >>> devlist.devices[0].attributes[5] # Access Device data as above 84 <SMART Attribute 'Reallocated_Sector_Ct' 173/140 raw:214> 85 86In the above cases if a new DeviceList is empty or a specific Device reports an 87"UNKNOWN INTERFACE", you are likely running without administrative privileges. 88On POSIX systems, you can request smartctl is run as a superuser by setting the 89sudo attribute of the global SMARTCTL object to True. Note this may cause you 90to be prompted for a password. 91 92 #!bash 93 >>> from pySMART import DeviceList 94 >>> from pySMART import Device 95 >>> sda = Device('/dev/sda') 96 >>> sda 97 <UNKNOWN INTERFACE device on /dev/sda mod:None sn:None> 98 >>> devlist = DeviceList() 99 >>> devlist 100 <DeviceList contents: 101 > 102 >>> from pySMART import SMARTCTL 103 >>> SMARTCTL.sudo = True 104 >>> sda = Device('/dev/sda') 105 >>> sda 106 [sudo] password for user: 107 <SAT device on /dev/sda mod:ST10000DM0004-1ZC101 sn:ZA20VNPT> 108 >>> devlist = DeviceList() 109 >>> devlist 110 <DeviceList contents: 111 <NVME device on /dev/nvme0 mod:Sabrent Rocket 4.0 1TB sn:03850709185D88300410> 112 <NVME device on /dev/nvme1 mod:Samsung SSD 970 EVO Plus 2TB sn:S59CNM0RB05028D> 113 <NVME device on /dev/nvme2 mod:Samsung SSD 970 EVO Plus 2TB sn:S59CNM0RB05113H> 114 <SAT device on /dev/sda mod:ST10000DM0004-1ZC101 sn:ZA20VNPT> 115 <SAT device on /dev/sdb mod:ST10000DM0004-1ZC101 sn:ZA22W366> 116 <SAT device on /dev/sdc mod:ST10000DM0004-1ZC101 sn:ZA22SPLG> 117 <SAT device on /dev/sdd mod:ST10000DM0004-1ZC101 sn:ZA2215HL> 118 > 119 120In general, it is recommended to run the base script with enough privileges to 121execute smartctl, but this is not possible in all cases, so this workaround is 122provided as a convenience. However, note that using sudo inside other 123non-terminal projects may cause dev-bugs/issues. 124 125 126Using the pySMART wrapper, Python applications be be rapidly developed to take 127advantage of the powerful features of smartmontools. 128 129Acknowledgements 130---------------- 131I would like to thank the entire team behind smartmontools for creating and 132maintaining such a fantastic product. 133 134In particular I want to thank Christian Franke, who maintains the Windows port 135of the software. For several years I have written Windows batch files that 136rely on smartctl.exe to automate evaluation and testing of large pools of 137storage devices under Windows. Without his work, my job would have been 138significantly more miserable. :) 139 140Having recently migrated my development from Batch to Python for Linux 141portability, I thought a simple wrapper for smartctl would save time in the 142development of future automated test tools. 143""" 144# autopep8: off 145from .testentry import TestEntry 146from .interface.ata.attribute import Attribute 147from . import utils 148utils.configure_trace_logging() 149from .smartctl import SMARTCTL 150from .device_list import DeviceList 151from .device import Device, smart_health_assement 152from .version import __version__,__version_tuple__ 153# autopep8: on 154 155 156__all__ = [ 157 '__version__', '__version_tuple__', 158 'TestEntry', 'Attribute', 'utils', 'SMARTCTL', 'DeviceList', 'Device', 159 'smart_health_assement' 160]
27class TestEntry(object): 28 """ 29 Contains all of the information associated with a single SMART Self-test 30 log entry. This data is intended to exactly mirror that obtained through 31 smartctl. 32 """ 33 34 def __init__(self, format, num: Optional[int], test_type, status, hours, lba, 35 remain=None, 36 segment=None, 37 sense=None, 38 asc=None, 39 ascq=None, 40 nsid=None, 41 sct=None, 42 code=None): 43 44 self._format = format 45 """ 46 **(str):** Indicates whether this entry was taken from an 'ata' or 47 'scsi' self-test log. Used to display the content properly. 48 """ 49 self.num: Optional[int] = num 50 """ 51 **(int):** Entry's position in the log from 1 (most recent) to 21 52 (least recent). ATA logs save the last 21 entries while SCSI logs 53 only save the last 20. 54 """ 55 self.type = test_type 56 """ 57 **(str):** Type of test run. Generally short, long (extended), or 58 conveyance, plus offline (background) or captive (foreground). 59 """ 60 self.status = status 61 """ 62 **(str):** Self-test's status message, for example 'Completed without 63 error' or 'Completed: read failure'. 64 """ 65 self.hours = hours 66 """ 67 **(str):** The device's power-on hours at the time the self-test 68 was initiated. 69 """ 70 self.LBA = lba 71 """ 72 **(str):** Indicates the first LBA at which an error was encountered 73 during this self-test. Presented as a decimal value for ATA/SATA 74 devices and in hexadecimal notation for SAS/SCSI devices. 75 """ 76 self.remain = remain 77 """ 78 **(str):** Percentage value indicating how much of the self-test is 79 left to perform. '00%' indicates a complete test, while any other 80 value could indicate a test in progress or one that failed prior to 81 completion. Only reported by ATA devices. 82 """ 83 self.segment = segment 84 """ 85 **(str):** A manufacturer-specific self-test segment number reported 86 by SCSI devices on self-test failure. Set to '-' otherwise. 87 """ 88 self.sense = sense 89 """ 90 **(str):** SCSI sense key reported on self-test failure. Set to '-' 91 otherwise. 92 """ 93 self.ASC = asc 94 """ 95 **(str):** SCSI 'Additonal Sense Code' reported on self-test failure. 96 Set to '-' otherwise. 97 """ 98 self.ASCQ = ascq 99 """ 100 **(str):** SCSI 'Additonal Sense Code Quaifier' reported on self-test 101 failure. Set to '-' otherwise. 102 """ 103 self.nsid = nsid 104 """ 105 **(str):** NVMe 'Name Space Identifier' reported on self-test failure. 106 Set to '-' if no namespace is defined. 107 """ 108 self.sct = sct 109 """ 110 **(str):** NVMe 'Status Code Type' reported on self-test failure. 111 Set to '-' if undefined. 112 """ 113 self.code = code 114 """ 115 **(str):** NVMe 'Status Code' reported on self-test failure. 116 Set to '-' if undefined. 117 """ 118 119 def __getstate__(self): 120 return { 121 'num': self.num, 122 'type': self.type, 123 'status': self.status, 124 'hours': self.hours, 125 'lba': self.LBA, 126 'remain': self.remain, 127 'segment': self.segment, 128 'sense': self.sense, 129 'asc': self.ASC, 130 'ascq': self.ASCQ, 131 'nsid': self.nsid, 132 'sct': self.sct, 133 'code': self.code 134 } 135 136 def __repr__(self): 137 """Define a basic representation of the class object.""" 138 return "<SMART Self-test [%s|%s] hrs:%s LBA:%s>" % ( 139 self.type, self.status, self.hours, self.LBA) 140 141 def __str__(self): 142 """ 143 Define a formatted string representation of the object's content. 144 Looks nearly identical to the output of smartctl, without overflowing 145 80-character lines. 146 """ 147 if self._format == 'ata': 148 return "{0:>2} {1:17}{2:30}{3:5}{4:7}{5:17}".format( 149 self.num, self.type, self.status, self.remain, self.hours, 150 self.LBA) 151 elif self._format == 'scsi': 152 # 'Segment' could not be fit on the 80-char line. It's of limited 153 # utility anyway due to it's manufacturer-proprietary nature... 154 return ("{0:>2} {1:17}{2:23}{3:7}{4:14}[{5:4}{6:5}{7:4}]".format( 155 self.num, 156 self.type, 157 self.status, 158 self.hours, 159 self.LBA, 160 self.sense, 161 self.ASC, 162 self.ASCQ 163 )) 164 elif self._format == 'nvme': 165 ## NVME FORMAT ## 166 # Example smartctl output 167 # Self-test Log (NVMe Log 0x06) 168 # Self-test status: Extended self-test in progress (28% completed) 169 # Num Test_Description Status Power_on_Hours Failing_LBA NSID Seg SCT Code 170 # 0 Extended Completed without error 3441 - - - - - 171 return ("{0:^4} {1:<18}{2:<29}{3:>14}{4:>13}{5:>6}{6:>4}{7:>4}{8:>5}".format( 172 self.num, 173 self.type, 174 self.status, 175 self.hours, 176 self.LBA if self.LBA is not None else '-', 177 self.nsid if self.LBA is not None else '-', 178 self.segment if self.segment is not None else '-', 179 self.sct if self.LBA is not None else '-', 180 self.code if self.LBA is not None else '-' 181 )) 182 else: 183 return "Unknown test format: %s" % self._format
Contains all of the information associated with a single SMART Self-test log entry. This data is intended to exactly mirror that obtained through smartctl.
34 def __init__(self, format, num: Optional[int], test_type, status, hours, lba, 35 remain=None, 36 segment=None, 37 sense=None, 38 asc=None, 39 ascq=None, 40 nsid=None, 41 sct=None, 42 code=None): 43 44 self._format = format 45 """ 46 **(str):** Indicates whether this entry was taken from an 'ata' or 47 'scsi' self-test log. Used to display the content properly. 48 """ 49 self.num: Optional[int] = num 50 """ 51 **(int):** Entry's position in the log from 1 (most recent) to 21 52 (least recent). ATA logs save the last 21 entries while SCSI logs 53 only save the last 20. 54 """ 55 self.type = test_type 56 """ 57 **(str):** Type of test run. Generally short, long (extended), or 58 conveyance, plus offline (background) or captive (foreground). 59 """ 60 self.status = status 61 """ 62 **(str):** Self-test's status message, for example 'Completed without 63 error' or 'Completed: read failure'. 64 """ 65 self.hours = hours 66 """ 67 **(str):** The device's power-on hours at the time the self-test 68 was initiated. 69 """ 70 self.LBA = lba 71 """ 72 **(str):** Indicates the first LBA at which an error was encountered 73 during this self-test. Presented as a decimal value for ATA/SATA 74 devices and in hexadecimal notation for SAS/SCSI devices. 75 """ 76 self.remain = remain 77 """ 78 **(str):** Percentage value indicating how much of the self-test is 79 left to perform. '00%' indicates a complete test, while any other 80 value could indicate a test in progress or one that failed prior to 81 completion. Only reported by ATA devices. 82 """ 83 self.segment = segment 84 """ 85 **(str):** A manufacturer-specific self-test segment number reported 86 by SCSI devices on self-test failure. Set to '-' otherwise. 87 """ 88 self.sense = sense 89 """ 90 **(str):** SCSI sense key reported on self-test failure. Set to '-' 91 otherwise. 92 """ 93 self.ASC = asc 94 """ 95 **(str):** SCSI 'Additonal Sense Code' reported on self-test failure. 96 Set to '-' otherwise. 97 """ 98 self.ASCQ = ascq 99 """ 100 **(str):** SCSI 'Additonal Sense Code Quaifier' reported on self-test 101 failure. Set to '-' otherwise. 102 """ 103 self.nsid = nsid 104 """ 105 **(str):** NVMe 'Name Space Identifier' reported on self-test failure. 106 Set to '-' if no namespace is defined. 107 """ 108 self.sct = sct 109 """ 110 **(str):** NVMe 'Status Code Type' reported on self-test failure. 111 Set to '-' if undefined. 112 """ 113 self.code = code 114 """ 115 **(str):** NVMe 'Status Code' reported on self-test failure. 116 Set to '-' if undefined. 117 """
(int): Entry's position in the log from 1 (most recent) to 21 (least recent). ATA logs save the last 21 entries while SCSI logs only save the last 20.
(str): Type of test run. Generally short, long (extended), or conveyance, plus offline (background) or captive (foreground).
(str): Self-test's status message, for example 'Completed without error' or 'Completed: read failure'.
(str): Indicates the first LBA at which an error was encountered during this self-test. Presented as a decimal value for ATA/SATA devices and in hexadecimal notation for SAS/SCSI devices.
(str): Percentage value indicating how much of the self-test is left to perform. '00%' indicates a complete test, while any other value could indicate a test in progress or one that failed prior to completion. Only reported by ATA devices.
(str): A manufacturer-specific self-test segment number reported by SCSI devices on self-test failure. Set to '-' otherwise.
(str): SCSI 'Additonal Sense Code Quaifier' reported on self-test failure. Set to '-' otherwise.
28class Attribute(object): 29 """ 30 Contains all of the information associated with a single SMART attribute 31 in a `Device`'s SMART table. This data is intended to exactly mirror that 32 obtained through smartctl. 33 """ 34 35 def __init__(self, num: int, name, flags: int, value, worst, thresh, attr_type, updated, when_failed, raw): 36 self.num: int = num 37 """**(int):** Attribute's ID as a decimal value (1-255).""" 38 self.name: str = name 39 """ 40 **(str):** Attribute's name, as reported by smartmontools' drive.db. 41 """ 42 self.flags: int = flags 43 """**(int):** Attribute flags as a bit value (ie: 0x0032).""" 44 self._value: str = value 45 """**(str):** Attribute's current normalized value.""" 46 self._worst: str = worst 47 """**(str):** Worst recorded normalized value for this attribute.""" 48 self._thresh: str = thresh 49 """**(str):** Attribute's failure threshold.""" 50 self.type: str = attr_type 51 """**(str):** Attribute's type, generally 'pre-fail' or 'old-age'.""" 52 self.updated: str = updated 53 """ 54 **(str):** When is this attribute updated? Generally 'Always' or 55 'Offline' 56 """ 57 self.when_failed: str = when_failed 58 """ 59 **(str):** When did this attribute cross below 60 `pySMART.attribute.Attribute.thresh`? Reads '-' when not failed. 61 Generally either 'FAILING_NOW' or 'In_the_Past' otherwise. 62 """ 63 self.raw = raw 64 """**(str):** Attribute's current raw (non-normalized) value.""" 65 66 @property 67 def value_str(self) -> str: 68 """Gets the attribute value 69 70 Returns: 71 str: The attribute value in string format 72 """ 73 return self._value 74 75 @property 76 def value_int(self) -> int: 77 """Gets the attribute value 78 79 Returns: 80 int: The attribute value in integer format. 81 """ 82 return int(self._value) 83 84 @property 85 def value(self) -> str: 86 """Gets the attribue value 87 88 Returns: 89 str: The attribute value in string format 90 """ 91 return self.value_str 92 93 @property 94 def worst(self) -> int: 95 """Gets the worst value 96 97 Returns: 98 int: The attribute worst field in integer format 99 """ 100 return int(self._worst) 101 102 @property 103 def thresh(self) -> Optional[int]: 104 """Gets the threshold value 105 106 Returns: 107 int: The attribute threshold field in integer format 108 """ 109 return None if self._thresh == '---' else int(self._thresh) 110 111 @property 112 def raw_int(self) -> Optional[int]: 113 """Gets the raw value converted to int 114 NOTE: Some values may not be correctly converted! 115 116 Returns: 117 int: The attribute raw-value field in integer format. 118 None: In case the raw string failed to be parsed 119 """ 120 try: 121 return int(re.search(r'\d+', self.raw).group()) 122 except: 123 return None 124 125 def __repr__(self): 126 """Define a basic representation of the class object.""" 127 return "<SMART Attribute %r %s/%s raw:%s>" % ( 128 self.name, self.value, self.thresh, self.raw) 129 130 def __str__(self): 131 """ 132 Define a formatted string representation of the object's content. 133 In the interest of not overflowing 80-character lines this does not 134 print the value of `pySMART.attribute.Attribute.flags_hex`. 135 """ 136 return "{0:>3} {1:23}{2:>4}{3:>4}{4:>4} {5:9}{6:8}{7:12}{8}".format( 137 self.num, 138 self.name, 139 self.value, 140 self.worst, 141 self.thresh, 142 self.type, 143 self.updated, 144 self.when_failed, 145 self.raw 146 ) 147 148 def __getstate__(self): 149 return { 150 'name': self.name, 151 'num': self.num, 152 'flags': self.flags, 153 'raw': self.raw, 154 'value': self.value, 155 'worst': self.worst, 156 'thresh': self.thresh, 157 'type': self.type, 158 'updated': self.updated, 159 'when_failed': self.when_failed, 160 # Raw values 161 '_value': self._value, 162 '_worst': self._worst, 163 '_thresh': self._thresh, 164 'raw_int': self.raw_int, 165 166 }
Contains all of the information associated with a single SMART attribute
in a Device
's SMART table. This data is intended to exactly mirror that
obtained through smartctl.
35 def __init__(self, num: int, name, flags: int, value, worst, thresh, attr_type, updated, when_failed, raw): 36 self.num: int = num 37 """**(int):** Attribute's ID as a decimal value (1-255).""" 38 self.name: str = name 39 """ 40 **(str):** Attribute's name, as reported by smartmontools' drive.db. 41 """ 42 self.flags: int = flags 43 """**(int):** Attribute flags as a bit value (ie: 0x0032).""" 44 self._value: str = value 45 """**(str):** Attribute's current normalized value.""" 46 self._worst: str = worst 47 """**(str):** Worst recorded normalized value for this attribute.""" 48 self._thresh: str = thresh 49 """**(str):** Attribute's failure threshold.""" 50 self.type: str = attr_type 51 """**(str):** Attribute's type, generally 'pre-fail' or 'old-age'.""" 52 self.updated: str = updated 53 """ 54 **(str):** When is this attribute updated? Generally 'Always' or 55 'Offline' 56 """ 57 self.when_failed: str = when_failed 58 """ 59 **(str):** When did this attribute cross below 60 `pySMART.attribute.Attribute.thresh`? Reads '-' when not failed. 61 Generally either 'FAILING_NOW' or 'In_the_Past' otherwise. 62 """ 63 self.raw = raw 64 """**(str):** Attribute's current raw (non-normalized) value."""
(str): When did this attribute cross below
pySMART.attribute.Attribute.thresh
? Reads '-' when not failed.
Generally either 'FAILING_NOW' or 'In_the_Past' otherwise.
37class DeviceList(object): 38 """ 39 Represents a list of all the storage devices connected to this computer. 40 """ 41 42 def __init__(self, init: bool = True, smartctl=SMARTCTL, catch_errors: bool = False): 43 """Instantiates and optionally initializes the `DeviceList`. 44 45 Args: 46 init (bool, optional): By default, `pySMART.device_list.DeviceList.devices` 47 is populated with `Device` objects during instantiation. Setting init 48 to False will skip initialization and create an empty 49 `pySMART.device_list.DeviceList` object instead. Defaults to True. 50 smartctl ([type], optional): This stablish the smartctl wrapper. 51 Defaults the global `SMARTCTL` object and should be only 52 overwritten on tests. 53 catch_errors (bool, optional): If True, individual device-parsing errors will be caught 54 """ 55 56 self.devices: List[Device] = [] 57 """ 58 **(list of `Device`):** Contains all storage devices detected during 59 instantiation, as `Device` objects. 60 """ 61 self.smartctl: Smartctl = smartctl 62 """The smartctl wrapper 63 """ 64 if init: 65 self.initialize(catch_errors) 66 67 def __repr__(self): 68 """Define a basic representation of the class object.""" 69 rep = "<DeviceList contents:\n" 70 for device in self.devices: 71 rep += str(device) + '\n' 72 return rep + '>' 73 # return "<DeviceList contents:%r>" % (self.devices) 74 75 def _cleanup(self): 76 """ 77 Removes duplicate ATA devices that correspond to an existing CSMI 78 device. Also removes any device with no capacity value, as this 79 indicates removable storage, ie: CD/DVD-ROM, ZIP, etc. 80 """ 81 # We can't operate directly on the list while we're iterating 82 # over it, so we collect indeces to delete and remove them later 83 to_delete = [] 84 # Enumerate the list to get tuples containing indeces and values 85 for index, device in enumerate(self.devices): 86 if device.interface == 'csmi': 87 for otherindex, otherdevice in enumerate(self.devices): 88 if (otherdevice.interface == 'ata' or 89 otherdevice.interface == 'sata'): 90 if device.serial == otherdevice.serial: 91 to_delete.append(otherindex) 92 device._sd_name = otherdevice.name 93 if device.capacity is None and index not in to_delete: 94 to_delete.append(index) 95 # Recreate the self.devices list without the marked indeces 96 self.devices[:] = [v for i, v in enumerate(self.devices) 97 if i not in to_delete] 98 99 def initialize(self, catch_errors: bool = False): 100 """ 101 Scans system busses for attached devices and add them to the 102 `DeviceList` as `Device` objects. 103 If device list is already populated, it will be cleared first. 104 105 Args: 106 catch_errors (bool, optional): If True, individual device-parsing errors will be caught 107 """ 108 109 # Clear the list if it's already populated 110 if len(self.devices): 111 self.devices = [] 112 113 # Scan for devices 114 for line in self.smartctl.scan(): 115 if not ('failed:' in line or line == ''): 116 groups = re.compile( 117 r'^(\S+)\s+-d\s+(\S+)').match(line).groups() 118 name = groups[0] 119 interface = groups[1] 120 121 try: 122 # Add the device to the list 123 self.devices.append( 124 Device(name, interface=interface, smartctl=self.smartctl)) 125 126 except Exception as e: 127 if catch_errors: 128 # Print the exception 129 import logging 130 131 logging.exception(f"Error parsing device {name}") 132 133 else: 134 # Reraise the exception 135 raise e 136 137 # Remove duplicates and unwanted devices (optical, etc.) from the list 138 self._cleanup() 139 # Sort the list alphabetically by device name 140 self.devices.sort(key=lambda device: device.name) 141 142 def __getitem__(self, index: int) -> Device: 143 """Returns an element from self.devices 144 145 Args: 146 index (int): An index of self.devices 147 148 Returns: 149 Device: Returns a Device that is located on the asked index 150 """ 151 return self.devices[index]
Represents a list of all the storage devices connected to this computer.
42 def __init__(self, init: bool = True, smartctl=SMARTCTL, catch_errors: bool = False): 43 """Instantiates and optionally initializes the `DeviceList`. 44 45 Args: 46 init (bool, optional): By default, `pySMART.device_list.DeviceList.devices` 47 is populated with `Device` objects during instantiation. Setting init 48 to False will skip initialization and create an empty 49 `pySMART.device_list.DeviceList` object instead. Defaults to True. 50 smartctl ([type], optional): This stablish the smartctl wrapper. 51 Defaults the global `SMARTCTL` object and should be only 52 overwritten on tests. 53 catch_errors (bool, optional): If True, individual device-parsing errors will be caught 54 """ 55 56 self.devices: List[Device] = [] 57 """ 58 **(list of `Device`):** Contains all storage devices detected during 59 instantiation, as `Device` objects. 60 """ 61 self.smartctl: Smartctl = smartctl 62 """The smartctl wrapper 63 """ 64 if init: 65 self.initialize(catch_errors)
Instantiates and optionally initializes the DeviceList
.
Args:
init (bool, optional): By default, DeviceList.devices
is populated with Device
objects during instantiation. Setting init
to False will skip initialization and create an empty
DeviceList
object instead. Defaults to True.
smartctl ([type], optional): This stablish the smartctl wrapper.
Defaults the global SMARTCTL
object and should be only
overwritten on tests.
catch_errors (bool, optional): If True, individual device-parsing errors will be caught
99 def initialize(self, catch_errors: bool = False): 100 """ 101 Scans system busses for attached devices and add them to the 102 `DeviceList` as `Device` objects. 103 If device list is already populated, it will be cleared first. 104 105 Args: 106 catch_errors (bool, optional): If True, individual device-parsing errors will be caught 107 """ 108 109 # Clear the list if it's already populated 110 if len(self.devices): 111 self.devices = [] 112 113 # Scan for devices 114 for line in self.smartctl.scan(): 115 if not ('failed:' in line or line == ''): 116 groups = re.compile( 117 r'^(\S+)\s+-d\s+(\S+)').match(line).groups() 118 name = groups[0] 119 interface = groups[1] 120 121 try: 122 # Add the device to the list 123 self.devices.append( 124 Device(name, interface=interface, smartctl=self.smartctl)) 125 126 except Exception as e: 127 if catch_errors: 128 # Print the exception 129 import logging 130 131 logging.exception(f"Error parsing device {name}") 132 133 else: 134 # Reraise the exception 135 raise e 136 137 # Remove duplicates and unwanted devices (optical, etc.) from the list 138 self._cleanup() 139 # Sort the list alphabetically by device name 140 self.devices.sort(key=lambda device: device.name)
Scans system busses for attached devices and add them to the
DeviceList
as Device
objects.
If device list is already populated, it will be cleared first.
Args: catch_errors (bool, optional): If True, individual device-parsing errors will be caught
81class Device(object): 82 """ 83 Represents any device attached to an internal storage interface, such as a 84 hard drive or DVD-ROM, and detected by smartmontools. Includes eSATA 85 (considered SATA) but excludes other external devices (USB, Firewire). 86 """ 87 88 def __init__(self, name: str, interface: Optional[str] = None, abridged: bool = False, smart_options: Union[str, List[str], None] = None, smartctl: Smartctl = SMARTCTL): 89 """Instantiates and initializes the `pySMART.device.Device`.""" 90 if not ( 91 interface is None or 92 smartctl_isvalid_type(interface.lower()) 93 ): 94 raise ValueError( 95 'Unknown interface: {0} specified for {1}'.format(interface, name)) 96 self.abridged = abridged or interface == 'UNKNOWN INTERFACE' 97 if smart_options is not None: 98 if isinstance(smart_options, str): 99 smart_options = smart_options.split(' ') 100 smartctl.add_options(smart_options) 101 self.smartctl = smartctl 102 """ 103 """ 104 self.name: str = name.replace('/dev/', '').replace('nvd', 'nvme') 105 """ 106 **(str):** Device's hardware ID, without the '/dev/' prefix. 107 (ie: sda (Linux), pd0 (Windows)) 108 """ 109 self.family: Optional[str] = None 110 """**(str):** Device's family (if any).""" 111 self.model: Optional[str] = None 112 """**(str):** Device's model number (if any).""" 113 self.serial: Optional[str] = None 114 """**(str):** Device's serial number (if any).""" 115 self._vendor: Optional[str] = None 116 """**(str):** Device's vendor (if any).""" 117 self._interface: Optional[str] = None if interface == 'UNKNOWN INTERFACE' else interface 118 """ 119 **(str):** Device's interface type. Must be one of: 120 * **ATA** - Advanced Technology Attachment 121 * **SATA** - Serial ATA 122 * **SCSI** - Small Computer Systems Interface 123 * **SAS** - Serial Attached SCSI 124 * **SAT** - SCSI-to-ATA Translation (SATA device plugged into a 125 SAS port) 126 * **CSMI** - Common Storage Management Interface (Intel ICH / 127 Matrix RAID) 128 Generally this should not be specified to allow auto-detection to 129 occur. Otherwise, this value overrides the auto-detected type and could 130 produce unexpected or no data. 131 """ 132 self._capacity: Optional[int] = None 133 """**(str):** Device's user capacity as reported directly by smartctl (RAW).""" 134 self._capacity_human: Optional[str] = None 135 """**(str):** Device's user capacity (human readable) as reported directly by smartctl (RAW).""" 136 self.firmware: Optional[str] = None 137 """**(str):** Device's firmware version.""" 138 self.smart_capable: bool = 'nvme' in self.name 139 """ 140 **(bool):** True if the device has SMART Support Available. 141 False otherwise. This is useful for VMs amongst other things. 142 """ 143 self.smart_enabled: bool = 'nvme' in self.name 144 """ 145 **(bool):** True if the device supports SMART (or SCSI equivalent) and 146 has the feature set enabled. False otherwise. 147 """ 148 self.assessment: Optional[str] = None 149 """ 150 **(str):** SMART health self-assessment as reported by the device. 151 """ 152 self.messages: List[str] = [] 153 """ 154 **(list of str):** Contains any SMART warnings or other error messages 155 reported by the device (ie: ascq codes). 156 """ 157 self.is_ssd: bool = True if 'nvme' in self.name else False 158 """ 159 **(bool):** True if this device is a Solid State Drive. 160 False otherwise. 161 """ 162 self.rotation_rate: Optional[int] = None 163 """ 164 **(int):** The Roatation Rate of the Drive if it is not a SSD. 165 The Metric is RPM. 166 """ 167 self.test_capabilities = { 168 'offline': False, # SMART execute Offline immediate (ATA only) 169 'short': 'nvme' not in self.name, # SMART short Self-test 170 'long': 'nvme' not in self.name, # SMART long Self-test 171 'conveyance': False, # SMART Conveyance Self-Test (ATA only) 172 'selective': False, # SMART Selective Self-Test (ATA only) 173 } 174 # Note have not included 'offline' test for scsi as it runs in the foregorund 175 # mode. While this may be beneficial to us in someways it is against the 176 # general layout and pattern that the other tests issued using pySMART are 177 # followed hence not doing it currently 178 """ 179 **(dict): ** This dictionary contains key == 'Test Name' and 180 value == 'True/False' of self-tests that this device is capable of. 181 """ 182 # Note: The above are just default values and can/will be changed 183 # upon update() when the attributes and type of the disk is actually 184 # determined. 185 self.tests: List[TestEntry] = [] 186 """ 187 **(list of `TestEntry`):** Contains the complete SMART self-test log 188 for this device, as provided by smartctl. 189 """ 190 self._test_running = False 191 """ 192 **(bool):** True if a self-test is currently being run. 193 False otherwise. 194 """ 195 self._test_ECD = None 196 """ 197 **(str):** Estimated completion time of the running SMART selftest. 198 Not provided by SAS/SCSI devices. 199 """ 200 self._test_progress = None 201 """ 202 **(int):** Estimate progress percantage of the running SMART selftest. 203 """ 204 self.diagnostics: Diagnostics = Diagnostics() 205 """ 206 **Diagnostics** Contains parsed and processed diagnostic information 207 extracted from the SMART information. Currently only populated for 208 SAS and SCSI devices, since ATA/SATA SMART attributes are manufacturer 209 proprietary. 210 """ 211 self._temperature: Optional[int] = None 212 """ 213 **(int or None): Since SCSI disks do not report attributes like ATA ones 214 we need to grep/regex the shit outta the normal "smartctl -a" output. 215 In case the device have more than one temperature sensor the first value 216 will be stored here too. 217 Note: Temperatures are always in Celsius (if possible). 218 """ 219 self.temperatures: Dict[int, int] = {} 220 """ 221 **(dict of int): NVMe disks usually report multiple temperatures, which 222 will be stored here if available. Keys are sensor numbers as reported in 223 output data. 224 Note: Temperatures are always in Celsius (if possible). 225 """ 226 self.logical_sector_size: Optional[int] = None 227 """ 228 **(int):** The logical sector size of the device (or LBA). 229 """ 230 self.physical_sector_size: Optional[int] = None 231 """ 232 **(int):** The physical sector size of the device. 233 """ 234 self.if_attributes: Union[None, NvmeAttributes, AtaAttributes] = None 235 """ 236 **(NvmeAttributes):** This object may vary for each device interface attributes. 237 It will store all data obtained from smartctl 238 """ 239 240 if self.name is None: 241 warnings.warn( 242 "\nDevice '{0}' does not exist! This object should be destroyed.".format( 243 name) 244 ) 245 return 246 # If no interface type was provided, scan for the device 247 # Lets do this only for the non-abridged case 248 # (we can work with no interface for abridged case) 249 elif self._interface is None and not self.abridged: 250 logger.trace( 251 "Determining interface of disk: {0}".format(self.name)) 252 raw, returncode = self.smartctl.generic_call( 253 ['-d', 'test', self.dev_reference]) 254 255 if len(raw) > 0: 256 # I do not like this parsing logic but it works for now! 257 # just for reference _stdout.split('\n') gets us 258 # something like 259 # [ 260 # ...copyright string..., 261 # '', 262 # "/dev/ada2: Device of type 'atacam' [ATA] detected", 263 # "/dev/ada2: Device of type 'atacam' [ATA] opened", 264 # '' 265 # ] 266 # The above example should be enough for anyone to understand the line below 267 try: 268 for line in reversed(raw): 269 if "opened" in line: 270 self._interface = line.split("'")[1] 271 272 if self._interface == "nvme": # if nvme set SMART to true 273 self.smart_capable = True 274 self.smart_enabled = True 275 276 break 277 except: 278 # for whatever reason we could not get the interface type 279 # we should mark this as an `abbridged` case and move on 280 self._interface = None 281 self.abbridged = True 282 # TODO: Uncomment the classify call if we ever find out that we need it 283 # Disambiguate the generic interface to a specific type 284 # self._classify() 285 else: 286 warnings.warn( 287 "\nDevice '{0}' does not exist! This object should be destroyed.".format( 288 name) 289 ) 290 return 291 # If a valid device was detected, populate its information 292 # OR if in unabridged mode, then do it even without interface info 293 if self._interface is not None or self.abridged: 294 self.update() 295 296 @property 297 def attributes(self) -> List[Optional[Attribute]]: 298 """Returns the SMART attributes of the device. 299 Note: This is only filled with ATA/SATA attributes. SCSI/SAS/NVMe devices will have empty lists!! 300 @deprecated: Use `if_attributes` instead. 301 302 Returns: 303 list of `Attribute`: The SMART attributes of the device. 304 """ 305 if self.if_attributes is None or not isinstance(self.if_attributes, AtaAttributes): 306 return [None] * 256 307 else: 308 return self.if_attributes.legacyAttributes 309 310 @property 311 def dev_interface(self) -> Optional[str]: 312 """Returns the internal interface type of the device. 313 It may not be the same as the interface type as used by smartctl. 314 315 Returns: 316 str: The interface type of the device. (example: ata, scsi, nvme) 317 None if the interface type could not be determined. 318 """ 319 # Try to get the fine-tuned interface type 320 fineType = self._classify() 321 322 # If return still contains a megaraid, just asume it's type 323 if 'megaraid' in fineType: 324 # If any attributes is not None and has at least non None value, then it is a sat+megaraid device 325 if isinstance(self.if_attributes, AtaAttributes): 326 return 'ata' 327 else: 328 return 'sas' 329 330 return fineType 331 332 @property 333 def temperature(self) -> Optional[int]: 334 """Returns the temperature of the device. 335 336 Returns: 337 int: The temperature of the device in Celsius. 338 None if the temperature could not be determined. 339 """ 340 if self.if_attributes is None: 341 return self._temperature 342 else: 343 return self.if_attributes.temperature or self._temperature 344 345 @property 346 def smartctl_interface(self) -> Optional[str]: 347 """Returns the interface type of the device as it is used in smartctl. 348 349 Returns: 350 str: The interface type of the device. (example: ata, scsi, nvme) 351 None if the interface type could not be determined. 352 """ 353 return self._interface 354 355 @property 356 def interface(self) -> Optional[str]: 357 """Returns the interface type of the device as it is used in smartctl. 358 359 Returns: 360 str: The interface type of the device. (example: ata, scsi, nvme) 361 None if the interface type could not be determined. 362 """ 363 return self.smartctl_interface 364 365 @property 366 def dev_reference(self) -> str: 367 """The reference to the device as provided by smartctl. 368 - On unix-like systems, this is the path to the device. (example /dev/<name>) 369 - On MacOS, this is the name of the device. (example <name>) 370 - On Windows, this is the drive letter of the device. (example <drive letter>) 371 372 Returns: 373 str: The reference to the device as provided by smartctl. 374 """ 375 376 # detect if we are on MacOS 377 if 'IOService' in self.name: 378 return self.name 379 380 # otherwise asume we are on unix-like systems 381 return os.path.join('/dev/', self.name) 382 383 @property 384 def vendor(self) -> Optional[str]: 385 """Returns the vendor of the device. 386 387 Returns: 388 str: The vendor of the device. 389 """ 390 if self._vendor: 391 return self._vendor 392 393 # If family is present, try to stract from family. Skip anything but letters. 394 elif self.family: 395 filter = re.search(r'^[a-zA-Z]+', self.family.strip()) 396 if filter: 397 return filter.group(0) 398 399 # If model is present, try to stract from model. Skip anything but letters. 400 elif self.model: 401 filter = re.search(r'^[a-zA-Z]+', self.model.strip()) 402 if filter: 403 return filter.group(0) 404 405 # If all else fails, return None 406 return None 407 408 @property 409 def capacity(self) -> Optional[str]: 410 """Returns the capacity in the raw smartctl format. 411 This may be deprecated in the future and its only retained for compatibility. 412 413 Returns: 414 str: The capacity in the raw smartctl format 415 """ 416 return self._capacity_human 417 418 @property 419 def diags(self) -> Dict[str, str]: 420 """Gets the old/deprecated version of SCSI/SAS diags atribute. 421 """ 422 return self.diagnostics.get_classic_format() 423 424 @property 425 def size_raw(self) -> Optional[str]: 426 """Returns the capacity in the raw smartctl format. 427 428 Returns: 429 str: The capacity in the raw smartctl format 430 """ 431 return self._capacity_human 432 433 @property 434 def size(self) -> int: 435 """Returns the capacity in bytes 436 437 Returns: 438 int: The capacity in bytes 439 """ 440 import humanfriendly 441 442 if self._capacity is not None: 443 return self._capacity 444 elif self._capacity_human is not None: 445 return humanfriendly.parse_size(self._capacity_human) 446 else: 447 return 0 448 449 @property 450 def sector_size(self) -> int: 451 """Returns the sector size of the device. 452 453 Returns: 454 int: The sector size of the device in Bytes. If undefined, we'll assume 512B 455 """ 456 if self.logical_sector_size is not None: 457 return self.logical_sector_size 458 elif self.physical_sector_size is not None: 459 return self.physical_sector_size 460 else: 461 return 512 462 463 def __repr__(self): 464 """Define a basic representation of the class object.""" 465 return "<{0} device on /dev/{1} mod:{2} sn:{3}>".format( 466 self._interface.upper() if self._interface else 'UNKNOWN INTERFACE', 467 self.name, 468 self.model, 469 self.serial 470 ) 471 472 def __getstate__(self, all_info=True): 473 """ 474 Allows us to send a pySMART Device object over a serializable 475 medium which uses json (or the likes of json) payloads 476 """ 477 return None 478 state_dict = { 479 'interface': self._interface if self._interface else 'UNKNOWN INTERFACE', 480 'model': self.model, 481 'firmware': self.firmware, 482 'smart_capable': self.smart_capable, 483 'smart_enabled': self.smart_enabled, 484 'smart_status': self.assessment, 485 'messages': self.messages, 486 'test_capabilities': self.test_capabilities.copy(), 487 'tests': [t.__getstate__() for t in self.tests] if self.tests else [], 488 'diagnostics': self.diagnostics.__getstate__(all_info), 489 'temperature': self.temperature, 490 'attributes': [attr.__getstate__() if attr else None for attr in self.attributes], 491 'if_attributes': self.if_attributes.__getstate__(all_info) if self.if_attributes else None, 492 } 493 if all_info: 494 state_dict.update({ 495 'name': self.name, 496 'path': self.dev_reference, 497 'serial': self.serial, 498 'is_ssd': self.is_ssd, 499 'rotation_rate': self.rotation_rate, 500 'capacity': self._capacity_human 501 }) 502 return state_dict 503 504 def __setstate__(self, state): 505 state['assessment'] = state['smart_status'] 506 del state['smart_status'] 507 self.__dict__.update(state) 508 509 def smart_toggle(self, action: str) -> Tuple[bool, List[str]]: 510 """ 511 A basic function to enable/disable SMART on device. 512 513 # Args: 514 * **action (str):** Can be either 'on'(for enabling) or 'off'(for disabling). 515 516 # Returns" 517 * **(bool):** Return True (if action succeded) else False 518 * **(List[str]):** None if option succeded else contains the error message. 519 """ 520 # Lets make the action verb all lower case 521 if self._interface == 'nvme': 522 return False, ['NVME devices do not currently support toggling SMART enabled'] 523 action_lower = action.lower() 524 if action_lower not in ['on', 'off']: 525 return False, ['Unsupported action {0}'.format(action)] 526 # Now lets check if the device's smart enabled status is already that of what 527 # the supplied action is intending it to be. If so then just return successfully 528 if self.smart_enabled: 529 if action_lower == 'on': 530 return True, [] 531 else: 532 if action_lower == 'off': 533 return True, [] 534 if self._interface is not None: 535 raw, returncode = self.smartctl.generic_call( 536 ['-s', action_lower, '-d', self._interface, self.dev_reference]) 537 else: 538 raw, returncode = self.smartctl.generic_call( 539 ['-s', action_lower, self.dev_reference]) 540 541 if returncode != 0: 542 return False, raw 543 # if everything worked out so far lets perform an update() and check the result 544 self.update() 545 if action_lower == 'off' and self.smart_enabled: 546 return False, ['Failed to turn SMART off.'] 547 if action_lower == 'on' and not self.smart_enabled: 548 return False, ['Failed to turn SMART on.'] 549 return True, [] 550 551 def all_attributes(self, print_fn=print): 552 """ 553 Prints the entire SMART attribute table, in a format similar to 554 the output of smartctl. 555 allows usage of custom print function via parameter print_fn by default uses print 556 """ 557 header_printed = False 558 for attr in self.attributes: 559 if attr is not None: 560 if not header_printed: 561 print_fn("{0:>3} {1:24}{2:4}{3:4}{4:4}{5:9}{6:8}{7:12}{8}" 562 .format('ID#', 'ATTRIBUTE_NAME', 'CUR', 'WST', 'THR', 'TYPE', 'UPDATED', 'WHEN_FAIL', 563 'RAW')) 564 header_printed = True 565 print_fn(attr) 566 if not header_printed: 567 print_fn('This device does not support SMART attributes.') 568 569 def all_selftests(self): 570 """ 571 Prints the entire SMART self-test log, in a format similar to 572 the output of smartctl. 573 """ 574 if self.tests: 575 all_tests = [] 576 if smartctl_type(self._interface) == 'scsi': 577 header = "{0:3}{1:17}{2:23}{3:7}{4:14}{5:15}".format( 578 'ID', 579 'Test Description', 580 'Status', 581 'Hours', 582 '1st_Error@LBA', 583 '[SK ASC ASCQ]' 584 ) 585 else: 586 header = ("{0:3}{1:17}{2:30}{3:5}{4:7}{5:17}".format( 587 'ID', 588 'Test_Description', 589 'Status', 590 'Left', 591 'Hours', 592 '1st_Error@LBA')) 593 all_tests.append(header) 594 for test in self.tests: 595 all_tests.append(str(test)) 596 597 return all_tests 598 else: 599 no_tests = 'No self-tests have been logged for this device.' 600 return no_tests 601 602 def _classify(self) -> str: 603 """ 604 Disambiguates generic device types ATA and SCSI into more specific 605 ATA, SATA, SAS, SAT and SCSI. 606 """ 607 608 fine_interface = self._interface or '' 609 # SCSI devices might be SCSI, SAS or SAT 610 # ATA device might be ATA or SATA 611 if fine_interface in ['scsi', 'ata'] or 'megaraid' in fine_interface: 612 if 'megaraid' in fine_interface: 613 if not 'sat+' in fine_interface: 614 test = 'sat'+fine_interface 615 else: 616 test = fine_interface 617 else: 618 test = 'sat' if fine_interface == 'scsi' else 'sata' 619 # Look for a SATA PHY to detect SAT and SATA 620 raw, returncode = self.smartctl.try_generic_call([ 621 '-d', 622 smartctl_type(test), 623 '-l', 624 'sataphy', 625 self.dev_reference]) 626 627 if returncode == 0 and 'GP Log 0x11' in raw[3]: 628 fine_interface = test 629 # If device type is still SCSI (not changed to SAT above), then 630 # check for a SAS PHY 631 if fine_interface in ['scsi'] or 'megaraid' in fine_interface: 632 raw, returncode = self.smartctl.try_generic_call([ 633 '-d', 634 smartctl_type(fine_interface), 635 '-l', 636 'sasphy', 637 self.dev_reference]) 638 if returncode == 0 and 'SAS SSP' in raw[4]: 639 fine_interface = 'sas' 640 # Some older SAS devices do not support the SAS PHY log command. 641 # For these, see if smartmontools reports a transport protocol. 642 else: 643 raw = self.smartctl.all(self.dev_reference, fine_interface) 644 645 for line in raw: 646 if 'Transport protocol' in line and 'SAS' in line: 647 fine_interface = 'sas' 648 649 return fine_interface 650 651 def _guess_smart_type(self, line): 652 """ 653 This function is not used in the generic wrapper, however the header 654 is defined so that it can be monkey-patched by another application. 655 """ 656 pass 657 658 def _make_smart_warnings(self): 659 """ 660 Parses an ATA/SATA SMART table for attributes with the 'when_failed' 661 value set. Generates an warning message for any such attributes and 662 updates the self-assessment value if necessary. 663 """ 664 if smartctl_type(self._interface) == 'scsi': 665 return 666 for attr in self.attributes: 667 if attr is not None: 668 if attr.when_failed == 'In_the_past': 669 warn_str = "{0} failed in the past with value {1}. [Threshold: {2}]".format( 670 attr.name, attr.worst, attr.thresh) 671 self.messages.append(warn_str) 672 if not self.assessment == 'FAIL': 673 self.assessment = 'WARN' 674 elif attr.when_failed == 'FAILING_NOW': 675 warn_str = "{0} is failing now with value {1}. [Threshold: {2}]".format( 676 attr.name, attr.value, attr.thresh) 677 self.assessment = 'FAIL' 678 self.messages.append(warn_str) 679 elif not attr.when_failed == '-': 680 warn_str = "{0} says it failed '{1}'. [V={2},W={3},T={4}]".format( 681 attr.name, attr.when_failed, attr.value, attr.worst, attr.thresh) 682 self.messages.append(warn_str) 683 if not self.assessment == 'FAIL': 684 self.assessment = 'WARN' 685 686 def get_selftest_result(self, output=None): 687 """ 688 Refreshes a device's `pySMART.device.Device.tests` attribute to obtain 689 the latest test results. If a new test result is obtained, its content 690 is returned. 691 692 # Args: 693 * **output (str, optional):** If set to 'str', the string 694 representation of the most recent test result will be returned, instead 695 of a `Test_Entry` object. 696 697 # Returns: 698 * **(int):** Return status code. One of the following: 699 * 0 - Success. Object (or optionally, string rep) is attached. 700 * 1 - Self-test in progress. Must wait for it to finish. 701 * 2 - No new test results. 702 * 3 - The Self-test was Aborted by host 703 * **(`Test_Entry` or str):** Most recent `Test_Entry` object (or 704 optionally it's string representation) if new data exists. Status 705 message string on failure. 706 * **(int):** Estimate progress percantage of the running SMART selftest, if known. 707 Otherwise 'None'. 708 """ 709 # SCSI self-test logs hold 20 entries while ATA logs hold 21 710 if smartctl_type(self._interface) == 'scsi': 711 maxlog = 20 712 else: 713 maxlog = 21 714 # If we looked only at the most recent test result we could be fooled 715 # by two short tests run close together (within the same hour) 716 # appearing identical. Comparing the length of the log adds some 717 # confidence until it maxes, as above. Comparing the least-recent test 718 # result greatly diminishes the chances that two sets of two tests each 719 # were run within an hour of themselves, but with 16-17 other tests run 720 # in between them. 721 if self.tests: 722 _first_entry = self.tests[0] 723 _len = len(self.tests) 724 _last_entry = self.tests[_len - 1] 725 else: 726 _len = 0 727 self.update() 728 # Since I have changed the update() parsing to DTRT to pickup currently 729 # running selftests we can now purely rely on that for self._test_running 730 # Thus check for that variable first and return if it is True with appropos message. 731 if self._test_running is True: 732 return 1, 'Self-test in progress. Please wait.', self._test_progress 733 # Check whether the list got longer (ie: new entry) 734 # If so return the newest test result 735 # If not, because it's max size already, check for new entries 736 if ( 737 (len(self.tests) != _len) or 738 ( 739 len == maxlog and 740 ( 741 _first_entry.type != self.tests[0].type or 742 _first_entry.hours != self.tests[0].hours or 743 _last_entry.type != self.tests[len(self.tests) - 1].type or 744 _last_entry.hours != self.tests[len( 745 self.tests) - 1].hours 746 ) 747 ) 748 ): 749 return ( 750 0 if 'Aborted' not in self.tests[0].status else 3, 751 str(self.tests[0]) if output == 'str' else self.tests[0], 752 None 753 ) 754 else: 755 return 2, 'No new self-test results found.', None 756 757 def abort_selftest(self): 758 """ 759 Aborts non-captive SMART Self Tests. Note that this command 760 will abort the Offline Immediate Test routine only if your disk 761 has the "Abort Offline collection upon new command" capability. 762 763 # Args: Nothing (just aborts directly) 764 765 # Returns: 766 * **(int):** The returncode of calling `smartctl -X device_path` 767 """ 768 return self.smartctl.test_stop(smartctl_type(self._interface), self.dev_reference) 769 770 def run_selftest(self, test_type, ETA_type='date'): 771 """ 772 Instructs a device to begin a SMART self-test. All tests are run in 773 'offline' / 'background' mode, allowing normal use of the device while 774 it is being tested. 775 776 # Args: 777 * **test_type (str):** The type of test to run. Accepts the following 778 (not case sensitive): 779 * **short** - Brief electo-mechanical functionality check. 780 Generally takes 2 minutes or less. 781 * **long** - Thorough electro-mechanical functionality check, 782 including complete recording media scan. Generally takes several 783 hours. 784 * **conveyance** - Brief test used to identify damage incurred in 785 shipping. Generally takes 5 minutes or less. **This test is not 786 supported by SAS or SCSI devices.** 787 * **offline** - Runs SMART Immediate Offline Test. The effects of 788 this test are visible only in that it updates the SMART Attribute 789 values, and if errors are found they will appear in the SMART error 790 log, visible with the '-l error' option to smartctl. **This test is 791 not supported by SAS or SCSI devices in pySMART use cli smartctl for 792 running 'offline' selftest (runs in foreground) on scsi devices.** 793 * **ETA_type** - Format to return the estimated completion time/date 794 in. Default is 'date'. One could otherwise specidy 'seconds'. 795 Again only for ATA devices. 796 797 # Returns: 798 * **(int):** Return status code. One of the following: 799 * 0 - Self-test initiated successfully 800 * 1 - Previous self-test running. Must wait for it to finish. 801 * 2 - Unknown or unsupported (by the device) test type requested. 802 * 3 - Unspecified smartctl error. Self-test not initiated. 803 * **(str):** Return status message. 804 * **(str)/(float):** Estimated self-test completion time if a test is started. 805 The optional argument of 'ETA_type' (see above) controls the return type. 806 if 'ETA_type' == 'date' then a date string is returned else seconds(float) 807 is returned. 808 Note: The self-test completion time can only be obtained for ata devices. 809 Otherwise 'None'. 810 """ 811 # Lets call get_selftest_result() here since it does an update() and 812 # checks for an existing selftest is running or not, this way the user 813 # can issue a test from the cli and this can still pick that up 814 # Also note that we do not need to obtain the results from this as the 815 # data is already stored in the Device class object's variables 816 self.get_selftest_result() 817 if self._test_running: 818 return 1, 'Self-test in progress. Please wait.', self._test_ECD 819 test_type = test_type.lower() 820 interface = smartctl_type(self._interface) 821 try: 822 if not self.test_capabilities[test_type]: 823 return ( 824 2, 825 "Device {0} does not support the '{1}' test ".format( 826 self.name, test_type), 827 None 828 ) 829 except KeyError: 830 return 2, "Unknown test type '{0}' requested.".format(test_type), None 831 832 raw, rc = self.smartctl.test_start( 833 interface, test_type, self.dev_reference) 834 _success = False 835 _running = False 836 for line in raw: 837 if 'has begun' in line: 838 _success = True 839 self._test_running = True 840 if 'aborting current test' in line: 841 _running = True 842 try: 843 self._test_progress = 100 - \ 844 int(line.split('(')[-1].split('%')[0]) 845 except ValueError: 846 pass 847 848 if _success and 'complete after' in line: 849 self._test_ECD = line[25:].rstrip() 850 if ETA_type == 'seconds': 851 self._test_ECD = mktime( 852 strptime(self._test_ECD, '%a %b %d %H:%M:%S %Y')) - time() 853 self._test_progress = 0 854 if _success: 855 return 0, 'Self-test started successfully', self._test_ECD 856 else: 857 if _running: 858 return 1, 'Self-test already in progress. Please wait.', self._test_ECD 859 else: 860 return 3, 'Unspecified Error. Self-test not started.', None 861 862 def run_selftest_and_wait(self, test_type, output=None, polling=5, progress_handler=None): 863 """ 864 This is essentially a wrapper around run_selftest() such that we 865 call self.run_selftest() and wait on the running selftest till 866 it finished before returning. 867 The above holds true for all pySMART supported tests with the 868 exception of the 'offline' test (ATA only) as it immediately 869 returns, since the entire test only affects the smart error log 870 (if any errors found) and updates the SMART attributes. Other 871 than that it is not visibile anywhere else, so we start it and 872 simply return. 873 # Args: 874 * **test_type (str):** The type of test to run. Accepts the following 875 (not case sensitive): 876 * **short** - Brief electo-mechanical functionality check. 877 Generally takes 2 minutes or less. 878 * **long** - Thorough electro-mechanical functionality check, 879 including complete recording media scan. Generally takes several 880 hours. 881 * **conveyance** - Brief test used to identify damage incurred in 882 shipping. Generally takes 5 minutes or less. **This test is not 883 supported by SAS or SCSI devices.** 884 * **offline** - Runs SMART Immediate Offline Test. The effects of 885 this test are visible only in that it updates the SMART Attribute 886 values, and if errors are found they will appear in the SMART error 887 log, visible with the '-l error' option to smartctl. **This test is 888 not supported by SAS or SCSI devices in pySMART use cli smartctl for 889 running 'offline' selftest (runs in foreground) on scsi devices.** 890 * **output (str, optional):** If set to 'str', the string 891 representation of the most recent test result will be returned, 892 instead of a `Test_Entry` object. 893 * **polling (int, default=5):** The time duration to sleep for between 894 checking for test_results and progress. 895 * **progress_handler (function, optional):** This if provided is called 896 with self._test_progress as the supplied argument everytime a poll to 897 check the status of the selftest is done. 898 # Returns: 899 * **(int):** Return status code. One of the following: 900 * 0 - Self-test executed and finished successfully 901 * 1 - Previous self-test running. Must wait for it to finish. 902 * 2 - Unknown or illegal test type requested. 903 * 3 - The Self-test was Aborted by host 904 * 4 - Unspecified smartctl error. Self-test not initiated. 905 * **(`Test_Entry` or str):** Most recent `Test_Entry` object (or 906 optionally it's string representation) if new data exists. Status 907 message string on failure. 908 """ 909 test_initiation_result = self.run_selftest(test_type) 910 if test_initiation_result[0] != 0: 911 return test_initiation_result[:2] 912 if test_type == 'offline': 913 self._test_running = False 914 # if not then the test initiated correctly and we can start the polling. 915 # For now default 'polling' value is 5 seconds if not specified by the user 916 917 # Do an initial check, for good measure. 918 # In the probably impossible case that self._test_running is instantly False... 919 selftest_results = self.get_selftest_result(output=output) 920 while self._test_running: 921 if selftest_results[0] != 1: 922 # the selftest is run and finished lets return with the results 923 break 924 # Otherwise see if we are provided with the progress_handler to update progress 925 if progress_handler is not None: 926 progress_handler( 927 selftest_results[2] if selftest_results[2] is not None else 50) 928 # Now sleep 'polling' seconds before checking the progress again 929 sleep(polling) 930 931 # Check after the sleep to ensure we return the right result, and not an old one. 932 selftest_results = self.get_selftest_result(output=output) 933 934 # Now if (selftes_results[0] == 2) i.e No new selftest (because the same 935 # selftest was run twice within the last hour) but we know for a fact that 936 # we just ran a new selftest then just return the latest entry in self.tests 937 if selftest_results[0] == 2: 938 selftest_return_value = 0 if 'Aborted' not in self.tests[0].status else 3 939 return selftest_return_value, str(self.tests[0]) if output == 'str' else self.tests[0] 940 return selftest_results[:2] 941 942 def update(self): 943 """ 944 Queries for device information using smartctl and updates all 945 class members, including the SMART attribute table and self-test log. 946 Can be called at any time to refresh the `pySMART.device.Device` 947 object's data content. 948 """ 949 # set temperature back to None so that if update() is called more than once 950 # any logic that relies on self.temperature to be None to rescan it works.it 951 self._temperature = None 952 # same for temperatures 953 self.temperatures = {} 954 if self.abridged: 955 interface = None 956 raw = self.smartctl.info(self.dev_reference) 957 958 else: 959 interface = smartctl_type(self._interface) 960 raw = self.smartctl.all( 961 self.dev_reference, interface) 962 963 parse_self_tests = False 964 parse_running_test = False 965 parse_ascq = False 966 message = '' 967 self.tests = [] 968 self._test_running = False 969 self._test_progress = None 970 # Lets skip the first couple of non-useful lines 971 _stdout = raw[4:] 972 973 ####################################### 974 # Encoding fixing # 975 ####################################### 976 # In some scenarios, smartctl returns some lines with a different/strange encoding 977 # This is a workaround to fix that 978 for i, line in enumerate(_stdout): 979 # character ' ' (U+202F) should be removed 980 _stdout[i] = line.replace('\u202f', '') 981 982 ####################################### 983 # Dedicated interface attributes # 984 ####################################### 985 if AtaAttributes.has_compatible_data(iter(_stdout)): 986 self.if_attributes = AtaAttributes(iter(_stdout)) 987 988 elif self.dev_interface == 'nvme': 989 self.if_attributes = NvmeAttributes(iter(_stdout)) 990 991 # Get Tests 992 for test in self.if_attributes.tests: 993 self.tests.append(TestEntry('nvme', test.num, test.description, test.status, test.powerOnHours, 994 test.failingLBA, nsid=test.nsid, segment=test.seg, sct=test.sct, code=test.code, remain=100-test.progress)) 995 996 # Set running test 997 if any(test.status == 'Running' for test in self.if_attributes.tests): 998 self._test_running = True 999 self._test_progress = self.if_attributes.tests[0].progress 1000 else: 1001 self._test_running = False 1002 self._test_progress = None 1003 1004 else: 1005 self.if_attributes = None 1006 1007 ####################################### 1008 # Global / generic attributes # 1009 ####################################### 1010 stdout_iter = iter(_stdout) 1011 for line in stdout_iter: 1012 if line.strip() == '': # Blank line stops sub-captures 1013 if parse_self_tests is True: 1014 parse_self_tests = False 1015 if parse_ascq: 1016 parse_ascq = False 1017 self.messages.append(message) 1018 if parse_ascq: 1019 message += ' ' + line.lstrip().rstrip() 1020 if parse_self_tests: 1021 # Detect Test Format 1022 1023 ## SCSI/SAS FORMAT ## 1024 # Example smartctl output 1025 # SMART Self-test log 1026 # Num Test Status segment LifeTime LBA_first_err [SK ASC ASQ] 1027 # Description number (hours) 1028 # # 1 Background short Completed - 33124 - [- - -] 1029 format_scsi = re.compile( 1030 r'^[#\s]*(\d+)\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s+\[([^\s]+)\s+([^\s]+)\s+([^\s]+)\]$').match(line) 1031 1032 ## ATA FORMAT ## 1033 # Example smartctl output: 1034 # SMART Self-test log structure revision number 1 1035 # Num Test_Description Status Remaining LifeTime(hours) LBA_of_first_error 1036 # # 1 Extended offline Completed without error 00% 46660 - 1037 format_ata = re.compile( 1038 r'^[#\s]*(\d+)\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s{1,}(.*[^\s])\s{2,}(.*[^\s])\s{2,}(.*[^\s])$').match(line) 1039 1040 if format_scsi is not None: 1041 format = 'scsi' 1042 parsed = format_scsi.groups() 1043 num = int(parsed[0]) 1044 test_type = parsed[1] 1045 status = parsed[2] 1046 segment = parsed[3] 1047 hours = parsed[4] 1048 lba = parsed[5] 1049 sense = parsed[6] 1050 asc = parsed[7] 1051 ascq = parsed[8] 1052 self.tests.append(TestEntry( 1053 format, 1054 num, 1055 test_type, 1056 status, 1057 hours, 1058 lba, 1059 segment=segment, 1060 sense=sense, 1061 asc=asc, 1062 ascq=ascq 1063 )) 1064 elif format_ata is not None: 1065 ## ATA FORMAT ## 1066 format = 'ata' 1067 parsed = format_ata.groups() 1068 num = parsed[0] 1069 test_type = parsed[1] 1070 status = parsed[2] 1071 remain = parsed[3] 1072 hours = parsed[4] 1073 lba = parsed[5] 1074 1075 try: 1076 num = int(num) 1077 except: 1078 num = None 1079 1080 self.tests.append( 1081 TestEntry(format, num, test_type, status, 1082 hours, lba, remain=remain) 1083 ) 1084 else: 1085 pass 1086 1087 # Basic device information parsing 1088 if any_in(line, 'Device Model', 'Product', 'Model Number'): 1089 self.model = line.split(':')[1].lstrip().rstrip() 1090 self._guess_smart_type(line.lower()) 1091 continue 1092 1093 if 'Model Family' in line: 1094 self.family = line.split(':')[1].strip() 1095 self._guess_smart_type(line.lower()) 1096 continue 1097 1098 if 'LU WWN' in line: 1099 self._guess_smart_type(line.lower()) 1100 continue 1101 1102 if any_in(line, 'Serial Number', 'Serial number'): 1103 try: 1104 self.serial = line.split(':')[1].split()[0].rstrip() 1105 except IndexError: 1106 # Serial reported empty 1107 self.serial = "" 1108 continue 1109 1110 vendor = re.compile(r'^Vendor:\s+(\w+)').match(line) 1111 if vendor is not None: 1112 self._vendor = vendor.groups()[0] 1113 1114 if any_in(line, 'Firmware Version', 'Revision'): 1115 self.firmware = line.split(':')[1].strip() 1116 1117 if any_in(line, 'User Capacity', 'Total NVM Capacity', 'Namespace 1 Size/Capacity'): 1118 # TODO: support for multiple NVMe namespaces 1119 m = re.match( 1120 r'.*:\s+([\d,. \u2019\u00a0]+)\s\D*\[?([^\]]+)?\]?', line.strip()) 1121 1122 if m is not None: 1123 tmp = m.groups() 1124 if tmp[0] == ' ': 1125 # This capacity is set to 0, skip it 1126 continue 1127 1128 self._capacity = int( 1129 tmp[0].strip().replace(',', '').replace('.', '').replace(' ', '').replace('\u2019', '').replace('\u00a0', '')) 1130 1131 if len(tmp) == 2 and tmp[1] is not None: 1132 self._capacity_human = tmp[1].strip().replace(',', '.') 1133 1134 if 'SMART support' in line: 1135 # self.smart_capable = 'Available' in line 1136 # self.smart_enabled = 'Enabled' in line 1137 # Since this line repeats twice the above method is flawed 1138 # Lets try the following instead, it is a bit redundant but 1139 # more robust. 1140 if any_in(line, 'Unavailable', 'device lacks SMART capability'): 1141 self.smart_capable = False 1142 self.smart_enabled = False 1143 elif 'Enabled' in line: 1144 self.smart_enabled = True 1145 elif 'Disabled' in line: 1146 self.smart_enabled = False 1147 elif any_in(line, 'Available', 'device has SMART capability'): 1148 self.smart_capable = True 1149 continue 1150 1151 if 'does not support SMART' in line: 1152 self.smart_capable = False 1153 self.smart_enabled = False 1154 continue 1155 1156 if 'Rotation Rate' in line: 1157 if 'Solid State Device' in line: 1158 self.is_ssd = True 1159 elif 'rpm' in line: 1160 self.is_ssd = False 1161 try: 1162 self.rotation_rate = int( 1163 line.split(':')[1].lstrip().rstrip()[:-4]) 1164 except ValueError: 1165 # Cannot parse the RPM? Assigning None instead 1166 self.rotation_rate = None 1167 continue 1168 1169 if 'SMART overall-health self-assessment' in line: # ATA devices 1170 if line.split(':')[1].strip() == 'PASSED': 1171 self.assessment = 'PASS' 1172 else: 1173 self.assessment = 'FAIL' 1174 continue 1175 1176 if 'SMART Health Status' in line: # SCSI devices 1177 if line.split(':')[1].strip() == 'OK': 1178 self.assessment = 'PASS' 1179 else: 1180 self.assessment = 'FAIL' 1181 parse_ascq = True # Set flag to capture status message 1182 message = line.split(':')[1].lstrip().rstrip() 1183 continue 1184 1185 # Parse SMART test capabilities (ATA only) 1186 # Note: SCSI does not list this but and allows for only 'offline', 'short' and 'long' 1187 if 'SMART execute Offline immediate' in line: 1188 self.test_capabilities['offline'] = 'No' not in line 1189 continue 1190 1191 if 'Conveyance Self-test supported' in line: 1192 self.test_capabilities['conveyance'] = 'No' not in line 1193 continue 1194 1195 if 'Selective Self-test supported' in line: 1196 self.test_capabilities['selective'] = 'No' not in line 1197 continue 1198 1199 if 'Self-test supported' in line: 1200 self.test_capabilities['short'] = 'No' not in line 1201 self.test_capabilities['long'] = 'No' not in line 1202 continue 1203 1204 # Parse SMART test capabilities (NVMe only) 1205 if 'Optional Admin Commands' in line: 1206 if 'Self_Test' in line: 1207 self.test_capabilities['short'] = True 1208 self.test_capabilities['long'] = True 1209 1210 # For some reason smartctl does not show a currently running test 1211 # for 'ATA' in the Test log so I just have to catch it this way i guess! 1212 # For 'scsi' I still do it since it is the only place I get % remaining in scsi 1213 if 'Self-test execution status' in line: 1214 if 'progress' in line: 1215 self._test_running = True 1216 # for ATA the "%" remaining is on the next line 1217 # thus set the parse_running_test flag and move on 1218 parse_running_test = True 1219 elif '%' in line: 1220 # for scsi the progress is on the same line 1221 # so we can just parse it and move on 1222 self._test_running = True 1223 try: 1224 self._test_progress = 100 - \ 1225 int(line.split('%')[0][-3:].strip()) 1226 except ValueError: 1227 pass 1228 continue 1229 if parse_running_test is True: 1230 try: 1231 self._test_progress = 100 - \ 1232 int(line.split('%')[0][-3:].strip()) 1233 except ValueError: 1234 pass 1235 parse_running_test = False 1236 1237 if "Self-test log" in line: 1238 parse_self_tests = True # Set flag to capture test entries 1239 continue 1240 1241 ####################################### 1242 # SCSI only # 1243 ####################################### 1244 # 1245 # Everything from here on is parsing SCSI information that takes 1246 # the place of similar ATA SMART information 1247 if 'used endurance' in line: 1248 pct = int(line.split(':')[1].strip()[:-1]) 1249 self.diagnostics.Life_Left = 100 - pct 1250 continue 1251 1252 if 'Specified cycle count' in line: 1253 self.diagnostics.Start_Stop_Spec = int( 1254 line.split(':')[1].strip()) 1255 continue 1256 1257 if 'Accumulated start-stop cycles' in line: 1258 self.diagnostics.Start_Stop_Cycles = int( 1259 line.split(':')[1].strip()) 1260 if self.diagnostics.Start_Stop_Spec and self.diagnostics.Start_Stop_Spec != 0: 1261 self.diagnostics.Start_Stop_Pct_Left = int(round( 1262 100 - (self.diagnostics.Start_Stop_Cycles / 1263 self.diagnostics.Start_Stop_Spec), 0)) 1264 continue 1265 1266 if 'Specified load-unload count' in line: 1267 self.diagnostics.Load_Cycle_Spec = int( 1268 line.split(':')[1].strip()) 1269 continue 1270 1271 if 'Accumulated load-unload cycles' in line: 1272 self.diagnostics.Load_Cycle_Count = int( 1273 line.split(':')[1].strip()) 1274 if self.diagnostics.Load_Cycle_Spec and self.diagnostics.Load_Cycle_Spec != 0: 1275 self.diagnostics.Load_Cycle_Pct_Left = int(round( 1276 100 - (self.diagnostics.Load_Cycle_Count / 1277 self.diagnostics.Load_Cycle_Spec), 0)) 1278 continue 1279 1280 if 'Elements in grown defect list' in line: 1281 self.diagnostics.Reallocated_Sector_Ct = int( 1282 line.split(':')[1].strip()) 1283 continue 1284 1285 if 'read:' in line: 1286 line_ = ' '.join(line.split()).split(' ') 1287 if line_[1] == '0' and line_[2] == '0' and line_[3] == '0' and line_[4] == '0': 1288 self.diagnostics.Corrected_Reads = 0 1289 elif line_[4] == '0': 1290 self.diagnostics.Corrected_Reads = int( 1291 line_[1]) + int(line_[2]) + int(line_[3]) 1292 else: 1293 self.diagnostics.Corrected_Reads = int(line_[4]) 1294 self.diagnostics._Reads_GB = float(line_[6].replace(',', '.')) 1295 self.diagnostics._Uncorrected_Reads = int(line_[7]) 1296 continue 1297 1298 if 'write:' in line: 1299 line_ = ' '.join(line.split()).split(' ') 1300 if (line_[1] == '0' and line_[2] == '0' and 1301 line_[3] == '0' and line_[4] == '0'): 1302 self.diagnostics.Corrected_Writes = 0 1303 elif line_[4] == '0': 1304 self.diagnostics.Corrected_Writes = int( 1305 line_[1]) + int(line_[2]) + int(line_[3]) 1306 else: 1307 self.diagnostics.Corrected_Writes = int(line_[4]) 1308 self.diagnostics._Writes_GB = float(line_[6].replace(',', '.')) 1309 self.diagnostics._Uncorrected_Writes = int(line_[7]) 1310 continue 1311 1312 if 'verify:' in line: 1313 line_ = ' '.join(line.split()).split(' ') 1314 if (line_[1] == '0' and line_[2] == '0' and 1315 line_[3] == '0' and line_[4] == '0'): 1316 self.diagnostics.Corrected_Verifies = 0 1317 elif line_[4] == '0': 1318 self.diagnostics.Corrected_Verifies = int( 1319 line_[1]) + int(line_[2]) + int(line_[3]) 1320 else: 1321 self.diagnostics.Corrected_Verifies = int(line_[4]) 1322 self.diagnostics._Verifies_GB = float( 1323 line_[6].replace(',', '.')) 1324 self.diagnostics._Uncorrected_Verifies = int(line_[7]) 1325 continue 1326 1327 if 'non-medium error count' in line: 1328 self.diagnostics.Non_Medium_Errors = int( 1329 line.split(':')[1].strip()) 1330 continue 1331 1332 if 'Accumulated power on time' in line: 1333 self.diagnostics.Power_On_Hours = int( 1334 line.split(':')[1].split(' ')[1]) 1335 continue 1336 1337 if 'Current Drive Temperature' in line or ('Temperature:' in 1338 line and interface == 'nvme'): 1339 try: 1340 self._temperature = int( 1341 line.split(':')[-1].strip().split()[0]) 1342 1343 if 'fahrenheit' in line.lower(): 1344 self._temperature = int( 1345 (self.temperature - 32) * 5 / 9) 1346 1347 except ValueError: 1348 pass 1349 1350 continue 1351 1352 if 'Temperature Sensor ' in line: 1353 try: 1354 match = re.search( 1355 r'Temperature\sSensor\s([0-9]+):\s+(-?[0-9]+)', line) 1356 if match: 1357 (tempsensor_number_s, tempsensor_value_s) = match.group(1, 2) 1358 tempsensor_number = int(tempsensor_number_s) 1359 tempsensor_value = int(tempsensor_value_s) 1360 1361 if 'fahrenheit' in line.lower(): 1362 tempsensor_value = int( 1363 (tempsensor_value - 32) * 5 / 9) 1364 1365 self.temperatures[tempsensor_number] = tempsensor_value 1366 if self.temperature is None or tempsensor_number == 0: 1367 self._temperature = tempsensor_value 1368 except ValueError: 1369 pass 1370 1371 continue 1372 1373 ####################################### 1374 # Common values # 1375 ####################################### 1376 1377 # Sector sizes 1378 if 'Sector Sizes' in line: # ATA 1379 m = re.match( 1380 r'.* (\d+) bytes logical,\s*(\d+) bytes physical', line) 1381 if m: 1382 self.logical_sector_size = int(m.group(1)) 1383 self.physical_sector_size = int(m.group(2)) 1384 # set diagnostics block size to physical sector size 1385 self.diagnostics._block_size = self.physical_sector_size 1386 continue 1387 if 'Logical block size:' in line: # SCSI 1/2 1388 self.logical_sector_size = int( 1389 line.split(':')[1].strip().split(' ')[0]) 1390 # set diagnostics block size to logical sector size 1391 self.diagnostics._block_size = self.logical_sector_size 1392 continue 1393 if 'Physical block size:' in line: # SCSI 2/2 1394 self.physical_sector_size = int( 1395 line.split(':')[1].strip().split(' ')[0]) 1396 continue 1397 if 'Namespace 1 Formatted LBA Size' in line: # NVMe 1398 # Note: we will assume that there is only one namespace 1399 self.logical_sector_size = int( 1400 line.split(':')[1].strip().split(' ')[0]) 1401 continue 1402 1403 if not self.abridged: 1404 if not interface == 'scsi': 1405 # Parse the SMART table for below-threshold attributes and create 1406 # corresponding warnings for non-SCSI disks 1407 self._make_smart_warnings() 1408 else: 1409 # If not obtained Power_On_Hours above, make a direct attempt to extract power on 1410 # hours from the background scan results log. 1411 if self.smart_enabled and self.diagnostics.Power_On_Hours is None: 1412 raw, returncode = self.smartctl.generic_call( 1413 [ 1414 '-d', 1415 'scsi', 1416 '-l', 1417 'background', 1418 self.dev_reference 1419 ]) 1420 1421 for line in raw: 1422 if 'power on time' in line: 1423 self.diagnostics.Power_On_Hours = int( 1424 line.split(':')[1].split(' ')[1]) 1425 1426 # Now that we have finished the update routine, if we did not find a runnning selftest 1427 # nuke the self._test_ECD and self._test_progress 1428 if self._test_running is False: 1429 self._test_ECD = None 1430 self._test_progress = None
Represents any device attached to an internal storage interface, such as a hard drive or DVD-ROM, and detected by smartmontools. Includes eSATA (considered SATA) but excludes other external devices (USB, Firewire).
88 def __init__(self, name: str, interface: Optional[str] = None, abridged: bool = False, smart_options: Union[str, List[str], None] = None, smartctl: Smartctl = SMARTCTL): 89 """Instantiates and initializes the `pySMART.device.Device`.""" 90 if not ( 91 interface is None or 92 smartctl_isvalid_type(interface.lower()) 93 ): 94 raise ValueError( 95 'Unknown interface: {0} specified for {1}'.format(interface, name)) 96 self.abridged = abridged or interface == 'UNKNOWN INTERFACE' 97 if smart_options is not None: 98 if isinstance(smart_options, str): 99 smart_options = smart_options.split(' ') 100 smartctl.add_options(smart_options) 101 self.smartctl = smartctl 102 """ 103 """ 104 self.name: str = name.replace('/dev/', '').replace('nvd', 'nvme') 105 """ 106 **(str):** Device's hardware ID, without the '/dev/' prefix. 107 (ie: sda (Linux), pd0 (Windows)) 108 """ 109 self.family: Optional[str] = None 110 """**(str):** Device's family (if any).""" 111 self.model: Optional[str] = None 112 """**(str):** Device's model number (if any).""" 113 self.serial: Optional[str] = None 114 """**(str):** Device's serial number (if any).""" 115 self._vendor: Optional[str] = None 116 """**(str):** Device's vendor (if any).""" 117 self._interface: Optional[str] = None if interface == 'UNKNOWN INTERFACE' else interface 118 """ 119 **(str):** Device's interface type. Must be one of: 120 * **ATA** - Advanced Technology Attachment 121 * **SATA** - Serial ATA 122 * **SCSI** - Small Computer Systems Interface 123 * **SAS** - Serial Attached SCSI 124 * **SAT** - SCSI-to-ATA Translation (SATA device plugged into a 125 SAS port) 126 * **CSMI** - Common Storage Management Interface (Intel ICH / 127 Matrix RAID) 128 Generally this should not be specified to allow auto-detection to 129 occur. Otherwise, this value overrides the auto-detected type and could 130 produce unexpected or no data. 131 """ 132 self._capacity: Optional[int] = None 133 """**(str):** Device's user capacity as reported directly by smartctl (RAW).""" 134 self._capacity_human: Optional[str] = None 135 """**(str):** Device's user capacity (human readable) as reported directly by smartctl (RAW).""" 136 self.firmware: Optional[str] = None 137 """**(str):** Device's firmware version.""" 138 self.smart_capable: bool = 'nvme' in self.name 139 """ 140 **(bool):** True if the device has SMART Support Available. 141 False otherwise. This is useful for VMs amongst other things. 142 """ 143 self.smart_enabled: bool = 'nvme' in self.name 144 """ 145 **(bool):** True if the device supports SMART (or SCSI equivalent) and 146 has the feature set enabled. False otherwise. 147 """ 148 self.assessment: Optional[str] = None 149 """ 150 **(str):** SMART health self-assessment as reported by the device. 151 """ 152 self.messages: List[str] = [] 153 """ 154 **(list of str):** Contains any SMART warnings or other error messages 155 reported by the device (ie: ascq codes). 156 """ 157 self.is_ssd: bool = True if 'nvme' in self.name else False 158 """ 159 **(bool):** True if this device is a Solid State Drive. 160 False otherwise. 161 """ 162 self.rotation_rate: Optional[int] = None 163 """ 164 **(int):** The Roatation Rate of the Drive if it is not a SSD. 165 The Metric is RPM. 166 """ 167 self.test_capabilities = { 168 'offline': False, # SMART execute Offline immediate (ATA only) 169 'short': 'nvme' not in self.name, # SMART short Self-test 170 'long': 'nvme' not in self.name, # SMART long Self-test 171 'conveyance': False, # SMART Conveyance Self-Test (ATA only) 172 'selective': False, # SMART Selective Self-Test (ATA only) 173 } 174 # Note have not included 'offline' test for scsi as it runs in the foregorund 175 # mode. While this may be beneficial to us in someways it is against the 176 # general layout and pattern that the other tests issued using pySMART are 177 # followed hence not doing it currently 178 """ 179 **(dict): ** This dictionary contains key == 'Test Name' and 180 value == 'True/False' of self-tests that this device is capable of. 181 """ 182 # Note: The above are just default values and can/will be changed 183 # upon update() when the attributes and type of the disk is actually 184 # determined. 185 self.tests: List[TestEntry] = [] 186 """ 187 **(list of `TestEntry`):** Contains the complete SMART self-test log 188 for this device, as provided by smartctl. 189 """ 190 self._test_running = False 191 """ 192 **(bool):** True if a self-test is currently being run. 193 False otherwise. 194 """ 195 self._test_ECD = None 196 """ 197 **(str):** Estimated completion time of the running SMART selftest. 198 Not provided by SAS/SCSI devices. 199 """ 200 self._test_progress = None 201 """ 202 **(int):** Estimate progress percantage of the running SMART selftest. 203 """ 204 self.diagnostics: Diagnostics = Diagnostics() 205 """ 206 **Diagnostics** Contains parsed and processed diagnostic information 207 extracted from the SMART information. Currently only populated for 208 SAS and SCSI devices, since ATA/SATA SMART attributes are manufacturer 209 proprietary. 210 """ 211 self._temperature: Optional[int] = None 212 """ 213 **(int or None): Since SCSI disks do not report attributes like ATA ones 214 we need to grep/regex the shit outta the normal "smartctl -a" output. 215 In case the device have more than one temperature sensor the first value 216 will be stored here too. 217 Note: Temperatures are always in Celsius (if possible). 218 """ 219 self.temperatures: Dict[int, int] = {} 220 """ 221 **(dict of int): NVMe disks usually report multiple temperatures, which 222 will be stored here if available. Keys are sensor numbers as reported in 223 output data. 224 Note: Temperatures are always in Celsius (if possible). 225 """ 226 self.logical_sector_size: Optional[int] = None 227 """ 228 **(int):** The logical sector size of the device (or LBA). 229 """ 230 self.physical_sector_size: Optional[int] = None 231 """ 232 **(int):** The physical sector size of the device. 233 """ 234 self.if_attributes: Union[None, NvmeAttributes, AtaAttributes] = None 235 """ 236 **(NvmeAttributes):** This object may vary for each device interface attributes. 237 It will store all data obtained from smartctl 238 """ 239 240 if self.name is None: 241 warnings.warn( 242 "\nDevice '{0}' does not exist! This object should be destroyed.".format( 243 name) 244 ) 245 return 246 # If no interface type was provided, scan for the device 247 # Lets do this only for the non-abridged case 248 # (we can work with no interface for abridged case) 249 elif self._interface is None and not self.abridged: 250 logger.trace( 251 "Determining interface of disk: {0}".format(self.name)) 252 raw, returncode = self.smartctl.generic_call( 253 ['-d', 'test', self.dev_reference]) 254 255 if len(raw) > 0: 256 # I do not like this parsing logic but it works for now! 257 # just for reference _stdout.split('\n') gets us 258 # something like 259 # [ 260 # ...copyright string..., 261 # '', 262 # "/dev/ada2: Device of type 'atacam' [ATA] detected", 263 # "/dev/ada2: Device of type 'atacam' [ATA] opened", 264 # '' 265 # ] 266 # The above example should be enough for anyone to understand the line below 267 try: 268 for line in reversed(raw): 269 if "opened" in line: 270 self._interface = line.split("'")[1] 271 272 if self._interface == "nvme": # if nvme set SMART to true 273 self.smart_capable = True 274 self.smart_enabled = True 275 276 break 277 except: 278 # for whatever reason we could not get the interface type 279 # we should mark this as an `abbridged` case and move on 280 self._interface = None 281 self.abbridged = True 282 # TODO: Uncomment the classify call if we ever find out that we need it 283 # Disambiguate the generic interface to a specific type 284 # self._classify() 285 else: 286 warnings.warn( 287 "\nDevice '{0}' does not exist! This object should be destroyed.".format( 288 name) 289 ) 290 return 291 # If a valid device was detected, populate its information 292 # OR if in unabridged mode, then do it even without interface info 293 if self._interface is not None or self.abridged: 294 self.update()
Instantiates and initializes the Device
.
(bool): True if the device has SMART Support Available. False otherwise. This is useful for VMs amongst other things.
(bool): True if the device supports SMART (or SCSI equivalent) and has the feature set enabled. False otherwise.
(list of str): Contains any SMART warnings or other error messages reported by the device (ie: ascq codes).
(int): The Roatation Rate of the Drive if it is not a SSD. The Metric is RPM.
*(dict): * This dictionary contains key == 'Test Name' and value == 'True/False' of self-tests that this device is capable of.
(list of TestEntry
): Contains the complete SMART self-test log
for this device, as provided by smartctl.
Diagnostics Contains parsed and processed diagnostic information extracted from the SMART information. Currently only populated for SAS and SCSI devices, since ATA/SATA SMART attributes are manufacturer proprietary.
**(dict of int): NVMe disks usually report multiple temperatures, which will be stored here if available. Keys are sensor numbers as reported in output data. Note: Temperatures are always in Celsius (if possible).
(NvmeAttributes): This object may vary for each device interface attributes. It will store all data obtained from smartctl
Returns the SMART attributes of the device.
Note: This is only filled with ATA/SATA attributes. SCSI/SAS/NVMe devices will have empty lists!!
@deprecated: Use if_attributes
instead.
Returns:
list of Attribute
: The SMART attributes of the device.
Returns the internal interface type of the device. It may not be the same as the interface type as used by smartctl.
Returns: str: The interface type of the device. (example: ata, scsi, nvme) None if the interface type could not be determined.
Returns the temperature of the device.
Returns: int: The temperature of the device in Celsius. None if the temperature could not be determined.
Returns the interface type of the device as it is used in smartctl.
Returns: str: The interface type of the device. (example: ata, scsi, nvme) None if the interface type could not be determined.
Returns the interface type of the device as it is used in smartctl.
Returns: str: The interface type of the device. (example: ata, scsi, nvme) None if the interface type could not be determined.
The reference to the device as provided by smartctl.
- On unix-like systems, this is the path to the device. (example /dev/
) - On MacOS, this is the name of the device. (example
) - On Windows, this is the drive letter of the device. (example
)
Returns: str: The reference to the device as provided by smartctl.
Returns the capacity in the raw smartctl format. This may be deprecated in the future and its only retained for compatibility.
Returns: str: The capacity in the raw smartctl format
Returns the capacity in the raw smartctl format.
Returns: str: The capacity in the raw smartctl format
Returns the sector size of the device.
Returns: int: The sector size of the device in Bytes. If undefined, we'll assume 512B
509 def smart_toggle(self, action: str) -> Tuple[bool, List[str]]: 510 """ 511 A basic function to enable/disable SMART on device. 512 513 # Args: 514 * **action (str):** Can be either 'on'(for enabling) or 'off'(for disabling). 515 516 # Returns" 517 * **(bool):** Return True (if action succeded) else False 518 * **(List[str]):** None if option succeded else contains the error message. 519 """ 520 # Lets make the action verb all lower case 521 if self._interface == 'nvme': 522 return False, ['NVME devices do not currently support toggling SMART enabled'] 523 action_lower = action.lower() 524 if action_lower not in ['on', 'off']: 525 return False, ['Unsupported action {0}'.format(action)] 526 # Now lets check if the device's smart enabled status is already that of what 527 # the supplied action is intending it to be. If so then just return successfully 528 if self.smart_enabled: 529 if action_lower == 'on': 530 return True, [] 531 else: 532 if action_lower == 'off': 533 return True, [] 534 if self._interface is not None: 535 raw, returncode = self.smartctl.generic_call( 536 ['-s', action_lower, '-d', self._interface, self.dev_reference]) 537 else: 538 raw, returncode = self.smartctl.generic_call( 539 ['-s', action_lower, self.dev_reference]) 540 541 if returncode != 0: 542 return False, raw 543 # if everything worked out so far lets perform an update() and check the result 544 self.update() 545 if action_lower == 'off' and self.smart_enabled: 546 return False, ['Failed to turn SMART off.'] 547 if action_lower == 'on' and not self.smart_enabled: 548 return False, ['Failed to turn SMART on.'] 549 return True, []
A basic function to enable/disable SMART on device.
Args:
- action (str): Can be either 'on'(for enabling) or 'off'(for disabling).
Returns"
- (bool): Return True (if action succeded) else False
- (List[str]): None if option succeded else contains the error message.
551 def all_attributes(self, print_fn=print): 552 """ 553 Prints the entire SMART attribute table, in a format similar to 554 the output of smartctl. 555 allows usage of custom print function via parameter print_fn by default uses print 556 """ 557 header_printed = False 558 for attr in self.attributes: 559 if attr is not None: 560 if not header_printed: 561 print_fn("{0:>3} {1:24}{2:4}{3:4}{4:4}{5:9}{6:8}{7:12}{8}" 562 .format('ID#', 'ATTRIBUTE_NAME', 'CUR', 'WST', 'THR', 'TYPE', 'UPDATED', 'WHEN_FAIL', 563 'RAW')) 564 header_printed = True 565 print_fn(attr) 566 if not header_printed: 567 print_fn('This device does not support SMART attributes.')
Prints the entire SMART attribute table, in a format similar to the output of smartctl. allows usage of custom print function via parameter print_fn by default uses print
569 def all_selftests(self): 570 """ 571 Prints the entire SMART self-test log, in a format similar to 572 the output of smartctl. 573 """ 574 if self.tests: 575 all_tests = [] 576 if smartctl_type(self._interface) == 'scsi': 577 header = "{0:3}{1:17}{2:23}{3:7}{4:14}{5:15}".format( 578 'ID', 579 'Test Description', 580 'Status', 581 'Hours', 582 '1st_Error@LBA', 583 '[SK ASC ASCQ]' 584 ) 585 else: 586 header = ("{0:3}{1:17}{2:30}{3:5}{4:7}{5:17}".format( 587 'ID', 588 'Test_Description', 589 'Status', 590 'Left', 591 'Hours', 592 '1st_Error@LBA')) 593 all_tests.append(header) 594 for test in self.tests: 595 all_tests.append(str(test)) 596 597 return all_tests 598 else: 599 no_tests = 'No self-tests have been logged for this device.' 600 return no_tests
Prints the entire SMART self-test log, in a format similar to the output of smartctl.
686 def get_selftest_result(self, output=None): 687 """ 688 Refreshes a device's `pySMART.device.Device.tests` attribute to obtain 689 the latest test results. If a new test result is obtained, its content 690 is returned. 691 692 # Args: 693 * **output (str, optional):** If set to 'str', the string 694 representation of the most recent test result will be returned, instead 695 of a `Test_Entry` object. 696 697 # Returns: 698 * **(int):** Return status code. One of the following: 699 * 0 - Success. Object (or optionally, string rep) is attached. 700 * 1 - Self-test in progress. Must wait for it to finish. 701 * 2 - No new test results. 702 * 3 - The Self-test was Aborted by host 703 * **(`Test_Entry` or str):** Most recent `Test_Entry` object (or 704 optionally it's string representation) if new data exists. Status 705 message string on failure. 706 * **(int):** Estimate progress percantage of the running SMART selftest, if known. 707 Otherwise 'None'. 708 """ 709 # SCSI self-test logs hold 20 entries while ATA logs hold 21 710 if smartctl_type(self._interface) == 'scsi': 711 maxlog = 20 712 else: 713 maxlog = 21 714 # If we looked only at the most recent test result we could be fooled 715 # by two short tests run close together (within the same hour) 716 # appearing identical. Comparing the length of the log adds some 717 # confidence until it maxes, as above. Comparing the least-recent test 718 # result greatly diminishes the chances that two sets of two tests each 719 # were run within an hour of themselves, but with 16-17 other tests run 720 # in between them. 721 if self.tests: 722 _first_entry = self.tests[0] 723 _len = len(self.tests) 724 _last_entry = self.tests[_len - 1] 725 else: 726 _len = 0 727 self.update() 728 # Since I have changed the update() parsing to DTRT to pickup currently 729 # running selftests we can now purely rely on that for self._test_running 730 # Thus check for that variable first and return if it is True with appropos message. 731 if self._test_running is True: 732 return 1, 'Self-test in progress. Please wait.', self._test_progress 733 # Check whether the list got longer (ie: new entry) 734 # If so return the newest test result 735 # If not, because it's max size already, check for new entries 736 if ( 737 (len(self.tests) != _len) or 738 ( 739 len == maxlog and 740 ( 741 _first_entry.type != self.tests[0].type or 742 _first_entry.hours != self.tests[0].hours or 743 _last_entry.type != self.tests[len(self.tests) - 1].type or 744 _last_entry.hours != self.tests[len( 745 self.tests) - 1].hours 746 ) 747 ) 748 ): 749 return ( 750 0 if 'Aborted' not in self.tests[0].status else 3, 751 str(self.tests[0]) if output == 'str' else self.tests[0], 752 None 753 ) 754 else: 755 return 2, 'No new self-test results found.', None
Refreshes a device's Device.tests
attribute to obtain
the latest test results. If a new test result is obtained, its content
is returned.
Args:
- output (str, optional): If set to 'str', the string
representation of the most recent test result will be returned, instead
of a
Test_Entry
object.
Returns:
- (int): Return status code. One of the following:
- 0 - Success. Object (or optionally, string rep) is attached.
- 1 - Self-test in progress. Must wait for it to finish.
- 2 - No new test results.
- 3 - The Self-test was Aborted by host
- (
Test_Entry
or str): Most recentTest_Entry
object (or optionally it's string representation) if new data exists. Status message string on failure. - (int): Estimate progress percantage of the running SMART selftest, if known. Otherwise 'None'.
757 def abort_selftest(self): 758 """ 759 Aborts non-captive SMART Self Tests. Note that this command 760 will abort the Offline Immediate Test routine only if your disk 761 has the "Abort Offline collection upon new command" capability. 762 763 # Args: Nothing (just aborts directly) 764 765 # Returns: 766 * **(int):** The returncode of calling `smartctl -X device_path` 767 """ 768 return self.smartctl.test_stop(smartctl_type(self._interface), self.dev_reference)
Aborts non-captive SMART Self Tests. Note that this command will abort the Offline Immediate Test routine only if your disk has the "Abort Offline collection upon new command" capability.
Args: Nothing (just aborts directly)
Returns:
- (int): The returncode of calling
smartctl -X device_path
770 def run_selftest(self, test_type, ETA_type='date'): 771 """ 772 Instructs a device to begin a SMART self-test. All tests are run in 773 'offline' / 'background' mode, allowing normal use of the device while 774 it is being tested. 775 776 # Args: 777 * **test_type (str):** The type of test to run. Accepts the following 778 (not case sensitive): 779 * **short** - Brief electo-mechanical functionality check. 780 Generally takes 2 minutes or less. 781 * **long** - Thorough electro-mechanical functionality check, 782 including complete recording media scan. Generally takes several 783 hours. 784 * **conveyance** - Brief test used to identify damage incurred in 785 shipping. Generally takes 5 minutes or less. **This test is not 786 supported by SAS or SCSI devices.** 787 * **offline** - Runs SMART Immediate Offline Test. The effects of 788 this test are visible only in that it updates the SMART Attribute 789 values, and if errors are found they will appear in the SMART error 790 log, visible with the '-l error' option to smartctl. **This test is 791 not supported by SAS or SCSI devices in pySMART use cli smartctl for 792 running 'offline' selftest (runs in foreground) on scsi devices.** 793 * **ETA_type** - Format to return the estimated completion time/date 794 in. Default is 'date'. One could otherwise specidy 'seconds'. 795 Again only for ATA devices. 796 797 # Returns: 798 * **(int):** Return status code. One of the following: 799 * 0 - Self-test initiated successfully 800 * 1 - Previous self-test running. Must wait for it to finish. 801 * 2 - Unknown or unsupported (by the device) test type requested. 802 * 3 - Unspecified smartctl error. Self-test not initiated. 803 * **(str):** Return status message. 804 * **(str)/(float):** Estimated self-test completion time if a test is started. 805 The optional argument of 'ETA_type' (see above) controls the return type. 806 if 'ETA_type' == 'date' then a date string is returned else seconds(float) 807 is returned. 808 Note: The self-test completion time can only be obtained for ata devices. 809 Otherwise 'None'. 810 """ 811 # Lets call get_selftest_result() here since it does an update() and 812 # checks for an existing selftest is running or not, this way the user 813 # can issue a test from the cli and this can still pick that up 814 # Also note that we do not need to obtain the results from this as the 815 # data is already stored in the Device class object's variables 816 self.get_selftest_result() 817 if self._test_running: 818 return 1, 'Self-test in progress. Please wait.', self._test_ECD 819 test_type = test_type.lower() 820 interface = smartctl_type(self._interface) 821 try: 822 if not self.test_capabilities[test_type]: 823 return ( 824 2, 825 "Device {0} does not support the '{1}' test ".format( 826 self.name, test_type), 827 None 828 ) 829 except KeyError: 830 return 2, "Unknown test type '{0}' requested.".format(test_type), None 831 832 raw, rc = self.smartctl.test_start( 833 interface, test_type, self.dev_reference) 834 _success = False 835 _running = False 836 for line in raw: 837 if 'has begun' in line: 838 _success = True 839 self._test_running = True 840 if 'aborting current test' in line: 841 _running = True 842 try: 843 self._test_progress = 100 - \ 844 int(line.split('(')[-1].split('%')[0]) 845 except ValueError: 846 pass 847 848 if _success and 'complete after' in line: 849 self._test_ECD = line[25:].rstrip() 850 if ETA_type == 'seconds': 851 self._test_ECD = mktime( 852 strptime(self._test_ECD, '%a %b %d %H:%M:%S %Y')) - time() 853 self._test_progress = 0 854 if _success: 855 return 0, 'Self-test started successfully', self._test_ECD 856 else: 857 if _running: 858 return 1, 'Self-test already in progress. Please wait.', self._test_ECD 859 else: 860 return 3, 'Unspecified Error. Self-test not started.', None
Instructs a device to begin a SMART self-test. All tests are run in 'offline' / 'background' mode, allowing normal use of the device while it is being tested.
Args:
- test_type (str): The type of test to run. Accepts the following
(not case sensitive):
- short - Brief electo-mechanical functionality check. Generally takes 2 minutes or less.
- long - Thorough electro-mechanical functionality check, including complete recording media scan. Generally takes several hours.
- conveyance - Brief test used to identify damage incurred in shipping. Generally takes 5 minutes or less. This test is not supported by SAS or SCSI devices.
- offline - Runs SMART Immediate Offline Test. The effects of this test are visible only in that it updates the SMART Attribute values, and if errors are found they will appear in the SMART error log, visible with the '-l error' option to smartctl. This test is not supported by SAS or SCSI devices in pySMART use cli smartctl for running 'offline' selftest (runs in foreground) on scsi devices.
- ETA_type - Format to return the estimated completion time/date in. Default is 'date'. One could otherwise specidy 'seconds'. Again only for ATA devices.
Returns:
- (int): Return status code. One of the following:
- 0 - Self-test initiated successfully
- 1 - Previous self-test running. Must wait for it to finish.
- 2 - Unknown or unsupported (by the device) test type requested.
- 3 - Unspecified smartctl error. Self-test not initiated.
- (str): Return status message.
- (str)/(float): Estimated self-test completion time if a test is started. The optional argument of 'ETA_type' (see above) controls the return type. if 'ETA_type' == 'date' then a date string is returned else seconds(float) is returned. Note: The self-test completion time can only be obtained for ata devices. Otherwise 'None'.
862 def run_selftest_and_wait(self, test_type, output=None, polling=5, progress_handler=None): 863 """ 864 This is essentially a wrapper around run_selftest() such that we 865 call self.run_selftest() and wait on the running selftest till 866 it finished before returning. 867 The above holds true for all pySMART supported tests with the 868 exception of the 'offline' test (ATA only) as it immediately 869 returns, since the entire test only affects the smart error log 870 (if any errors found) and updates the SMART attributes. Other 871 than that it is not visibile anywhere else, so we start it and 872 simply return. 873 # Args: 874 * **test_type (str):** The type of test to run. Accepts the following 875 (not case sensitive): 876 * **short** - Brief electo-mechanical functionality check. 877 Generally takes 2 minutes or less. 878 * **long** - Thorough electro-mechanical functionality check, 879 including complete recording media scan. Generally takes several 880 hours. 881 * **conveyance** - Brief test used to identify damage incurred in 882 shipping. Generally takes 5 minutes or less. **This test is not 883 supported by SAS or SCSI devices.** 884 * **offline** - Runs SMART Immediate Offline Test. The effects of 885 this test are visible only in that it updates the SMART Attribute 886 values, and if errors are found they will appear in the SMART error 887 log, visible with the '-l error' option to smartctl. **This test is 888 not supported by SAS or SCSI devices in pySMART use cli smartctl for 889 running 'offline' selftest (runs in foreground) on scsi devices.** 890 * **output (str, optional):** If set to 'str', the string 891 representation of the most recent test result will be returned, 892 instead of a `Test_Entry` object. 893 * **polling (int, default=5):** The time duration to sleep for between 894 checking for test_results and progress. 895 * **progress_handler (function, optional):** This if provided is called 896 with self._test_progress as the supplied argument everytime a poll to 897 check the status of the selftest is done. 898 # Returns: 899 * **(int):** Return status code. One of the following: 900 * 0 - Self-test executed and finished successfully 901 * 1 - Previous self-test running. Must wait for it to finish. 902 * 2 - Unknown or illegal test type requested. 903 * 3 - The Self-test was Aborted by host 904 * 4 - Unspecified smartctl error. Self-test not initiated. 905 * **(`Test_Entry` or str):** Most recent `Test_Entry` object (or 906 optionally it's string representation) if new data exists. Status 907 message string on failure. 908 """ 909 test_initiation_result = self.run_selftest(test_type) 910 if test_initiation_result[0] != 0: 911 return test_initiation_result[:2] 912 if test_type == 'offline': 913 self._test_running = False 914 # if not then the test initiated correctly and we can start the polling. 915 # For now default 'polling' value is 5 seconds if not specified by the user 916 917 # Do an initial check, for good measure. 918 # In the probably impossible case that self._test_running is instantly False... 919 selftest_results = self.get_selftest_result(output=output) 920 while self._test_running: 921 if selftest_results[0] != 1: 922 # the selftest is run and finished lets return with the results 923 break 924 # Otherwise see if we are provided with the progress_handler to update progress 925 if progress_handler is not None: 926 progress_handler( 927 selftest_results[2] if selftest_results[2] is not None else 50) 928 # Now sleep 'polling' seconds before checking the progress again 929 sleep(polling) 930 931 # Check after the sleep to ensure we return the right result, and not an old one. 932 selftest_results = self.get_selftest_result(output=output) 933 934 # Now if (selftes_results[0] == 2) i.e No new selftest (because the same 935 # selftest was run twice within the last hour) but we know for a fact that 936 # we just ran a new selftest then just return the latest entry in self.tests 937 if selftest_results[0] == 2: 938 selftest_return_value = 0 if 'Aborted' not in self.tests[0].status else 3 939 return selftest_return_value, str(self.tests[0]) if output == 'str' else self.tests[0] 940 return selftest_results[:2]
This is essentially a wrapper around run_selftest() such that we call self.run_selftest() and wait on the running selftest till it finished before returning. The above holds true for all pySMART supported tests with the exception of the 'offline' test (ATA only) as it immediately returns, since the entire test only affects the smart error log (if any errors found) and updates the SMART attributes. Other than that it is not visibile anywhere else, so we start it and simply return.
Args:
- test_type (str): The type of test to run. Accepts the following
(not case sensitive):
- short - Brief electo-mechanical functionality check. Generally takes 2 minutes or less.
- long - Thorough electro-mechanical functionality check, including complete recording media scan. Generally takes several hours.
- conveyance - Brief test used to identify damage incurred in shipping. Generally takes 5 minutes or less. This test is not supported by SAS or SCSI devices.
- offline - Runs SMART Immediate Offline Test. The effects of this test are visible only in that it updates the SMART Attribute values, and if errors are found they will appear in the SMART error log, visible with the '-l error' option to smartctl. This test is not supported by SAS or SCSI devices in pySMART use cli smartctl for running 'offline' selftest (runs in foreground) on scsi devices.
- output (str, optional): If set to 'str', the string
representation of the most recent test result will be returned,
instead of a
Test_Entry
object. - polling (int, default=5): The time duration to sleep for between checking for test_results and progress.
progress_handler (function, optional): This if provided is called with self._test_progress as the supplied argument everytime a poll to check the status of the selftest is done.
Returns:
(int): Return status code. One of the following:
- 0 - Self-test executed and finished successfully
- 1 - Previous self-test running. Must wait for it to finish.
- 2 - Unknown or illegal test type requested.
- 3 - The Self-test was Aborted by host
- 4 - Unspecified smartctl error. Self-test not initiated.
- (
Test_Entry
or str): Most recentTest_Entry
object (or optionally it's string representation) if new data exists. Status message string on failure.
942 def update(self): 943 """ 944 Queries for device information using smartctl and updates all 945 class members, including the SMART attribute table and self-test log. 946 Can be called at any time to refresh the `pySMART.device.Device` 947 object's data content. 948 """ 949 # set temperature back to None so that if update() is called more than once 950 # any logic that relies on self.temperature to be None to rescan it works.it 951 self._temperature = None 952 # same for temperatures 953 self.temperatures = {} 954 if self.abridged: 955 interface = None 956 raw = self.smartctl.info(self.dev_reference) 957 958 else: 959 interface = smartctl_type(self._interface) 960 raw = self.smartctl.all( 961 self.dev_reference, interface) 962 963 parse_self_tests = False 964 parse_running_test = False 965 parse_ascq = False 966 message = '' 967 self.tests = [] 968 self._test_running = False 969 self._test_progress = None 970 # Lets skip the first couple of non-useful lines 971 _stdout = raw[4:] 972 973 ####################################### 974 # Encoding fixing # 975 ####################################### 976 # In some scenarios, smartctl returns some lines with a different/strange encoding 977 # This is a workaround to fix that 978 for i, line in enumerate(_stdout): 979 # character ' ' (U+202F) should be removed 980 _stdout[i] = line.replace('\u202f', '') 981 982 ####################################### 983 # Dedicated interface attributes # 984 ####################################### 985 if AtaAttributes.has_compatible_data(iter(_stdout)): 986 self.if_attributes = AtaAttributes(iter(_stdout)) 987 988 elif self.dev_interface == 'nvme': 989 self.if_attributes = NvmeAttributes(iter(_stdout)) 990 991 # Get Tests 992 for test in self.if_attributes.tests: 993 self.tests.append(TestEntry('nvme', test.num, test.description, test.status, test.powerOnHours, 994 test.failingLBA, nsid=test.nsid, segment=test.seg, sct=test.sct, code=test.code, remain=100-test.progress)) 995 996 # Set running test 997 if any(test.status == 'Running' for test in self.if_attributes.tests): 998 self._test_running = True 999 self._test_progress = self.if_attributes.tests[0].progress 1000 else: 1001 self._test_running = False 1002 self._test_progress = None 1003 1004 else: 1005 self.if_attributes = None 1006 1007 ####################################### 1008 # Global / generic attributes # 1009 ####################################### 1010 stdout_iter = iter(_stdout) 1011 for line in stdout_iter: 1012 if line.strip() == '': # Blank line stops sub-captures 1013 if parse_self_tests is True: 1014 parse_self_tests = False 1015 if parse_ascq: 1016 parse_ascq = False 1017 self.messages.append(message) 1018 if parse_ascq: 1019 message += ' ' + line.lstrip().rstrip() 1020 if parse_self_tests: 1021 # Detect Test Format 1022 1023 ## SCSI/SAS FORMAT ## 1024 # Example smartctl output 1025 # SMART Self-test log 1026 # Num Test Status segment LifeTime LBA_first_err [SK ASC ASQ] 1027 # Description number (hours) 1028 # # 1 Background short Completed - 33124 - [- - -] 1029 format_scsi = re.compile( 1030 r'^[#\s]*(\d+)\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s+\[([^\s]+)\s+([^\s]+)\s+([^\s]+)\]$').match(line) 1031 1032 ## ATA FORMAT ## 1033 # Example smartctl output: 1034 # SMART Self-test log structure revision number 1 1035 # Num Test_Description Status Remaining LifeTime(hours) LBA_of_first_error 1036 # # 1 Extended offline Completed without error 00% 46660 - 1037 format_ata = re.compile( 1038 r'^[#\s]*(\d+)\s{2,}(.*[^\s])\s{2,}(.*[^\s])\s{1,}(.*[^\s])\s{2,}(.*[^\s])\s{2,}(.*[^\s])$').match(line) 1039 1040 if format_scsi is not None: 1041 format = 'scsi' 1042 parsed = format_scsi.groups() 1043 num = int(parsed[0]) 1044 test_type = parsed[1] 1045 status = parsed[2] 1046 segment = parsed[3] 1047 hours = parsed[4] 1048 lba = parsed[5] 1049 sense = parsed[6] 1050 asc = parsed[7] 1051 ascq = parsed[8] 1052 self.tests.append(TestEntry( 1053 format, 1054 num, 1055 test_type, 1056 status, 1057 hours, 1058 lba, 1059 segment=segment, 1060 sense=sense, 1061 asc=asc, 1062 ascq=ascq 1063 )) 1064 elif format_ata is not None: 1065 ## ATA FORMAT ## 1066 format = 'ata' 1067 parsed = format_ata.groups() 1068 num = parsed[0] 1069 test_type = parsed[1] 1070 status = parsed[2] 1071 remain = parsed[3] 1072 hours = parsed[4] 1073 lba = parsed[5] 1074 1075 try: 1076 num = int(num) 1077 except: 1078 num = None 1079 1080 self.tests.append( 1081 TestEntry(format, num, test_type, status, 1082 hours, lba, remain=remain) 1083 ) 1084 else: 1085 pass 1086 1087 # Basic device information parsing 1088 if any_in(line, 'Device Model', 'Product', 'Model Number'): 1089 self.model = line.split(':')[1].lstrip().rstrip() 1090 self._guess_smart_type(line.lower()) 1091 continue 1092 1093 if 'Model Family' in line: 1094 self.family = line.split(':')[1].strip() 1095 self._guess_smart_type(line.lower()) 1096 continue 1097 1098 if 'LU WWN' in line: 1099 self._guess_smart_type(line.lower()) 1100 continue 1101 1102 if any_in(line, 'Serial Number', 'Serial number'): 1103 try: 1104 self.serial = line.split(':')[1].split()[0].rstrip() 1105 except IndexError: 1106 # Serial reported empty 1107 self.serial = "" 1108 continue 1109 1110 vendor = re.compile(r'^Vendor:\s+(\w+)').match(line) 1111 if vendor is not None: 1112 self._vendor = vendor.groups()[0] 1113 1114 if any_in(line, 'Firmware Version', 'Revision'): 1115 self.firmware = line.split(':')[1].strip() 1116 1117 if any_in(line, 'User Capacity', 'Total NVM Capacity', 'Namespace 1 Size/Capacity'): 1118 # TODO: support for multiple NVMe namespaces 1119 m = re.match( 1120 r'.*:\s+([\d,. \u2019\u00a0]+)\s\D*\[?([^\]]+)?\]?', line.strip()) 1121 1122 if m is not None: 1123 tmp = m.groups() 1124 if tmp[0] == ' ': 1125 # This capacity is set to 0, skip it 1126 continue 1127 1128 self._capacity = int( 1129 tmp[0].strip().replace(',', '').replace('.', '').replace(' ', '').replace('\u2019', '').replace('\u00a0', '')) 1130 1131 if len(tmp) == 2 and tmp[1] is not None: 1132 self._capacity_human = tmp[1].strip().replace(',', '.') 1133 1134 if 'SMART support' in line: 1135 # self.smart_capable = 'Available' in line 1136 # self.smart_enabled = 'Enabled' in line 1137 # Since this line repeats twice the above method is flawed 1138 # Lets try the following instead, it is a bit redundant but 1139 # more robust. 1140 if any_in(line, 'Unavailable', 'device lacks SMART capability'): 1141 self.smart_capable = False 1142 self.smart_enabled = False 1143 elif 'Enabled' in line: 1144 self.smart_enabled = True 1145 elif 'Disabled' in line: 1146 self.smart_enabled = False 1147 elif any_in(line, 'Available', 'device has SMART capability'): 1148 self.smart_capable = True 1149 continue 1150 1151 if 'does not support SMART' in line: 1152 self.smart_capable = False 1153 self.smart_enabled = False 1154 continue 1155 1156 if 'Rotation Rate' in line: 1157 if 'Solid State Device' in line: 1158 self.is_ssd = True 1159 elif 'rpm' in line: 1160 self.is_ssd = False 1161 try: 1162 self.rotation_rate = int( 1163 line.split(':')[1].lstrip().rstrip()[:-4]) 1164 except ValueError: 1165 # Cannot parse the RPM? Assigning None instead 1166 self.rotation_rate = None 1167 continue 1168 1169 if 'SMART overall-health self-assessment' in line: # ATA devices 1170 if line.split(':')[1].strip() == 'PASSED': 1171 self.assessment = 'PASS' 1172 else: 1173 self.assessment = 'FAIL' 1174 continue 1175 1176 if 'SMART Health Status' in line: # SCSI devices 1177 if line.split(':')[1].strip() == 'OK': 1178 self.assessment = 'PASS' 1179 else: 1180 self.assessment = 'FAIL' 1181 parse_ascq = True # Set flag to capture status message 1182 message = line.split(':')[1].lstrip().rstrip() 1183 continue 1184 1185 # Parse SMART test capabilities (ATA only) 1186 # Note: SCSI does not list this but and allows for only 'offline', 'short' and 'long' 1187 if 'SMART execute Offline immediate' in line: 1188 self.test_capabilities['offline'] = 'No' not in line 1189 continue 1190 1191 if 'Conveyance Self-test supported' in line: 1192 self.test_capabilities['conveyance'] = 'No' not in line 1193 continue 1194 1195 if 'Selective Self-test supported' in line: 1196 self.test_capabilities['selective'] = 'No' not in line 1197 continue 1198 1199 if 'Self-test supported' in line: 1200 self.test_capabilities['short'] = 'No' not in line 1201 self.test_capabilities['long'] = 'No' not in line 1202 continue 1203 1204 # Parse SMART test capabilities (NVMe only) 1205 if 'Optional Admin Commands' in line: 1206 if 'Self_Test' in line: 1207 self.test_capabilities['short'] = True 1208 self.test_capabilities['long'] = True 1209 1210 # For some reason smartctl does not show a currently running test 1211 # for 'ATA' in the Test log so I just have to catch it this way i guess! 1212 # For 'scsi' I still do it since it is the only place I get % remaining in scsi 1213 if 'Self-test execution status' in line: 1214 if 'progress' in line: 1215 self._test_running = True 1216 # for ATA the "%" remaining is on the next line 1217 # thus set the parse_running_test flag and move on 1218 parse_running_test = True 1219 elif '%' in line: 1220 # for scsi the progress is on the same line 1221 # so we can just parse it and move on 1222 self._test_running = True 1223 try: 1224 self._test_progress = 100 - \ 1225 int(line.split('%')[0][-3:].strip()) 1226 except ValueError: 1227 pass 1228 continue 1229 if parse_running_test is True: 1230 try: 1231 self._test_progress = 100 - \ 1232 int(line.split('%')[0][-3:].strip()) 1233 except ValueError: 1234 pass 1235 parse_running_test = False 1236 1237 if "Self-test log" in line: 1238 parse_self_tests = True # Set flag to capture test entries 1239 continue 1240 1241 ####################################### 1242 # SCSI only # 1243 ####################################### 1244 # 1245 # Everything from here on is parsing SCSI information that takes 1246 # the place of similar ATA SMART information 1247 if 'used endurance' in line: 1248 pct = int(line.split(':')[1].strip()[:-1]) 1249 self.diagnostics.Life_Left = 100 - pct 1250 continue 1251 1252 if 'Specified cycle count' in line: 1253 self.diagnostics.Start_Stop_Spec = int( 1254 line.split(':')[1].strip()) 1255 continue 1256 1257 if 'Accumulated start-stop cycles' in line: 1258 self.diagnostics.Start_Stop_Cycles = int( 1259 line.split(':')[1].strip()) 1260 if self.diagnostics.Start_Stop_Spec and self.diagnostics.Start_Stop_Spec != 0: 1261 self.diagnostics.Start_Stop_Pct_Left = int(round( 1262 100 - (self.diagnostics.Start_Stop_Cycles / 1263 self.diagnostics.Start_Stop_Spec), 0)) 1264 continue 1265 1266 if 'Specified load-unload count' in line: 1267 self.diagnostics.Load_Cycle_Spec = int( 1268 line.split(':')[1].strip()) 1269 continue 1270 1271 if 'Accumulated load-unload cycles' in line: 1272 self.diagnostics.Load_Cycle_Count = int( 1273 line.split(':')[1].strip()) 1274 if self.diagnostics.Load_Cycle_Spec and self.diagnostics.Load_Cycle_Spec != 0: 1275 self.diagnostics.Load_Cycle_Pct_Left = int(round( 1276 100 - (self.diagnostics.Load_Cycle_Count / 1277 self.diagnostics.Load_Cycle_Spec), 0)) 1278 continue 1279 1280 if 'Elements in grown defect list' in line: 1281 self.diagnostics.Reallocated_Sector_Ct = int( 1282 line.split(':')[1].strip()) 1283 continue 1284 1285 if 'read:' in line: 1286 line_ = ' '.join(line.split()).split(' ') 1287 if line_[1] == '0' and line_[2] == '0' and line_[3] == '0' and line_[4] == '0': 1288 self.diagnostics.Corrected_Reads = 0 1289 elif line_[4] == '0': 1290 self.diagnostics.Corrected_Reads = int( 1291 line_[1]) + int(line_[2]) + int(line_[3]) 1292 else: 1293 self.diagnostics.Corrected_Reads = int(line_[4]) 1294 self.diagnostics._Reads_GB = float(line_[6].replace(',', '.')) 1295 self.diagnostics._Uncorrected_Reads = int(line_[7]) 1296 continue 1297 1298 if 'write:' in line: 1299 line_ = ' '.join(line.split()).split(' ') 1300 if (line_[1] == '0' and line_[2] == '0' and 1301 line_[3] == '0' and line_[4] == '0'): 1302 self.diagnostics.Corrected_Writes = 0 1303 elif line_[4] == '0': 1304 self.diagnostics.Corrected_Writes = int( 1305 line_[1]) + int(line_[2]) + int(line_[3]) 1306 else: 1307 self.diagnostics.Corrected_Writes = int(line_[4]) 1308 self.diagnostics._Writes_GB = float(line_[6].replace(',', '.')) 1309 self.diagnostics._Uncorrected_Writes = int(line_[7]) 1310 continue 1311 1312 if 'verify:' in line: 1313 line_ = ' '.join(line.split()).split(' ') 1314 if (line_[1] == '0' and line_[2] == '0' and 1315 line_[3] == '0' and line_[4] == '0'): 1316 self.diagnostics.Corrected_Verifies = 0 1317 elif line_[4] == '0': 1318 self.diagnostics.Corrected_Verifies = int( 1319 line_[1]) + int(line_[2]) + int(line_[3]) 1320 else: 1321 self.diagnostics.Corrected_Verifies = int(line_[4]) 1322 self.diagnostics._Verifies_GB = float( 1323 line_[6].replace(',', '.')) 1324 self.diagnostics._Uncorrected_Verifies = int(line_[7]) 1325 continue 1326 1327 if 'non-medium error count' in line: 1328 self.diagnostics.Non_Medium_Errors = int( 1329 line.split(':')[1].strip()) 1330 continue 1331 1332 if 'Accumulated power on time' in line: 1333 self.diagnostics.Power_On_Hours = int( 1334 line.split(':')[1].split(' ')[1]) 1335 continue 1336 1337 if 'Current Drive Temperature' in line or ('Temperature:' in 1338 line and interface == 'nvme'): 1339 try: 1340 self._temperature = int( 1341 line.split(':')[-1].strip().split()[0]) 1342 1343 if 'fahrenheit' in line.lower(): 1344 self._temperature = int( 1345 (self.temperature - 32) * 5 / 9) 1346 1347 except ValueError: 1348 pass 1349 1350 continue 1351 1352 if 'Temperature Sensor ' in line: 1353 try: 1354 match = re.search( 1355 r'Temperature\sSensor\s([0-9]+):\s+(-?[0-9]+)', line) 1356 if match: 1357 (tempsensor_number_s, tempsensor_value_s) = match.group(1, 2) 1358 tempsensor_number = int(tempsensor_number_s) 1359 tempsensor_value = int(tempsensor_value_s) 1360 1361 if 'fahrenheit' in line.lower(): 1362 tempsensor_value = int( 1363 (tempsensor_value - 32) * 5 / 9) 1364 1365 self.temperatures[tempsensor_number] = tempsensor_value 1366 if self.temperature is None or tempsensor_number == 0: 1367 self._temperature = tempsensor_value 1368 except ValueError: 1369 pass 1370 1371 continue 1372 1373 ####################################### 1374 # Common values # 1375 ####################################### 1376 1377 # Sector sizes 1378 if 'Sector Sizes' in line: # ATA 1379 m = re.match( 1380 r'.* (\d+) bytes logical,\s*(\d+) bytes physical', line) 1381 if m: 1382 self.logical_sector_size = int(m.group(1)) 1383 self.physical_sector_size = int(m.group(2)) 1384 # set diagnostics block size to physical sector size 1385 self.diagnostics._block_size = self.physical_sector_size 1386 continue 1387 if 'Logical block size:' in line: # SCSI 1/2 1388 self.logical_sector_size = int( 1389 line.split(':')[1].strip().split(' ')[0]) 1390 # set diagnostics block size to logical sector size 1391 self.diagnostics._block_size = self.logical_sector_size 1392 continue 1393 if 'Physical block size:' in line: # SCSI 2/2 1394 self.physical_sector_size = int( 1395 line.split(':')[1].strip().split(' ')[0]) 1396 continue 1397 if 'Namespace 1 Formatted LBA Size' in line: # NVMe 1398 # Note: we will assume that there is only one namespace 1399 self.logical_sector_size = int( 1400 line.split(':')[1].strip().split(' ')[0]) 1401 continue 1402 1403 if not self.abridged: 1404 if not interface == 'scsi': 1405 # Parse the SMART table for below-threshold attributes and create 1406 # corresponding warnings for non-SCSI disks 1407 self._make_smart_warnings() 1408 else: 1409 # If not obtained Power_On_Hours above, make a direct attempt to extract power on 1410 # hours from the background scan results log. 1411 if self.smart_enabled and self.diagnostics.Power_On_Hours is None: 1412 raw, returncode = self.smartctl.generic_call( 1413 [ 1414 '-d', 1415 'scsi', 1416 '-l', 1417 'background', 1418 self.dev_reference 1419 ]) 1420 1421 for line in raw: 1422 if 'power on time' in line: 1423 self.diagnostics.Power_On_Hours = int( 1424 line.split(':')[1].split(' ')[1]) 1425 1426 # Now that we have finished the update routine, if we did not find a runnning selftest 1427 # nuke the self._test_ECD and self._test_progress 1428 if self._test_running is False: 1429 self._test_ECD = None 1430 self._test_progress = None
Queries for device information using smartctl and updates all
class members, including the SMART attribute table and self-test log.
Can be called at any time to refresh the Device
object's data content.
49def smart_health_assement(disk_name: str, interface: Optional[str] = None, smartctl: Smartctl = SMARTCTL) -> Optional[str]: 50 """ 51 This function gets the SMART Health Status of the disk (IF the disk 52 is SMART capable and smart is enabled on it else returns None). 53 This function is to be used only in abridged mode and not otherwise, 54 since in non-abridged mode update gets this information anyways. 55 56 Args: 57 disk_name (str): name of the disk 58 interface (str, optional): interface type of the disk (e.g. 'sata', 'scsi', 'nvme',... Defaults to None.) 59 60 Returns: 61 str: SMART Health Status of the disk. Returns None if the disk is not SMART capable or smart is not enabled on it. 62 Possible values are 'PASS', 'FAIL' or None. 63 """ 64 assessment = None 65 raw = smartctl.health(os.path.join( 66 '/dev/', disk_name.replace('nvd', 'nvme')), interface) 67 line = raw[4] # We only need this line 68 if 'SMART overall-health self-assessment' in line: # ATA devices 69 if line.split(':')[1].strip() == 'PASSED': 70 assessment = 'PASS' 71 else: 72 assessment = 'FAIL' 73 if 'SMART Health Status' in line: # SCSI devices 74 if line.split(':')[1].strip() == 'OK': 75 assessment = 'PASS' 76 else: 77 assessment = 'FAIL' 78 return assessment
This function gets the SMART Health Status of the disk (IF the disk is SMART capable and smart is enabled on it else returns None). This function is to be used only in abridged mode and not otherwise, since in non-abridged mode update gets this information anyways.
Args: disk_name (str): name of the disk interface (str, optional): interface type of the disk (e.g. 'sata', 'scsi', 'nvme',... Defaults to None.)
Returns: str: SMART Health Status of the disk. Returns None if the disk is not SMART capable or smart is not enabled on it. Possible values are 'PASS', 'FAIL' or None.