============================================================================ Intel(R) SSD Configuration Manager 2.1.0 Copyright (c) 2013 Intel Corporation *** AUTHORIZED FOR INTEL NDA CUSTOMERS ONLY *** ============================================================================ iSSDCM_win32.exe Description ---------------------------------------------------------------------- Intel SSD Configuration Manager is a tool to configure and interact with Intel SSDs. -help [keyword] Description ---------------------------------------------------------------------------- Display the help string and exit.All other arguments will be ignored. Arguments -------------------------------------------------------------------------- [keyword] - (Optional) Perform a keyword search on each feature name and feature description. Put quotes around the keyword when wanting to include spaces. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -help iSSDCM_win32.exe -help drive_index -license Description ---------------------------------------------------------------------------- Display the tool's software license. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -license -log [filename] Description ---------------------------------------------------------------------------- Saves a debug log of the execution steps the tool took to run the selected functionality. By default the log is saved to a file with the name in the following format: 'LOG_{date}_{time}.txt' Arguments -------------------------------------------------------------------------- [filename] - (Optional) Save the log file using the given name instead of the default. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -log iSSDCM_win32.exe -log myLog.txt -drive_list [filename] Description ---------------------------------------------------------------------------- Display a list of attached drives to the screen. All other arguments besides -help will be ignored. For each detected drive, the drive's index, model string, serial number, firmware revision, and device path will be displayed. Arguments -------------------------------------------------------------------------- [filename] - (Optional) Save the drive list information to the given file. File will be in CSV format. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_list iSSDCM_win32.exe -drive_list drive_list_output.txt -drive_index (index_num) Description ---------------------------------------------------------------------------- Use to select a specific drive to interact with. Drive selection is made by index value. You must specify a drive for most features to work. If no other parameters are specified then basic information of the selected drive will be displayed. Arguments -------------------------------------------------------------------------- (index_num) - (Required) A valid drive index number. See the output of -drive_list for the index value of each attached drive. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -drive_serial (serial_num) Description ---------------------------------------------------------------------------- Use to select a specific drive to interact with. Drive selection is made by drive serial number. You must specify a drive for most features to work.If no other parameters are specified then basic information of the selected drive will be displayed. Arguments -------------------------------------------------------------------------- (serial_num) - (Required) A valid serial number of an attached drive. See the output of -drive_list for the serial number of each attached drive. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_serial CVPO893749287GN -drive_path (path) Description ---------------------------------------------------------------------------- Use to select a specific drive to interact with. Drive selection is made by drive's path. You must specify a drive for most features to work. If no other parameters are specified then basic information of the selected drive will be displayed. Arguments --------------------------------------------------------------------------- (path) - (Required) A valid drive path of an attached drive. See the output of -drive_list for the drive path of each attached drive. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_path \\.\PHYSICALDRIVE2 -force Description ---------------------------------------------------------------------------- Use to bypass all the user prompts. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -[Feature_with_prompt] -force -volatile Description ---------------------------------------------------------------------------- Set the volatile option flag for SCT Feature Control. Setting this flag will make the cshanges persist after a power cycle. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -wc_state 2 -volatile -controller Description ---------------------------------------------------------------------------- Use to parse NVMe identify controller data. Must be used with -identify option; it is ignored with all other options. Selected drive must support NVMe commands Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 2 -identify -controller -self_test (test type) Description ---------------------------------------------------------------------------- Execute a drive self test routine on the selected drive. Note: self tests can take several minutes to complete. Arguments -------------------------------------------------------------------------- (test type) - (Required) Type of self-test to run. Supported types are: short, extended, and conveyance. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -self_test short -format [SES] [PI] [LBAF] [PIL] [MS] Description ---------------------------------------------------------------------------- Format the selected drive. The tool will prompt prior to issuing the format. WARNING! FORMAT WILL ERASE ALL DATA ON THE DRIVE! Arguments ---------------------------------------------------------------------------- [SES] - (Optional) Secure Erase Setting. Supported values are: 0 = No Secure Erase{ NVMe: Default } / Standard Secure Erase{ ATA: Default } 1 = User Data Erase {NVMe} / Enhanced Secure Erase {ATA} 2 = Crypto Erase {NVMe Only} [PI] - (Optional) Protection Information {NVMe Only. Selected drive may not support all options}. Supported values are: 0 = Protection Information not enabled {Default } 1 = Protection Information Type 1 enabled 2 = Protection Information Type 2 enabled 3 = Protection Information Type 3 enabled [LBAF] - (Optional) LBA Format {NVMe Only. Selected drive may not support all options.} See identify controller information for supported values. Default = 0 [PIL] - (Optional) Protection Information Location {NVMe Only}. Supported values are: 0 = Protection information is transferred as the last 8 bytes of metadata when protection information is enabled. {Default} 1 = Protection information is transferred as the first 8 bytes of metadata when protection information is enabled. [MS] - (Optional) Metadata Settings {NVMe Only}. Supported values are: 0 = Metadata is transferred as part of a separate contiguous buffer. {Default} 1 = Metadata is transferred as part of an extended data LBA. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -format iSSDCM_win32.exe -drive_index 1 -format 1 2 0 -pg_average Description ---------------------------------------------------------------------------- Display the selected drive's power governor average power setting. Value is returned in miliwatts. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -pg_average -pg_burst Description ---------------------------------------------------------------------------- Display the selected drive's power governor burst power setting. Value is returned in miliwatts. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -pg_burst -write_same (LBA) (count) (pattern) Description ---------------------------------------------------------------------------- Issue SCT Write Same command to the selected drive. The start LBA, number of sectors, and data pattern must be specified. The tool will prompt prior to issuing the Write Same command. Arguments -------------------------------------------------------------------------- (LBA) - (Required) The start LBA to begin the write. Value must be a decimal integer literal. (count) - (Required) Number of logical sectors to fill with given pattern. Value must be a decimal integer literal. (pattern) - (Required) 4-byte hex pattern to use for repeated write. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -write_same 0 5 0x0000ABAB -enable_ssc Description ---------------------------------------------------------------------------- Enable the drive's spread spectrum clocking (SSC) feature. Word 129, bit 1 of Identify Device data will report 1 when SSC is enabled. For the setting to take effect the drive will need to be power cycled. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -enable_ssc -disable_ssc Description ---------------------------------------------------------------------------- Disable the drive's spread spectrum clocking feature. Word 129, bit 1 of Identify Device data will report 0 when SSC is disabled. For the setting to take effect the drive will need to be power cycled. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -disable_ssc -set_phy_speed (speed) Description ---------------------------------------------------------------------------- Set the drive's negotiated Serial ATA signal speed. For the setting to take effect the drive will need to be power cycled. Arguments -------------------------------------------------------------------------- (speed) - (Required) Supported PHY speeds are: 1.5, 3, and 6. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -set_phy_speed 1.5 -set_phy_config (config) Description ---------------------------------------------------------------------------- Set the drive's PHY settings. For the setting to take effect the drive will need to be power cycled. Arguments -------------------------------------------------------------------------- (config) - (Required) Supported values are: 0 = Default enterprise settings. 1 = Client settings. 2 = Alternate Enterprise settings. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -set_phy_config 1 -physical_sector_size [state] Description ---------------------------------------------------------------------------- Display the selected drives physical sector size to the screen. Arguments -------------------------------------------------------------------------- [state] - (Optional) Set the selected drive's physical sector size. Supported values are: 0 = 512Byte physical sector size. 1 = 4KByte physical sector size. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -physical_sector_size 1 -standby_immediate Description ---------------------------------------------------------------------------- Send an ATA Standby Immediate command to the selected drive. This will prepare the drive for a power cycle. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -standby_immediate -get_feature (fid) Description ---------------------------------------------------------------------------- Dispaly the given NVMe feature ID data to the screen. Arguments ---------------------------------------------------------------------------- (fid) - (Required) The feature ID to parse. fid must be a decimal integer literal. Supported feature ID's are: 1 - Arbitration 2 - Power Management 4 - Temperature Threshold 5 - Error Recovery 7 - Number of Queues 8 - Interrupt Coalescing 9 - Interrupt Vector Configuration 10 - Write Atomicity 11 - Asynchronous Event Configuration 194 - Native Max LBA 198 - Power Governor Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -get_feature 4 -get_log (log id) Description ---------------------------------------------------------------------------- Display the given NVMe log data to the screen. Arguments -------------------------------------------------------------------------- (log id) - (Required) NVMe Log ID to parse. Supported log ID's are: 1 - Error Information 2 - SMART / Health Information 3 - Firmware Slot Information 196 - Endurance Manager Statistics 197 - Temperature Statistics 202 - SMART Attributes Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -get_log 2 -phy_counters Description ---------------------------------------------------------------------------- Display the PHY Counters data to the screen. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -phy_counters -error_recovery_control [timer] [value] Description ---------------------------------------------------------------------------- Display the selected drive's current error read and write recovery timers. Arguments -------------------------------------------------------------------------- [timer] - (Optional) Display the selected drive's current error recovery time value for the specified timer. Supported values are: read_timer and write_timer. [value] - (Optional) Write the given value to the selected drive's error recovery timer. Must specify a [timer]. Value must be a decimal integer literal and is in 100ms units. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -error_recovery_control iSSDCM_win32.exe -drive_index 1 -error_recovery_control read_timer iSSDCM_win32.exe -drive_index 1 -error_recovery_control write_timer 5 -pg_mode [mode] Description ---------------------------------------------------------------------------- Display the selected drive's power governor mode. Arguments --------------------------------------------------------------------------- [mode] - (Optional) Set the power governor mode. Valid mode values are: 0, 1, 2. 0 - ATA: Unconstrained. Power will be limited by maximum budget only. NVMe: 25W 1 - ATA: Typical (7W). NVMe: 20W 2 - ATA: Low (5W). NVMe: 15W Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -pg_mode iSSDCM_win32.exe -drive_index 1 -pg_mode 2 -wc_state [state] Description ---------------------------------------------------------------------------- Display the selected drive's write cache state, and option flag. Arguments -------------------------------------------------------------------------- [state] - (Optional) Set the drive's write cache state. Use -volatile to make the setting persist after power cycle. Valid states are: 1 - write cache state is determined by Set Features. 2 - write cache state is enabled. 3 - write cache state is disabled. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -wc_state iSSDCM_win32.exe -drive_index 1 -wc_state 3 iSSDCM_win32.exe -drive_index 1 -wc_state 1 -volatile -wc_reordering_state [enable OR disable] Description ---------------------------------------------------------------------------- Display the selected drive's write cache reordering state, and option flag. Arguments -------------------------------------------------------------------------- [enable OR disable] - (Optional) Enable or Disable the drive's write cache reordering state. Use -volatile to make the setting persist after power cycle. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -wc_reordering_state iSSDCM_win32.exe -drive_index 1 -wc_reordering_state enable iSSDCM_win32.exe -drive_index 1 -wc_reordering_state disable -volatile -temp_logging_interval [time] Description ---------------------------------------------------------------------------- Display the selected drive's temperature logging interval time, and option flag. Arguments --------------------------------------------------------------------------- [time] - (Optional) Set the selected drives temperature logging interval time in minutes. 1 <= time <= 65535. Use -volatile to make the setting persist after power cycle. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -temp_logging_interval iSSDCM_win32.exe -drive_index 1 -temp_logging_interval 2 iSSDCM_win32.exe -drive_index 1 -temp_logging_interval 5 -volatile -pli_test_time_interval [test_time_interval] Description ---------------------------------------------------------------------------- Display the selected drive's PLI test time interval, and option flag. Arguments -------------------------------------------------------------------------- [test_time_interval] - (Optional) Set the selected drives PLI test time interval. Use -volatile to make the setting persist after power cycle. Valid values are: 0: stop interval testing, no immediate test 1: stop interval testing, do immediate test 2: test every hour (60 minutes), do immediate test 3: test every day (1440 minutes), do immediate test 4: test every 3 days (4320 minutes), do immediate test 5: test every 7 days (10080 minutes), do immediate test 6: test every 14 days (20160 minutes), do immediate test Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -pli_test_time_interval iSSDCM_win32.exe -drive_index 1 -pli_test_time_interval 2 iSSDCM_win32.exe -drive_index 1 -pli_test_time_interval 5 -volatile -em_status Description ---------------------------------------------------------------------------- Display selected drive's Endurance Manager status data. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -em_status -hda_temp Description ---------------------------------------------------------------------------- Display selected drive's HDA Temperature data. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -hda_temp -read_phy_settings Description ---------------------------------------------------------------------------- Display selected drive's PHY Settings. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -read_phy_settings -endurance_analyzer [reset] Description ---------------------------------------------------------------------------- Run the endurance analyzer calculation to determine drives life expectancy. Follow these steps to run the Endurance Analyzer: Step 1: Reset SMART Attributes using [reset] option. Step 2: Remove the SSD and install in test system. Step 3: Apply minimum 60 - minute workload to SSD. Step 4: Reinstall SSD in original system. Compute endurance using -endurance_analyzer. Arguments -------------------------------------------------------------------------- [reset] - (Optional) Specify 'reset' to reset the necessary SMART attributes to run a new Endurance Analyzer calculation. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -endurance_analyzer reset iSSDCM_win32.exe -drive_index 1 -endurance_analyzer -firmware_update (filename) Description ---------------------------------------------------------------------------- Update the firmware of the selected drive. The Tool will prompt prior to issuing the firmware update. Arguments -------------------------------------------------------------------------- (filename) - (Required) Firmware binary file to update the drive with. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe iSSDCM_win32.exe -drive_index 1 -firmware_update firmwareBinaryFile.bin -max_address (metric) (value) Description ---------------------------------------------------------------------------- Set the drive's maximum LBA value. THIS FEATURE WILL FORMAT THE DRIVE BEFORE CHANGING THE MAX LBA! The Tool will prompt prior to formatting the drive. The max LBA can be set based on different metrics: value, percent, capacity, and native. Use this function if you wish to over provision your drive. Arguments -------------------------------------------------------------------------- (metric) - (Required) Specify how you want to determine the max LBA value. Supported metric values are: value; Must specify (value) argument. This represents a specific LBA value. percent; Must specify (value) argument. This represents a percentage of overall drive capacity. Given value must be between 1-100 capacity; Must specify (value) argument. This represents the size in GB to set . Must be a decimal integer literal. native; (value) argument is not required. This will reset the selected drive back to it's native max. (value) - (Required) The value is required for all metrics except native. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -max_address native iSSDCM_win32.exe -drive_index 1 -max_address capacity 50 iSSDCM_win32.exe -drive_index 1 -max_address percent 25 iSSDCM_win32.exe -drive_index 1 -max_address value 12345 iSSDCM_win32.exe -drive_index 1 -max_address native -secure_erase Description ---------------------------------------------------------------------------- Secure erase the selected drive. The Tool will prompt prior to issuing the secure erase. WARNING! SECURE ERASE WILL ERASE ALL DATA ON THE DRIVE! Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -secure_erase -read_gpl (filename) [log address] [page #] [sectors] Description ---------------------------------------------------------------------------- Read the general purpose log binary and save it to the given filename. Arguments -------------------------------------------------------------------------- (filename) - (Required) Name of the file to save the GPL binary data to. [log address] - (Optional) Address of the GPL to read. Value must be a decimal integer literal. Default = 0. [page #] - (Optional) Log page to start reading at. Value must be a decimal integer literal. Default = 0. [sectors] - (Optional) Number of sectors to read from the given GPL address. Value must be a decimal integer literal. Default = 1. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -read_gpl supporttedGPL.bin 0 0 1 -enable_dipm Description ---------------------------------------------------------------------------- Enable drive's DIPM feature. Word 79, bit 3 of Identify Device data will report 1 when DIPM is enabled. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -enable_dipm -disable_dipm Description ---------------------------------------------------------------------------- Disable drive's DIPM feature. Word 79, bit 3 of Identify Device data will report 0 when DIPM is disabled. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -disable_dipm -enable_wc Description ---------------------------------------------------------------------------- Enable drive's write cache feature via ATA set features command. Word 85, bit 5 of Identify Device data will report 1 when Write Cache is enabled. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -enable_wc -disable_wc Description ---------------------------------------------------------------------------- Disable drive's write cache feature via ATA set features command. Word 85, bit 5 of Identify Device data will report 0 when Write Cache is disabled. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -disable_wc -set_temp_threshold (value) Description ---------------------------------------------------------------------------- Set the drives temperature threshold value. Arguments -------------------------------------------------------------------------- (value) - (Required) Temperature threhold value in units Kelvin. Max allowed value is 65535. Value must be given as a decimal integer literal. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -set_temp_threshold 1234 -identify [filename] Description ---------------------------------------------------------------------------- Display selected drive's Identify Device data to the screen. Arguments -------------------------------------------------------------------------- [filename] - (Optional) Save the Identify Device data to the given file. Data is saved in CSV format. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -identify -smart [filename] Description ---------------------------------------------------------------------------- Display selected drive's SMART data to the screen. Arguments -------------------------------------------------------------------------- [filename] - (Optional) Save the SMART data to the given file. Data is saved in CSV format. Example ---------------------------------------------------------------------------- iSSDCM_win32.exe -drive_index 1 -smart iSSDCM_win32.exe -drive_index 1 -smart smartData.csv Completed successfully.