0% found this document useful (0 votes)

41 views81 pages

CLI IMAS User Guide Public - Rev015US

Uploaded by

tataredede

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

41 views81 pages

CLI IMAS User Guide Public - Rev015US

Uploaded by

tataredede

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 81

Intel® Memory and

Storage Tool (Intel® MAS)

User Guide - Public

July 2022

Revision 015US

Document Number: 342245-015US

Notice: This document contains information on products in the design phase of development. The information here is
subject to change without notice. Do not finalize a design with this information.
Intel technologies’ features and benefits depend on system configuration and may require enabled hardware, software, or service
activation. Learn more at intel.com, or from the OEM or retailer.
No computer system can be absolutely secure. Intel does not assume any liability for lost or stolen data or systems or any damages
resulting from such losses.
You may not use or facilitate the use of this document in connection with any infringement or other legal analysis concerning Intel
products described herein. You agree to grant Intel a non-exclusive, royalty-free license to any patent claim thereafter drafted
which includes subject matter disclosed herein.
No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document. The
products described may contain design defects or errors known as errata which may cause the product to deviate from published
specifications. Current characterized errata are available on request.
This document contains information on products, services and/or processes in development. All information provided here is subject
to change without notice. Contact your Intel representative to obtain the latest Intel product specifications and roadmaps.
Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for
a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or
usage in trade.
Warning: Altering PC clock or memory frequency and/or voltage may (i) reduce system stability and use life of the system, memory
and processor; (ii) cause the processor and other system components to fail; (iii) cause reductions in system performance; (iv)
cause additional heat or other damage; and (v) affect system data integrity. Intel assumes no responsibility that the memory,
included if used with altered clock frequencies and/or voltages, will be fit for any particular purpose. Check with memory
manufacturer for warranty and additional details.
Tests document performance of components on a particular test, in specific systems. Differences in hardware, software, or
configuration will affect actual performance. Consult other sources of information to evaluate performance as you consider your
purchase. For more complete information about performance and benchmark results, visit http://www.intel.com/performance.
Cost reduction scenarios described are intended as examples of how a given Intel-based product, in the specified circumstances and
configurations, may affect future costs and provide cost savings. Circumstances will vary. Intel does not guarantee any costs or
cost reduction.
Results have been estimated or simulated using internal Intel analysis or architecture simulation or modeling and provided to you
for informational purposes. Any differences in your system hardware, software or configuration may affect your actual performance.
Intel does not control or audit third-party benchmark data or the web sites referenced in this document. You should visit the
referenced web site and confirm whether referenced data are accurate.
Copies of documents which have an order number and are referenced in this document may be obtained by calling 1-800-548-4725
or by visiting www.intel.com/design/literature.htm.
Intel, the Intel logo and Intel Optane are trademarks of Intel Corporation or its subsidiaries.
*Other names and brands may be claimed as the property of others
Copyright © 2022, Intel Corporation. All Rights Reserved.

2 Document Number: 342245, Revision: 015US

Contents
1 Introduction ........................................................................................ 7
Features ................................................................................... 7
1.1.1 Feature Availability ........................................................... 7
1.1.2 Feature Summary ............................................................. 7
System Requirements ................................................................. 8
1.2.1 RAID Support ................................................................... 9
Document Conventions ............................................................. 10
Running the Intel® MAS............................................................. 10
Command Syntax ..................................................................... 10
Targets ................................................................................... 11
2 Feature List ....................................................................................... 12
Quick Command Syntax Guide for Features Table ......................... 12
Features ................................................................................. 12
3 Feature Details .................................................................................. 22
Show Device Information ........................................................... 22
3.1.1 Show Device List .............................................................22
3.1.2 Show Device Data ...........................................................23
3.1.3 Show Health Sensors .......................................................27
3.1.4 Show SMART ..................................................................29
3.1.5 Show Performance Metrics ................................................31
3.1.6 Show Device Identification Structures .................................32
3.1.7 Show NVMe* Controller Information ...................................33
3.1.8 Show Read and Write Latency Statistics Tracking Information 34
3.1.9 Show Parsed Persistent Event Log Data ..............................35
3.1.10 Configure Intel® SSDs Show NVMe* Get Feature Information .36
3.1.11 Show NVMe* IEEE* 16667 Silo Information .........................38
3.1.12 Show NVMe* Read Only/Write Through Mode Information .....39
3.1.13 Show NVMe Error Injection Information ..............................40
Configure Intel® SSDs ............................................................... 41
3.2.1 Firmware Update .............................................................41
3.2.2 Firmware Update (With Binary File) ....................................43
3.2.3 Modify Device .................................................................44
3.2.4 Execute Device Function ...................................................47
3.2.5 Delete Device..................................................................49
3.2.6 NVMe Format ..................................................................50
3.2.7 Set NVMe Feature ............................................................51
3.2.8 Set NVMe* IEEE* 1667 Silo ..............................................52
3.2.9 Set NVMe* Read Only/Write Through Mode .........................53
3.2.10 Set NVMe* Error Injection ................................................54
3.2.11 Clear PCIe* Correctable ....................................................56
3.2.12 Drive Scan ......................................................................57
3.2.13 Read System Snapshot .....................................................58
Configure Namespaces .............................................................. 59
3.3.1 Create a Namespace ........................................................59
3.3.2 Attach a Namespace ........................................................60
3.3.3 Detach a Namespace........................................................61

Document Number: 342245, Revision: 015US 3

3.3.4 Delete a Namespace ........................................................62
Instrumentation Commands ....................................................... 63
3.4.1 Show Tool Configuration ...................................................63
3.4.2 Modify Tool Configuration .................................................65
3.4.3 Dump Device Data ...........................................................66
Support Commands .................................................................. 68
3.5.1 Help Command ...............................................................68
3.5.2 Version Command ...........................................................72
Debug .................................................................................... 74
3.6.1 Tool Debug File ...............................................................74
4 Response Codes ................................................................................ 75
5 Examples........................................................................................... 76
Display Tool Help...................................................................... 76
Display Tool License.................................................................. 76
Display Drives .......................................................................... 76
Bypass Prompts (force) ............................................................. 76
Debug Log Files........................................................................ 76
Display Drive Info ..................................................................... 76
Identify Device ......................................................................... 77
Sensor or SMART Data .............................................................. 77
Delete..................................................................................... 77
Change Maximum LBA .............................................................. 77
Update Firmware ...................................................................... 78
Endurance Analyzer .................................................................. 80
Power Governor Mode ............................................................... 81

4 Document Number: 342245, Revision: 015US

Revision History
Revision
Description Date
Number

Intel® MAS Version 2.1

• Added firmware updates for hybrid products
015US • Updated Solidigm links in installer, GUI, and CLI July 2022
• Hid CLI properties when they are not applicable
• Fixed IMAS GUI crash that occurred with certain Intel® Rapid Storage
Technology (Intel® RST) RAID configurations
Intel® MAS Version 2.0
014SU • Intel® MAS now only supports SSDs based on Intel® Optane™ May 2022
technology

Intel® MAS Version 1.11 (Documentation change only)

013US • Deleted Supported Memory and Storage Devices section, as this October 2021
information is provided in the Release Notes document.

Intel® MAS Version 1.11

012US October 2021
• Updated Supported OS list in System Requirements
Intel® MAS Version 1.10
011US • Added Secure Erase Command for ATA August 2021
• Added RHEL*/CentOS* 8.2 known issue for Delete Namespace

Intel® MAS Version 1.8

010US May 2021
• Added BootDrive option to Section 2.1 and 3.1.2.3

Intel® MAS Version 1.7

009US April 2021
• Added ESXi* 7.0.2 support

Intel® MAS Version 1.6

• Error injection command updates
008US February 2021
• Updated System Requirements Section 1.2
• Updated Supported Memory and Storage Devices Section 1.3

Intel® MAS Version 1.5

007US • Added drive scan, read snapshot and error injection feature January 2021
• Updated System Requirements Section 1.2

Intel® MAS Version 1.4

006US November 2020
• Secure Erase limitation with Windows Server* 2016

Intel® MAS Version 1.3 includes the following updates:

• Added RHEL* 8.0 to supported distros on User Guide
005US • Added persistent event log feature to User Guide October 2020
• Updated endurance analyzer section
• Updated SMART attribute section

Intel® MAS Version 1. 2 includes the addition of the following commands:

004US • NVMe* Reset August 2020
• NVMe* Timestamp

003US Added Windows Server* 2019 to Section 1.2 System Requirements June 2020

Document Number: 342245, Revision: 015US 5

002US Intel® MAS Version 1.0.6 June 2020

001US Initial Release Intel® MAS Version 1.0.5 January 2020

6 Document Number: 342245, Revision: 015US

1 Introduction
This guide describes usability of the Command Line Interface Intel® Memory
and Storage Tool (Intel® MAS) and provides reference on using the tool to
configure and retrieve data from supported products.

Note: Intel® SSDs when referred to in this document are related to supported SSDs
based on Intel® Optane™ technology.

Intel® MAS Summary:

• Command-Line Interface (CLI) based tool for interacting with Intel® SSDs
and Intel® Optane™ memory devices
• Provides firmware updates to all non-OEM drives
• Supports Client and Datacenter drives
• Supports multiple Operating Systems: Windows*, Linux* and ESXi*

Features
The Intel® MAS provides a suite of capabilities for interacting with Intel® SSDs
and Intel® Optane™ memory devices.

1.1.1 Feature Availability

Availability of features is dependent on various factors. These factors include,
but are not limited to, the following:
1. Product
2. Product Type: Client, Datacenter
3. Interface Type: ATA, NVMe* (1.1, 1.2, 1.3, 1.4)
4. Operating System Version/Support
5. Driver: Intel NVMe* driver, Windows* Inbox NVMe* driver, Intel® Rapid
Storage Technology (Intel® RST) driver
6. Configuration: RAID

1.1.2 Feature Summary

The functionality includes:
• Detecting drives attached on the system
• Parsing a drive’s Identify Device information
• Parsing a drive’s SMART (Self-Monitoring and Reporting Technology)
information

Document Number: 342245, Revision: 015US 7

• Resizing the SSD’s usable storage capacity by changing its maximum
Logical Block Addressing (LBA)
• Option to retrieve output in text, JSON or xml format
• Updating SSD firmware:
 Firmware binaries for updating the firmware are embedded in the
tool.
 When displaying drive information, the tool will indicate if a new
firmware is available.
• Calculating drive life expectancy (Endurance Analyzer)
• Power Governor Mode (vendor unique). Three modes are supported:
 0: 25-watts for PCIe* NVMe* devices; 40W for PCIe* NVMe* x8
devices; Unconstrained for SATA devices.
 1: 20-watts for PCIe* NVMe* devices; 35W for PCIe* NVMe* x8
devices; Typical (7-watts) for SATA devices.
 2: 10-watts for PCIe* NVMe* devices; 25W for PCIe* NVMe* x8
devices; Low (5-watts) for SATA devices.
• Functionality to Enable/Disable Latency Tracking
• Functionality to Parse the read and write commands from Latency Tracking
logs
• End of Life notification when 15% of spare is left

The following functionality applies to Intel PCIe* NVMe* drives only:

• Executing an NVMe* Format command
• Parsing device log data
• Reading and setting temperature threshold
• Dumping NLOGS and Event Logs
• Reading and setting the SM Bus Address
• Namespace Management command support (NVMe* 1.2 and later drives)

System Requirements
The Intel® MAS is supported on the following:
• Operating systems on x86/x64 Architecture:
 Windows*:
 Windows Server* 2008 R2, 2012, 2012 R2, 2016, 2019, 2022
 Windows* 8.0, 8.1, 10, 11
 Linux:
 Red Hat* Enterprise Linux* (RHEL*) 8.0, 8.1, 8.2, 8.3, 8.4
 CentOS* 8.0, 8.1, 8.2, 8.3, 8.4
 SLES* 12, 15
 Ubuntu* 16.04, 18.04, 20.04
 ESXi*:

8 Document Number: 342245, Revision: 015US

 ESXi* 6.5, 6.7, 7.0.0, 7.0.1, 7.0.2, 7.0.3
• Available space of 400 MBs

Notes:
• On Windows Server* 2012/2008/R2 and Windows* 8/8.1/10, administrator
access is required. Open a command prompt as administrator and run the
tool via the commands as described in this document. Disable User Account
Control (UAC) where applicable and run the tool in a command prompt.
• On Linux* systems, the tool must be run with root privileges. This can be
done through either sudo or su commands. If running as a non-root user,
the tool will not be able to communicate with the drive. Only basic drive
information will be displayed, and no drive functions will work. There are
two Linux* installers: one for 32-bit systems, and one for 64-bit systems.
• On ESXi* systems, the tool only works on Intel PCIe* NVMe* drives using
the Intel® Accelerator Management Daemon for VMware ESXi* NVMe*
driver. The user will need to set their ESXi* host acceptance level to
“CommunitySupported” to install the tool.
• On Windows Server* 2012, the tool only works with Intel provided
Windows* driver. Click here for the latest drivers. The tool will not work
with the in-box Windows* NVMe* driver found in server 2012 R2. The tool
will return an error if this driver is used.
• Namespace limitations on RHEL*/CentOS* 8.2: Kernel bug can cause
deadlock on delete namespace in RHEL*/CentOS* 8.2
• Earlier OS Versions not listed in supported list are generally expected to
work but are not actively validated and not officially supported

1.2.1 RAID Support

Supported:
• The Intel® RST RAID supports direct attached SSD SATA drives only.
• Drives attached to LSI MegaRAID* adaptors

Not Supported:
• Drives behind Host Bus Adapters (HBAs)

RAID Modes Supported:

• RAID 0
• RAID 1
• RAID 5
• Intel® Virtual RAID on CPU (Intel® VROC) RAID

Other Modes Supported:

• AHCI

Document Number: 342245, Revision: 015US 9

Document Conventions
Throughout this guide, the format of each command is documented in a gray
colored text box.
• Items in [brackets] are optional.
• For options and targets, each possible value is separated by a bar, ‘|’,
meaning “or” and the default value is listed first.
• Items in (parenthesis) indicate a user supplied value.
• For example, the following set command is interpreted as follows:
• The verb set can be followed by an optional modifier (help).
• The target –intelssd is required followed by Index or Serial number of the
drive to be targeted
• It also specifies a required property Test in which valid values are Test1 or
Test2.

IntelMAS set [-h|-help] –intelssd [(Index|SerialNumber|PhysicalPath)]

Test=(Test1|Test2)

Running the Intel® MAS

Run the Intel® MAS from either a Windows administrator command prompt or a
Linux* terminal window. The tool is run as a single command by supplying the
command and parameters immediately following the Intel® MAS executable.

IntelMAS show –intelssd

Command Syntax
The command line syntax is case insensitive and is interpreted in English-only.
It follows the Distributed Management Task Force* (DMTF*) Server
Management (SM) Command Line Protocol (CLP), or DMTF SM-CLP standard
except for the target portion of the command. Document number DSP0214 and
can be found at http://www.dmtf.org.

Target specification in SM-CLP identifies CIM instances using CIM object paths.
The modified syntax implemented utilizes key properties of the target without
requiring a syntactically correct CIM object path. Generally, the form of a user
request is:

IntelMAS <verb>[<options>][<targets>][<properties>]

10 Document Number: 342245, Revision: 015US

A command has a single verb that represents the action to be taken. Following
the verb can be one or more options that modify the action of the verb,
overriding the default behavior with explicitly requested behavior.

Options generally have a short and long form (for example, -a|-all). One or
more targets are normally required to indicate the object of the action.
However, there are a few cases where a target is not required. Finally, zero or
more properties defined as a key/value pair can be used to modify the target.

Targets
In general, if there is only one object of a specific target type, a target value is
not accepted.

Unless otherwise specified, when there are multiple objects of a specific target
type, not supplying a target value implies the command must operate on all
targets of that type. This is the case for the show device command, which will
display all devices if no target value is specified.

IntelMAS show -intelssd

The same operation can be limited to a single object by supplying a specific

target value.

IntelMAS show -intelssd 1

Document Number: 342245, Revision: 015US 11

2 Feature List
The following table list all features available in Intel® MAS. Features are listed
alphabetically. Intel® MAS uses CLI. Command Syntax describes the command
and command syntax needed to perform each feature. Commands can have
different options and ways to specify target drive.

Further details for each command is provided in subsequent sections of this

document.

Quick Command Syntax Guide for Features

Table
Options Description

[-all|-a] Shows all properties.

Filters the returned properties by explicitly specifying a comma

[-display|-d] separated list of any of the properties defined in the Return Data
section.

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Target Description

-intelssd [(Index|
Restricts output to specific Intel® SSD by supplying the device’s
SerialNumber
Index or Serial Number or path or Bootdrive.
|PhysicalPath BootDrive option available in Windows* only.
|Bootdrive)]

Features
Feature Description Command Syntax Example

set [-help|-h] [-output|-o

12 Document Number: 342245, Revision: 015US

Feature Description Command Syntax Example

dump [-help|-h] [-
Read the Assert Log destination (path)] [-
binary and save it to output|-o intelmas dump -
the given filename. (text|nvmxml|json)] [- destination
Assert Log
assertlog_binary.bin -
intelssd
intelssd 1 -assertlog
NVMe* only [(Index|SerialNumber|Physica
lPath)]] -assertlog
Read the Bridge dump [-help|-h] [-
NLog binary and destination (path)] [-
intelmas dump -
save it to the givenoutput|-o
destination
Bridge NLog filename. (text|nvmxml|json)] [-
apl_bridge_binary.bin -
intelssd
intelssd 1 -bridgenlog
[(Index|SerialNumber|Physica
Selected NVMe* only lPath)]] -bridgenlog

delete [-help|-h] [-force|-

Document Number: 342245, Revision: 015US 13

Feature Description Command Syntax Example

set [-help|-h] [-output|-o

14 Document Number: 342245, Revision: 015US

Feature Description Command Syntax Example

start [-help|-h] [-force|-f]

intelmas show -intelssd

Show the device 1 -identify
show [-help|-h] [-output|-o
identify structures. intelmas show -intelssd
(text|nvmxml|json)] -
Use the - 1 -identify -namespace 1
identify [-namespace
nvmecontroller and -
(integer | 'attached' | intelmas show -intelssd
Identify namespace targets
to select specific
'allocated')] [- 1 -identify -namespace
identify
nvmecontroller] [-intelssd attached
[(Index|SerialNumber|Physica
structures for NVMe* intelmas show -intelssd
lPath)]]
devices. 1 -identify -namespace
allocated

Document Number: 342245, Revision: 015US 15

Feature Description Command Syntax Example

show [-help|-h] [-output|-o

(text|nvmxml|json)] -
latencystatistics intelmas show -intelssd 1
Display the Latency ('reads'|'writes') [- -latencystatistics
tracking status. intelssd intelmas show -intelssd 1
[(Index|SerialNumber|Physica -latencystatistics reads
Enable or disable the
Latency Tracking lPath)]] intelmas show -intelssd 1
device's Latency
set [-help|-h] [-output|-o -latencystatistics writes
Tracking feature.
(text|nvmxml|json)] - intelmas set -intelssd
Selected drives only
intelssd 1 LatencyTrackingEnabled=
(Index|SerialNumber|Physical true
Path) LatencyTrackingEnabled
= (true|false)
show [-help|-h] [-display|-d
(Property1,...)] [-all|-a]
[-output|-o intelmas show -intelssd 1
(text|nvmxml|json)] [- -led
intelssd intelmas set -intelssd 1
[(Index|SerialNumber|Physica -led IdleState = on
lPath)]] intelmas set -intelssd 1
Display the selected -led set [-help|-h] [- -led DurationBase = 25
drive's LED activity output|-o intelmas set -intelssd 1
LED Activity settings. (text|nvmxml|json)] - -led FormatOnMultiplier =
intelssd 5
(Index|SerialNumber|Physical intelmas set -intelssd 1
Selected drives only
Path) -led [IdleState = -led FormatOffMultiplier
(on|off)] [DurationBase = = 5
(25|50)] [FormatOnMultiplier intelmas set -intelssd 1
= (0-15)] -led IoOnMultiplier = 5
[FormatOffMultiplier = (0- intelmas set -intelssd 1
15)] [IoOffMultiplier = (0- -led IoOffMultiplier = 5
15)] [IoOnMultiplier = (0-
15)]
version [-all|-a] [-
Display the tool's display|-d (Property1,...)] intelmas version -d
License
software license. [-help|-h] [-output|-o license
(text|nvmxml|json)]
intelmas set -intelssd 1
Set the drive's set [-help|-h] [-output|-o MaximumLBA = native
maximum LBA value. (text|nvmxml|json)] - intelmas set -intelssd 1
intelssd MaximumLBA = 50GB
Max Address
(Index|SerialNumber|Physical intelmas set -intelssd 1
Caution: Resizes the Path) MaximumLBA = (numGB|1- MaximumLBA = 25%
drive 100%|LBA|'native') intelmas set -intelssd 1
MaximumLBA = 4097151

16 Document Number: 342245, Revision: 015US

Feature Description Command Syntax Example

attach [-help|-h] [-output|-

Document Number: 342245, Revision: 015US 17

Feature Description Command Syntax Example

show [-help|-h] [-display|-d

reset [-help|-h] [-output|-o

18 Document Number: 342245, Revision: 015US

Feature Description Command Syntax Example

show [-help|-h] [-display|-d

Document Number: 342245, Revision: 015US 19

Feature Description Command Syntax Example

20 Document Number: 342245, Revision: 015US

Feature Description Command Syntax Example

Notes: On device target options:

• In Windows*, device can be targeted with BootDrive option in addition to
Index|SerialNumber|PhysicalPath
• PhysicalPath option may not work with some Linux* distributions.

Document Number: 342245, Revision: 015US 21

3 Feature Details
Show Device Information
This section provides different options to retrieve device related information.

3.1.1 Show Device List

Show information about one or more Intel® SSD devices.

Generally, this command is run as a first step to get list of devices attached
and get device index.

Syntax

IntelMAS show [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

[(Index|SerialNumber|PhysicalPath)]

Options
Option Description

Filters the returned properties by explicitly specifying a

[-display|-d] comma separated list of any of the properties defined in the
Return Data section.

[-help|-h] Displays help for the command.

Changes the format of the Return Data. Supported output

[-output|-o (text | nvmxml | json)] options are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Restricts output to specific Intel® SSD by

supplying the device’s Index or Serial Number.
-intelssd
By default, the command displays all Intel®
[(Index|SerialNumber|PhysicalPath|BootDrive)] SSDs. BootDrive option available in Windows*
only.

Properties
This command does not support any properties

Examples
Lists all the devices attached to the system. Basic/default properties are
displayed for each device.

22 Document Number: 342245, Revision: 015US

IntelMAS show –intelssd

Lists basic default information for drive at index 0

IntelMAS show –intelssd 0

3.1.2 Show Device Data

Show detailed information about one or more Intel® SSD devices.

Syntax

IntelMAS show [-all|-a] [-display|-d] [-help|-h] [-output|-o

(text|nvmxml|json)] -intelssd [(Index|SerialNumber|PhysicalPath)]

Options
Option Description

[-all|-a] Shows all properties.

Filters the returned properties by explicitly specifying a comma

[-display|-d] separated list of any of the properties defined in the Return Data
section.

[-help|-h] Displays help for the command.

Changes the format of the Return Data. Supported output

[-output|-o (text | nvmxml | json)] options are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Restricts output to specific Intel® SSD by supplying the

-intelssd
device’s Index or Serial Number. By default, the command
[(Index|SerialNumber|PhysicalPath)] displays all Intel® SSDs.

Properties
This command does not support any properties.

Return Data
By default, a table is displayed with the following default properties. Use the
options to show more detail.
Property Description

(For ATA devices only) True if the devices support the

AccessibleMaxAddressSupported accessible max address commands (Identify device Word 103
bit 8).

Document Number: 342245, Revision: 015US 23

Property Description

(For NVMe* devices only) Shows the minimum number of

completion queue entries to aggregate per interrupt vector
AggregationThreshold before signaling an interrupt to the host. This value is zero-
based.

(For NVMe* devices only) Shows the recommended maximum

AggregationTime time in 100 microsecond increments that a controller may
delay an interrupt due to interrupt coalescing.

(For NVMe* devices only) Shows the maximum number of

ArbitrationBurst commands that the controller may launch at one time. This
value is specified in 2^n. A value of 7 indicates no limit.

(For NVMe* devices only) Determines whether an

asynchronous event notification is sent to the host for the
AsynchronousEventConfiguration corresponding Critical Warning specified in the SMART / Health
Information Log.

(Default; For NVMe* devices only, if present) Return the

Bootloader devices Bootloader Revision.

(Windows* OS only) The bus type value determined by

BusType Windows*.

(Currently in Windows* OS only) Shows a description of the

ControllerDescription controller the device is attached to.

(Windows* OS only) The ID value of the device controller

ControllerID found in the Windows* OS registry.

Shows if the controller the device is attached to is in IDE

ControllerIDEMode mode. Returns either True or False.

(Currently in Windows* OS only) The manufacturer of the

ControllerManufacturer controller that the device is attached to.

(Currently in Windows* OS only) Displays the controller driver

ControllerService sys file that the attached device is connected to.

(Default) The OS path to the device

DevicePath (for example \\.\PhysicalDrive0).

(Default) Report the device’s status. In the current

implementation this will look at ErrorString and if it is empty it
DeviceStatus will report “Healthy” otherwise it will report the value of
ErrorString.

(Default; if present) This reports if the tool detected a

potential error with communicated with the driver the device
is connected to. For example, the tool will detect an error if
DriverCommunicationError the Server 2012 R2* system is using the in-box NVMe* driver
from Microsoft*. Intel® MAS does not support communication
with that driver.
DriverDescription Description of the controller driver that the device is attached
to. Currently in Windows* OS only.

Major version of the controller driver that the device is

DriverMajorVersion attached to. Currently in Windows* OS only.

Manufacturer of the controller driver that the device is

DriverManufacturer attached to. Currently in Windows* OS only.

Minor version of the controller driver that the device is

DriverMinorVersion attached to. Currently in Windows* OS only.

24 Document Number: 342245, Revision: 015US

Property Description

The drives life expectancy in years. This utilizes the 0xE2,

0xE3 and 0xE4 SMART attributes.
If these SMART attributes have a value of 0xFFFF then they
EnduranceAnalyzer are still in the reset state and a 60+ minute workload has yet
to run.
If the media wear indicator is zero, then the workload has not
induced enough wear to calculate an accurate life expectancy.

Shows a description of the error state of the drive.

ErrorString
Note: The drive is not in an error state if the value is blank.

Firmware (Default) Shows the firmware revision of the device.

(Default) Shows the firmware revision available for update.

Firmware updates are carried within the tool as a “payload”
FirmwareUpdateAvailable binary for each supported drive. Tool reports ‘Firmware is up
to date as of this tool release’ if the device’s firmware is up to
date.

(For NVMe* devices only) Shows the number of commands

HighPriorityWeightArbitration that can be executed from the high priority services class in
each arbitration round. This is a 0’s-based value.

(Default) Shows the Intel® SSD device index, used for device
Index selection.

IntelGen3SATA True if the device is an Intel SATA SSD.

IntelNVMe True if the device is an NVMe* Intel® SSD.

(For NVMe* devices only) Shows the number of I/O

IOCompletionQueuesRequested Completion Queues requested.

(For NVMe* devices only) Shows the number of I/O

IOSubmissionQueuesRequested Submission Queues requested.

Shows if the latency tracking feature of the drive is enabled

LatencyTrackingEnabled (True) or disabled (False).

(For NVMe* devices only) Shows the LBA Format that the
drive is configured with. This has a possible value of 0 to
LBAFormat ‘NumLBAFormats’. Details of the different LBA formats can be
found in Identify Namespace. This value can be changed by
NVMe* format.

(For NVMe* devices only) Shows the number of commands

LowPriorityWeightArbitration that can be executed from the low priority services class in
each arbitration round. This is a 0’s-based value.

MaximumLBA Shows the devices maximum logical block address.

(For NVMe* devices only) Shows the number of commands

MediumPriorityWeightArbitration that can be executed from the medium priority services class
in each arbitration round. This is a 0’s-based value.

(For NVMe* devices only) Shows the device’s Metadata

setting.
One of either:
• 0: Metadata is transferred as part of a separate
MetadataSetting contiguous buffer.
• 1: Metadata is transferred as part of an extended data
LBA.
This can be changed by issuing an NVMe* format.

Document Number: 342245, Revision: 015US 25

Property Description

ModelNumber (Default) Shows the model number assigned to the device.

(For NVMe* devices only) Shows the value of the namespace

NamespaceId ID of the device if it has one. The namespace must be
allocated and attached.

Shows the devices native maximum logical block address set

NativeMaxLBA in manufacturing. This value cannot be changed. It represents
the physical maximum number of LBAs for the device.

(For NVMe* devices only) Shows the number of Error

NumErrorLogPageEntries Information log entries that are stored by the controller. This
value is zero-based.

(For NVMe* devices only) Shows the number of different LBA

Formats the device supports. This value is zero-based. For
NumLBAFormats example, a value of 6 means there are 0 to 6 possible LBA
Formats (7 total).

(For NVMe* devices only) The value of the NVMe* controller

NVMeControllerID ID found in the NVMe identify controller structure.

(For NVMe* devices only) Shows the power state of the

controller. Supported power states are described in the
NVMePowerState Identify Controller data structure. This is an NVMe* Get
Feature (feature ID=2)

(For NVMe* devices only) True if the device supports the

NVME_1_0_Supported NVMe* 1.0 command specification.

(For NVMe* devices only) True if the device supports the

NVME_1_2_Supported NVMe* 1.2 command specification.

PCILinkGenSpeed (For NVMe* devices only) The devices PCI Gen speed.

(For NVMe* devices only) The devices PCI link width. For
PCILinkWidth example, 4 or 8

The physical size of the device in bytes. Value is in decimal

PhysicalSize format.

(Windows* OS only) The devices PNP String from the Windows

PNPString registry.

ProductProtocol The devices protocol, for example ATA or NVMe*.

• Shows the devices’ Power Governor state. 0: 25-watts for

PCIe* NVMe* devices; 40W for PCIe* *NVMe* x8
devices; Unconstrained for SATA devices.
PowerGovernorMode • 1: 20-watts for PCIe* NVMe* devices; 35W for PCIe*
NVMe* x8 devices; Typical (7-watts) for SATA devices.
• 2: 10-watts for PCIe* NVMe* devices; 25W for PCIe*
NVMe* x8 devices; Low (5-watts) for SATA devices.
ProductFamily (Default) Shows the Intel® SSD Series name.

(For NVMe* devices only) Shows the device’s protection

information type setting. One of:
ProtectionInformation • 0: Protection information is not enabled.
• 1: Protection information type 1 is enabled.
This can be changed by issuing an NVMe* format.

26 Document Number: 342245, Revision: 015US

Property Description

(For NVMe* devices only) Shows the device’s protection

information location setting. One of:
• 0: Protection information is transferred as the last 8 bytes
ProtectionInformationLocation
of metadata.
• 1: Protection information is transferred as the first 8 bytes
of metadata.
Shows if the device is part of a RAID. Currently only support
RAIDMember RST RAID drivers and LSI Mega RAID.

(Windows* OS only) The port number of the SCSI path used

SCSIPortNumber by Windows*.

SectorSize Shows the sector size in bytes.

SerialNumber (Default) Shows the serial number assigned to the device.

Shows if SMART capabilities are enabled on the device.

SMARTEnabled Reports True or False.

(For NVMe* devices only) Shows the SM Bus address of the

SMBusAddress drive. Value of 255 means the SM Bus is disabled.
StorageSpaceMember Shows if the device is a Windows* Storage Space member.

(For NVMe* devices only) Shows the temperature threshold of

TempThreshold the overall device. Units are in Celsius.

(For NVMe* devices only) Shows the limited retry timeout

value in 100 millisecond units. This applies to I/O commands
TimeLimitedErrorRecovery that indicate a time limit is required. A value of 0 indicates
that there is no timeout.

TrimSupported True if the device supports Trim feature.

(For NVMe* devices only) True if the volatile write cache is

VolatileWriteCacheEnabled enabled.

(For NVMe* devices only) Shows the atomic write status. One
of:
• 0: If cleared to ‘0’, the atomic write unit for normal
WriteAtomicityDisableNormal operation shall be honored by the controller.
• 1: The host specifies that the atomic write unit for normal
operation is not required and the controller shall only
honor the atomic write unit for power fail operations.

Examples
Lists basic properties for the Intel® SSD devices at index 1.

IntelMAS show -a -intelssd 1

3.1.3 Show Health Sensors

The show –sensor command shows the health sensor properties of one or
more Intel® SSDs.

Document Number: 342245, Revision: 015US 27

Syntax

IntelMAS show [-all|-a] [-display|-d] [-help|-h] [-output|-o

(text|nvmxml|json)] -sensor [-intelssd (Index|SerialNumber|PhysicalPath)]

Options
Option Description

[-all|-a] Show all properties.

Filters the returned properties by explicitly specifying a comma

[-display|-d] separated list of any of the properties defined in the Return Data
section.

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-sensor Displays the health-related properties for device(s).

(Optional) Restricts output to specific Intel® SSD by supplying

[-intelssd
the Intel® SSD Index or Serial Number. The default is to display
(Index|SerialNumber|PhysicalPath)] sensors for all manageable Intel® SSDs.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software.

Return Data
The command displays the following properties for each sensor command
option. This output could be filtered by specifying the Properties with the -
display option. It can be further filtered by specifying the ID property.

Note: Some health sensor properties are not supported some devices.
Property Description

(NVMe* Devices Only). Percentage (0 to 100%) of the remaining

AvailableSpare spare capacity available.

AverageNandEraseCycles Average number of NAND erase cycles for all blocks.

CrcErrorCount Total number of interface (SATA or NVMe*) CRC errors.

EndToEndErrorDetectionCount Total number of end-to-end detected errors.

EnduranceAnalyzer Reports the expected drive life in years.

EraseFailCount Total number of raw erases fails.

(NVMe* Devices Only). Number of entries in the Error Info Log

ErrorInfoLogEntries page over the life of the controller.

28 Document Number: 342245, Revision: 015US

Property Description

(NVMe* Devices Only). The highest lifetime temperature (in

HighestLifetimeTemperature Celsius) of the device.

(NVMe* Devices Only). The lowest lifetime temperature (in Celsius)

LowestLifetimeTemperature of the device.

MaxNandEraseCycles Max number of NAND erase cycles for all blocks.

(NVMe* Devices Only). Number of times where the controller

MediaErrors detected an unrecovered data integrity error.

MinNandEraseCycles Min number of NAND erase cycles for all blocks.

PercentageUsed Estimate of the percentage of life used of the device.

PowerCycles (NVMe* Devices Only). Number of power cycles.

PowerOnHours Contains the number of power on hours of the device.

ProgramFailCount Total number of raw program fails.

(NVMe* Devices Only). Specified PCB maximum operating

SpecifiedPCBMaxOperaratingTemp temperature in degrees C.

(NVMe* Devices Only). Specified PCB minimum operating

SpecifiedPCBMinOperaratingTemp temperature in degrees C.

Temperature Total temperature of the device in degrees C

ThermalThrottleCount The total number of times thermal throttle has been activated.

The amount that Thermal Throttle that is applied. A value of zero is

ThermalThrottleStatus no throttle. 100 is 100% throttling applied.

Reports the number of unsafe shutdowns over the life of the

UnsafeShutdowns device.

3.1.4 Show SMART

The show –smart command shows the SMART attributes for one or more
Intel® SSDs.

Syntax

IntelMAS show [-all|-a] [-display|-d] [-help|-h] [-output|-o

Options
Option Description

[-all|-a] Show all properties.

Filters the returned properties by explicitly specifying a comma

[-display|-d] separated list of any of the properties defined in the Return Data
section.

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Document Number: 342245, Revision: 015US 29

Targets
Target Description

Displays SMART attributes for device(s). Specific SMART

-smart [(id)] attributes can be selected if (id) is given.

(Optional) Restricts output to specific Intel® SSD by supplying

[-intelssd
the Intel® SSD Index or Serial Number. The default is to display
(Index|SerialNumber|PhysicalPath)] sensors for all manageable Intel® SSDs.

Properties
Property Description

Determines whether to return NVMe* SMART health log

attributes in addition to standard.SMART attributes.
IncludeNVMeSmartHealthLog=(true|false) Default is false.
Supported for NVMe only.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software.

Return Data
The command displays the following properties for each SMART attribute. This
output could be filtered by specifying the Properties with the –display option.

Note: Some optional properties are not supported on all device sensors and SMART
Attributes F4/F5 are reported in Bytes.
Property Description

(Optional) Shows the Pass/Fail status based on the Pre-failure/advisory

Action status bit.

Description Shows a string representation of the ID token.

The SMART Attribute ID token.

ID Smart ID: 03, 04, 05, 0C, AA, B8, BB, C1, E2, E9, F2
Not all drives have the same SMART Id's

Normalized Shows the normalized value of the SMART attribute.

Raw Shows the raw value of the SMART Attribute. Value is in decimal.

(Optional) Shows the status flags for the SMART attribute:

• Bit 0 Pre-failure/advisory bit
• Bit 1 Online data collection
• Bit 2 Performance attribute
Status
• Bit 3 Error rate attribute
• Bit 4 Event count attribute
• Bit 5 Self-preserving attribute
• Bits 6 – 15 Reserved
Threshold (Optional) Shows the SMART Attributes threshold value.

30 Document Number: 342245, Revision: 015US

Property Description

(Optional) Shows the SMART attributes worst normalized value.

Worst Maintained for the life of the device.

Show all the properties of the SMART E9 Attribute for the Intel® SSD at Index
1.

show –smart E9 –intelssd 1

Shows only the raw value of the SMART E9 Attribute for all Intel® SSDs.

IntelMAS show –d raw -smart E9

3.1.5 Show Performance Metrics

The show –performance command shows the performance metrics for one or
more Intel® SSDs.

Syntax

IntelMAS show [-all|-a] [-display|-d] [-help|-h] [-output|-o

(text|nvmxml|json)] -performance [-intelssd
(Index|SerialNumber|PhysicalPath)]

Options
Option Description

[-all|-a] Show all properties.

Filters the returned properties by explicitly specifying a comma

[-display|-d] separated list of any of the properties defined in the Return Data
section.

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-performance Displays performance metrics for device(s).

(Optional) Restricts output to specific Intel® SSD by supplying

[-intelssd the Intel® SSD Index or Serial Number. The default is to display
(Index|SerialNumber|PhysicalPath)] sensors for all manageable Intel® SSDs.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software.

Document Number: 342245, Revision: 015US 31

Return Data
The command displays the following properties associated with performance
metrics. This output could be filtered by specifying the Properties with the –
display option.

Note: Some optional properties are not supported on some devices.

Property Description

(NVMe* Devices only). Amount of time the controller is busy with I/O commands.
ControllerBusyTime Value is reported in minutes.

(NVMe* Devices only). The number of 512-byte data units the host has read from
DataUnitsRead the device. Value is reported in units of 1000 (1 = 1000 units of 512 bytes).

(NVMe* Devices only). The number of 512-byte data units the host has written to
DataUnitsWritten the device. Value is reported in units of 1000 (1 = 1000 units of 512 bytes).

(NVMe* Devices only). The number of read commands completed by the

HostReadCommands controller.

(NVMe* Devices only). The number of write commands completed by the

HostWriteCommands controller.

3.1.6 Show Device Identification Structures

The show –identify command shows the device identification structures for
one or more Intel® SSDs.

Syntax

IntelMAS show [-help|-h] [-output|-o (text|nvmxml|json)] [-intelssd

(Index|SerialNumber|PhysicalPath)] –identify [-nvmecontroller] [-namespace
(id|’attached’|’allocated’)]

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-identify Displays identification structures for Intel® SSDs.

[-intelssd (Optional) Restricts output to specific Intel® SSD by supplying the

(Index|SerialNumber|PhysicalPath)] Intel® SSD Index or Serial Number.

(Optional) Specify it to parse the NVMe* identify controller

[-nvmecontroller] structure.

32 Document Number: 342245, Revision: 015US

Target Description

(Optional) Specify it to parse the NVMe* namespace structure for

the given namespace ID. If ‘attached’ is given, parse the list of
[-namespace
attached NVMe* namespaces. If ‘allocated’ is given, parse the list
(id|’attached’|’allocated’)] of allocated NMVe* namespaces (these are created and may, or
may not, be attached).

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software.

Return Data
This command will return human readable text of the specified Identify
structure. Use the –output option to return the parsed data in different
formats.

Note: Some identify structures are not supported on all devices.

3.1.7 Show NVMe* Controller Information

The show –nvmecontroller command lists the NVMe* controller IDs for one
or more Intel® SSDs. Only supported on NVMe* devices.

Syntax

IntelMAS show [-help|-h] [-output|-o (text|nvmxml|json)] [-intelssd

(Index|SerialNumber|PhysicalPath)] –nvmecontroller [-namespace (id)]

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

(Required) Will parse the list of all NVMe* controllers of the

-nvmecontroller device. You can change the behavior if -namespace target is
given.

[-intelssd (Optional) Restricts output to specific Intel® SSD by supplying

(Index|SerialNumber|PhysicalPath)] the Intel® SSD Index or Serial Number.

(Optional) If given, with a valid namespace ID value, then the

list of controllers attached to that given namespace ID is
[-namespace (id)] returned. The Tool will issue the NVMe* identify command with
CNS=0x12.

Document Number: 342245, Revision: 015US 33

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an Intel NVMe SSD.

Return Data
This command will parse and return human readable text. Use the –output
option to return the parsed data in different formats.

3.1.8 Show Read and Write Latency Statistics Tracking

Information
The show –latencystatistics command parses the Latency Statistics Logs for
one or more Intel® SSDs. The LatencyTrackingEnabled must be set to true
in order to read the logs.

Syntax

IntelMAS show [-help|-h] [-output|-o (text|nvmxml|json)] –

latencystatistics (‘reads’|’writes’) [-intelssd
(Index|SerialNumber|PhysicalPath)]

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Used to display latency statistics logs for read or write

commands. In order to successfully read the logs the
-latencystatistics (reads|writes) LatencyTrackingEnabled property must be set to True. See
Modify Device

[-intelssd Restricts output to a specific Intel® SSD by supplying the

(Index|SerialNumber|PhysicalPath)] Intel® SSD Index or Serial Number.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software.

34 Document Number: 342245, Revision: 015US

Return Data
This command will parse and return human readable text of the Latency
Statistics Log structure. Use the –output option to return the parsed data in
different formats.

3.1.9 Show Parsed Persistent Event Log Data

The show -persistenteventlog command parses persistent event log data
either from a binary file saved on the system or pulled directly from the drive.

Syntax

IntelMAS show [-help|-h] [-source (path)] [-destination (path)] [-output|-

o (text|nvmxml|json)] [-intelssd (Index|SerialNumber|PhysicalPath)] –
persistenteventlog

Options
Option Description

[-help|-h] Displays help for the command.

If used, will parse a persistent event log binary file at this path. If
this option is not used, data will instead be pulled from the drive
[-source (path)] and parsed immediately (if a persistent event log context is
established).

If used, will output the parsed persistent event log data to a text
[-destination (path)] file at the specified path. If not used, the parsed data will be
displayed to the user.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-persistenteventlog Used to parse persistent event log data.

[-intelssd Restricts output to a specific Intel® SSD by supplying the

(Index|SerialNumber|PhysicalPath)] Intel® SSD Index or Serial Number.

Limitations
The persistent event log command must be supported by the drive. To pull the
persistent event log data from the drive and parse it (by omitting the -source
option) a persistent event log context must be established using the dump
command, see Section 3.4.3.

Document Number: 342245, Revision: 015US 35

Return Data
This command will parse and return human readable text of the persistent
event log. Use the –output option to return the parsed data in different
formats.

Examples
Parse a previously dumped persistent event log binary (see section 3.4.3)

IntelMAS.exe show -source PEL_binary.bin -destination PEL_parsed.txt -

persistenteventlog

Parse persistent event log data directly from a drive

IntelMAS.exe show -destination PEL_parsed.txt -intelssd 1 -

persistenteventlog

3.1.10 Configure Intel® SSDs Show NVMe* Get Feature

Information
The show –getfeature command sends a get feature command with the
specified feature id (FID) for Intel® SSDs. Only supported on NVMe* devices.

Syntax

IntelMAS show [-help|-h] [-display|-d (Property1,...)] [-all|-a] [-

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

36 Document Number: 342245, Revision: 015US

Targets
Target Description

Specify the feature id (FID) of the NVMe* get feature

command
Examples of valid input would be
• 0x1 - Arbitration
• 0x2 - Power Management
• 0x3 - LBA Range Type
• 0x4 - Temp Threshold
-getfeature (feature id)
• 0x5 - Error Recovery
• 0x6 - Volatile Write Cache
• 0x7 - Number Of Queues
• 0x8 - Interrupt Coalescing
• 0x9 - Interrupt Vector Config
• 0xA - Write Atomicity
• 0xB - Event Config
[-intelssd (Optional) Restricts output to specific Intel® SSD by supplying
(Index|SerialNumber|PhysicalPath)] the Intel® SSD Index or Serial Number.

Namespace target is optional. Must specify namespace ID if

-namespace (namespace Id) being used.

Properties
Below are the properties that can be modified.
Property Description

Sets the select value

Valid values are:
• Current
Select
• Default
• Saved
• Capabilities

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an Intel NVMe SSD.

The command is entirely dependent on valid feature id values. Different drive

families will support different
feature ids.

Return Data
This command will parse and return human readable text of the specified
NVMe* get feature. Use the –output option to return the parsed data in
different formats.

Document Number: 342245, Revision: 015US 37

3.1.11 Show NVMe* IEEE* 16667 Silo Information
The show -IEEESilo command sends a get feature command with the specified
feature id (FID) for Intel® SSDs. Used to show IEEE* 16667 Silo information.

Only supported on NVMe* devices that support the NVMe* Cloud SSD
Specification from the Open Compute Project (OCP).

Syntax

IntelMAS show [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Specifies that IEEE* 16667 Silo information is

-IEEESilo requested.
No input required.

[-intelssd (Optional) Restricts output to specific Intel® SSD by

(Index|SerialNumber|PhysicalPath)] supplying the Intel® SSD Index or Serial Number.

Properties
Below are the properties that can be modified.
Property Description

Sets the select value

Valid values are:
• Current
Select
• Default
• Saved
• Capabilities

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an NVMe* Intel® SSD.

This command is only supported on NVMe* devices that support the NVMe*
Cloud SSD Specification from the OCP.

38 Document Number: 342245, Revision: 015US

Return Data
This command will parse and return human readable text of the specified
NVMe* get feature. Use the –output option to return the parsed data in
different formats.

3.1.12 Show NVMe* Read Only/Write Through Mode

Information
The show -ReadOnlyWriteThrough command sends a get feature command
with the specified feature id (FID) for Intel® SSDs. Used to show Read
Only/Write Through mode information.

Only supported on NVMe* devices that support the NVMe* Cloud SSD
Specification from the OCP.

Syntax

IntelMAS show [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Specifies that Read Only/Write Through Mode

-ReadOnlyWriteThrough information is requested.
No input required.

[-intelssd (Optional) Restricts output to specific Intel® SSD by

(Index|SerialNumber|PhysicalPath)] supplying the Intel® SSD Index or Serial Number.

Properties
Below are the properties that can be modified.
Property Description

Sets the select value

Valid values are:
• Current
Select
• Default
• Saved
• Capabilities

Document Number: 342245, Revision: 015US 39

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an NVMe* Intel® SSD.

This command is only supported on NVMe* devices that support the NVMe*
Cloud SSD Specification from the OCP.

Return Data
This command will parse and return human readable text of the specified
NVMe* get feature. Use the –output option to return the parsed data in
different formats.

3.1.13 Show NVMe Error Injection Information

The show -ErrorInjection command sends a get feature command with the
specified feature id (FID) for Intel® SSDs. Used to show error injection
information.

Only supported on NVMe* devices that support the NVMe* Cloud SSD
Specification from the OCP.

Syntax

IntelMAS show [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber|PhysicalPath) -ErrorInjection

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Specifies that Error Injection information is requested.

-ErrorInjection
No input required.

[-intelssd (Optional) Restricts output to specific Intel® SSD by

(Index|SerialNumber|PhysicalPath)] supplying the Intel® SSD Index or Serial Number.

Properties
No properties available for this feature

40 Document Number: 342245, Revision: 015US

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an NVMe* Intel® SSD.

This command is only supported on NVMe* devices that support the NVMe*
Cloud SSD Specification from the OCP.

Return Data
This command will parse and return human readable text of the specified
NVMe* get feature. Use the –output option to return the parsed data in
different formats.

Configure Intel® SSDs

Configuring SSDs requires the CLI verbs Load (Firmware Update), Set (Modify
Device), and
Start (Execute Drive Function).

3.2.1 Firmware Update

Updates the firmware on the Intel® SSD. On the next reset, the firmware will
become active.

Intel® MAS show devices (intelmas.exe show –intelssd) will indicate if there is
firmware update available. Run the load command to update the firmware.
Firmware update binaries are embedded in the tool. User doesn’t have to
provide firmware binary.

Note: Systems configured with the SATA Controller set to IDE mode are not
supported

Syntax

IntelMAS load [-force|-f] [-help|-h] [-output|-o (text|nvmxml|json)] -

intelssd (Index|SerialNumber||PhysicalPath)

Options
Option Description

Displays a prompt by default when invoking the Firmware Update

[-force|-f] command. Use this option to bypass the prompt.

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Document Number: 342245, Revision: 015US 41

Targets
Target Description

Updates the firmware on the specified Intel® SSD. Firmware

-intelssd binaries are embedded into the tool.
(Index|SerialNumber||PhysicalPath) See the FirmwareUpdateAvailable property for firmware
update eligibility.

Properties
This command does not support any properties.

Limitations
To run this command, you must have the appropriate host system privileges
and the specified Intel® SSDs must be manageable by the host software.

Return Data
The CLI indicates the status of the firmware update operation.

Sample Output

>IntelMAS.exe load –intelssd 0

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): y
Updating firmware...The selected Intel SSD contains current firmware as of
this tool release.

>IntelMAS.exe load –intelssd 0

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): n
Canceled.

>IntelMAS.exe load –f –intelssd 0

Updating firmware...
The selected Intel SSD contains current firmware as of this tool release.

>IntelMAS.exe load –intelssd 0

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): y
Updating firmware...
Firmware update successful.

Examples
Updates the firmware on the device at index 1.

IntelMAS load –intelssd 1

42 Document Number: 342245, Revision: 015US

3.2.2 Firmware Update (With Binary File)
This method is only to be used if firmware update binaries are available and
update is not available in the tool.

Use this method with caution and at your own risk as drive may become
unresponsive if invalid binary is loaded.

For NVMe* drives, user can also choose the following options:
• Commit Action to indicate when the firmware must be activated.
• Firmware Slot the firmware must be loaded into if drive supports multiple
slots.

Syntax

IntelMAS load –source firmwareBinaryFile.bin -intelssd

(Index|SerialNumber||PhysicalPath)

NVMe only:

IntelMAS load –source firmwareBinaryFile.bin -intelssd

(Index|SerialNumber||PhysicalPath) [FirmwareSlot=(0,1..7)]
CommitAction=(2,3)

Options
Option Description

Displays a prompt by default when invoking the Firmware Update

[-force|-f] command. Use this option to bypass the prompt.

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Updates the firmware on the specified Intel® SSD. Firmware

-intelssd binaries are embedded into the tool.
(Index|SerialNumber||PhysicalPath) See the FirmwareUpdateAvailable property for firmware update
eligibility.

-source Provide firmware binary for the update

[FirmwareSlot] Slot number that must be updated

Numberic data indicating Commit option according to NVMe*

[CommitAction] specification.

Properties
This command does not support any properties.

Document Number: 342245, Revision: 015US 43

Limitations
To run this command, you must have the appropriate host system privileges
and the specified Intel® SSDs must be manageable by the host software.

Return Data
The CLI indicates the status of the firmware update operation.

3.2.2.6.1 Sample Output

>IntelMAS.exe load –intelssd 0

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): y
Updating firmware...The selected Intel SSD contains current firmware as of
this tool release.

>IntelMAS.exe load –intelssd 0

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): n
Canceled.

>IntelMAS.exe load –f –intelssd 0

Updating firmware...
The selected Intel SSD contains current firmware as of this tool release.

>IntelMAS.exe load –intelssd 0

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): y
Updating firmware...
Firmware update successful.

Examples
Updates the firmware on the device at index 1.

IntelMAS load –intelssd 1

3.2.3 Modify Device

Changes the configurable settings on an Intel® SSD.

Note: You can only change one setting at a time.

Syntax

IntelMAS set [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber||PhysicalPath) [...]

44 Document Number: 342245, Revision: 015US

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Modifies the selected Intel® SSD by supplying its Index or Serial

-intelssd
Number value. An –intelssd must be specified for this
(Index|SerialNumber||PhysicalPath) command.

Document Number: 342245, Revision: 015US 45

Properties
Below are the properties that can be modified. One, and only one, property
must be specified.
Property Description

Resets the SMART attributes: E2, E3, and E4.

The Valid value is reset. As a result, the reported raw value of these attributes
EnduranceAnalyzer
will be 0xFFFF. Once the values have been reset, the device must go through a
60+ minute workload for the attributes to trip.

Enables or disables latency tracking feature. This must be enabled to

successfully read the latency statistics logs (Show Read and Write Latency
Statistics Tracking Information)
LatencyTrackingEnabled Valid values are:
• True – enables latency tracking.
• False – disables latency tracking.
Sets the device’s Maximum LBA value. This operation will overprovision the
drive. The MaximumLBA can be specified in the following ways:
• xGB - Sets the devices maximum LBA such that the total capacity is the
specified GB value. Value must be at least 1 and cannot exceed devices
total native capacity.
• X% - Sets the devices maximum LBA to the given percentage. Allowed
MaximumLBA
values are 1-100%. 100% equals native maximum LBA.
• LBA - Sets the devices maximum LBA value to the given LBA. Given value
must be a decimal literal. The LBA value must be at least XYZ and it cannot
exceed the native maximum LBA value.
• “native” - Sets the devices maximum LBA value back to its native
maximum.
Changes the devices power governor mode settings. Valid values are:
• 0: 25-watts for PCIe* NVMe* devices; 40W for PCIe* NVMe* x8 devices;
Unconstrained for SATA devices.
PowerGovernorMode • 1: 20-watts for PCIe* NVMe* devices 35W for PCIe* NVMe* x8 devices;
Typical (7-watts) for SATA devices.
• 2: 10-watts for PCIe* NVMe* devices; 25W for PCIe* NVMe* x8 devices;
Low (5-watts) for SATA devices.
(For NVMe* devices only) Sets the devices SM Bus Address for MI Basic
communication
SMBusAddress
Valid values are:
• 1-255. A value of 255 will disable SM Bus
(For NVMe* devices only) Sets the devices temperature threshold. Value is in
TempThreshold degrees Celsius. Valid values are:
• 0-75

Limitations
To run this command, you must have the appropriate host system privileges
and the specified Intel® SSD must be manageable by the host software.

Return Data
The CLI indicates the status of the operation.

46 Document Number: 342245, Revision: 015US

3.2.3.6.1 Sample Output

Set WriteCacheState successful.

Examples
Disables the write cache state of the Intel® SSD at index 0 by setting its
WriteCacheState to 3.

IntelMAS set –intelssd 0 WriteCacheState=3

3.2.4 Execute Device Function

Use the start verb to execute a function on the selected device.

Syntax

start [-help|-h] [-force|-f] [-output|-o (text|nvmxml|json)] –intelssd

(Index|SerialNumber||PhysicalPath) –selftest
[(‘short’|’extended’|’conveyance’)]

start [-help|-h] [-force|-f] [-output|-o (text|nvmxml|json)] –intelssd

(Index|SerialNumber||PhysicalPath) –nvmeformat [LBAFormat=(0-
NumLBAFormats)] [SecureEraseSetting=(0|1|2)] [ProtectionInformation=(0|1)]
[MetadataSettings=(0|1)]

Options
Option Description

[-help|-h] Displays help for the command.

Displays a prompt by default when invoking NVMe* Format

[-force|-f] functionality.
Use this option to bypass the prompt.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-intelssd A specific Intel® SSD selected by supplying the Intel® SSD

(Index|SerialNumber||PhysicalPath) Index or Serial Number must be provided.

Issues an NVMe* format to the selected drive. See the

-nvmeformat properties below for details on how to configure the NVMe*
format. To by-pass the prompt, specify the –force option.

Properties
Properties supported for the start verb are list as follows. Properties are specific to different targets.

Document Number: 342245, Revision: 015US 47

The properties: LBAFormat, SecureEraseSetting, ProtectionInformation, and
MetadataSettings are used with the –nvmeformat target.

The target that they correspond to is also listed in the Description.

Property Description

(-nvmeFormat) Sets a value that corresponds to one of the supported LBA

Formats described in Identify Namespace. If not provided, the tool will use the
LBAFormat current value of the selected Intel® SSD.
Valid values are:
• 0-NumLBAFormats: See NumLBAFormats Property for max value.
(-nvmeFormat) Specifies the setting for Secure Erase. If not provided, the tool
will use a value of 2.
Valid values are:
SecureEraseSetting
• 0: No secure erase.
• 1: User data erase.
• 2: Crypto erase.
(-nvmeFormat) Enables different protection information types. If not provided,
the tool will use the current value of the selected Intel® SSD.
ProtectionInformation Valid values are:
• 0: Protection information is not enabled.
• 1: Protection information type 1 is enabled.
(-nvmeFormat) Specifies how metadata is transferred. If not provided, the tool
will use the current value of the selected Intel® SSD
MetadataSettings Valid values are:
• 0: Metadata is transferred as part of a separate contiguous buffer.
• 1: Metadata is transferred as part of an extended data LBA.

Limitations
To run this command, you must have the appropriate host system privileges
and the specified Intel® SSD must be manageable by the host software.

48 Document Number: 342245, Revision: 015US

Return Data
The CLI returns the status of the command.

Examples
Issues NVMe* Format to the Intel® SSD at index 1 using the default values.

start –intelssd 1 -nvmeformat

Issues NVMe* Format to the Intel® SSD at index 1 and set the LBA Format to 3
and enable Type 1 protection information.

start –intelssd 1 -nvmeformat LBAFormat=3 ProtectionInformation=1

Issues an extended NVMe* DriveSelfTest to the Intel® SSD at index 1.

start –intelssd 1 -selftest extended

3.2.5 Delete Device

Delete Intel® SSD will erase all the data on the drive. For NVMe* devices, this
will issue an NVMe* Format command with SecureEraseSetting = 2. The
function will keep the drive’s current configuration.

When invoked, the tool will prompt you to proceed with the delete. To bypass
the prompt, use the –force option.

Syntax

delete [-help|-h] [-force|-f] [-output|-o (text|nvmxml|json)] –intelssd

(Index|SerialNumber||PhysicalPath)

Options
Option Description

[-help|-h] Displays help for the command.

The tool will display a prompt by default when invoking delete. Use
[-force|-f]] this option to bypass the prompt. This option will also ignore partitions
on the device.

[-output|-o (text | nvmxml | Change the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Document Number: 342245, Revision: 015US 49

Targets
Target Description

-intelssd
Delete the selected Intel® SSD Device and erase all data.
(Index|SerialNumber||PhysicalPath)

Properties
This command does not support any properties.

Limitations
To successfully execute this command, the caller must have the appropriate
privileges and the specified Intel® SSD must be manageable by the host
software.

Return Data
The CLI will return status of the command.

Examples
Delete the device at index 1 and erase all user data.

delete –intelssd 1

3.2.6 NVMe Format

Syntax

start [-help|-h] [-force|-f] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber||PhysicalPath) -nvmeformat [-namespace (namespace id)]
[LBAFormat = (0-NumLBAFormats)] [SecureEraseSetting = (0|1|2)]
[ProtectionInformation = (0|1)] [MetadataSettings = (0|1)]

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Change the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-intelssd (Required) A specific Intel® SSD selected by supplying the

(Index|SerialNumber||PhysicalPath) Intel® SSD Index or Serial Number must be provided.

50 Document Number: 342245, Revision: 015US

3.2.7 Set NVMe Feature
The set –setfeature command sends a set feature command with the
specified feature id (FID) for Intel® SSDs. Only supported on NVMe* devices.

Syntax

IntelMAS set [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber|PhysicalPath) -setfeature (feature id) [-namespace
(namespace id)] DWORD11 = (32 bit hex) [DWORD12 = (32 bit hex)] [DWORD13 =
(32 bit hex)]

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Specify the feature id (FID) of the NVMe* set

feature command
Examples of valid input would be
• 0x1 - Arbitration
• 0x2 - Power Management
• 0x4 - Temp Threshold
-setfeature (feature id) • 0x5 - Error Recovery
• 0x6 - Volatile Write Cache
• 0x7 - Number of Queues
• 0x8 - Interrupt Coalescing
• 0x9 - Interrupt Vector Config
• 0xA - Write Atomicity
• 0xB - Event Config
[-intelssd (Optional) Restricts output to specific Intel® SSD by
(Index|SerialNumber|PhysicalPath)] supplying the Intel® SSD Index or Serial Number.

Namespace target is optional. Must specify

-namespace (namespace Id) namespace ID if being used.

Properties
Below are the properties that can be modified.
Property Description

32-bit command dword 11 structure value that is used to set the chosen feature value. See Set
DWORD11 Features Command specification in NVMe* 1.4 spec (section 5.21) for details.

DWORD12 32-bit command dword 12 structure value.

DWORD13 32-bit command dword 13 structure value.

Document Number: 342245, Revision: 015US 51

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an Intel NVMe SSD.

The command is entirely dependent on valid feature id values. Different drive

families will support different feature ids.

Return Data
This command will send and return the status of the NVMe* set feature. There
is usually a corresponding get feature command (see get feature).

3.2.8 Set NVMe* IEEE* 1667 Silo

The set –IEEESilo command sends a set feature command with the specified
feature id (FID) for Intel® SSDs. Used to set IEEE* 16667 Silo information.

Only supported on NVMe* devices that support the NVMe* Cloud SSD
Specification from the OCP.

Syntax:

IntelMAS set [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber|PhysicalPath) -IEEESilo Enable =
('true'|'false')Options

Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Specifies that IEEE* 16667 Silo is requested.

-IEEESilo
No input required.

[-intelssd (Optional) Restricts output to specific Intel® SSD by

(Index|SerialNumber|PhysicalPath)] supplying the Intel® SSD Index or Serial Number.

Properties
Below are the properties that can be modified.
Property Description

Enable True to enable, false to disable.

52 Document Number: 342245, Revision: 015US

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an NVMe* Intel® SSD.

This command is only supported on NVMe* devices that support the NVMe*
Cloud SSD Specification from the OCP.

Return Data
This command will send and return the status of the NVMe* set IEEE* 16667
Silo. See the next section for the corresponding get feature:

Show NVMe* IEEE* 16667 Silo Information

Examples

> IntelMAS set -intelssd 1 -IEEESilo Enable=True

Set Enable successful. Completed successfully.

3.2.9 Set NVMe* Read Only/Write Through Mode

The set –ReadOnlyWriteThrough command sends a set feature command
with the specified feature id (FID) for Intel® SSDs. Used to set read only or
write through mode as the desired device transition and end of life.

Only supported on NVMe* devices that support the NVMe* Cloud SSD
Specification from the OCP.

Syntax:

IntelMAS set [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber|PhysicalPath) -ReadOnlyWriteThrough Mode = (1|2)

Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Specifies that Read Only/Write Through mode is

-ReadOnlyWriteThrough requested.
No input required.

[-intelssd (Optional) Restricts output to specific Intel® SSD by

(Index|SerialNumber|PhysicalPath)] supplying the Intel® SSD Index or Serial Number.

Document Number: 342245, Revision: 015US 53

Properties
Below are the properties that can be modified.
Property Description

1 to transition to read only mode, 2 to transition to

Mode
write through mode.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an Intel® NVMe* SSD.

This command is only supported on NVMe* devices that support the NVMe*
Cloud SSD Specification from the OCP.

Return Data
This command will send and return the status of the NVMe* set Read
Only/Write Through mode. See the following section for the corresponding get
feature:

Show Read Only/Write Through

Examples

> IntelMAS set -intelssd 1 -ReadOnlyWriteThrough Mode=1

Set Mode successful. Completed successfully.

3.2.10 Set NVMe* Error Injection

The set -ErrorInjection command sends a set feature command with the
specified feature id (FID) for Intel® SSDs. Used to forcibly inject errors into the
device.

Only supported on NVMe* devices that support the NVMe* Cloud SSD
Specification from the OCP.

Syntax:

set [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber|PhysicalPath) -ErrorInjection

[ErrorInjectionEntries = ((tilde separated entry list))]

[ErrorInjectionEntryFile = (path to input file)]

ShowErrorInjection:

show [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber|PhysicalPath) -ErrorInjection

54 Document Number: 342245, Revision: 015US

Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Specifies that error injection set feature is requested.

-ErrorInjection
No input required.

[-intelssd (Optional) Restricts output to specific Intel® SSD by supplying

(Index|SerialNumber|PhysicalPath)] the Intel® SSD Index or Serial Number.

Properties
Below are the properties that can be modified.
Property Description

A tilde separated list of error injection entries. See the OCP NVMe* Cloud SSD
Specification for more details.

Note: Each entry shall be formatted in a specific way. Each item in the entry
is separated by a period (.). The general format is as follows:
• First item is the injection enable attribute (0 or 1)
• The second item is the single instance attribute (0 or 1)
• The third item is the error injection type (always interpreted as hex value)
ErrorInjectionEntries • The fourth entry is a 27-byte hex value indicating the type specific data. A
user doesn’t have to specify all 27-bytes. If less than 27-bytes are
specified, then 0’s are prepended.

Example:
ErrorInjectionEntries= 1.0.0x3.0x44~0.1.0x12.0x3D~1.1.0x3.0xA16E

Note: ErrorInjectionEntries properties and ErrorInjectionEntryFile are

mutually exclusive.

Specifies an XML file that contains the error injection info data. This option
serves to streamline the injection formatting (which is cumbersome).
ErrorInjectionEntryFile
Note: ErrorInjectionEntries properties and ErrorInjectionEntryFile are
mutually exclusive.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an NVMe* Intel® SSD.

This command is only supported on NVMe* devices that support the NVMe*
Cloud SSD Specification from the OCP.

Document Number: 342245, Revision: 015US 55

Return Data
This command will send and return the status of the NVMe* set error
injections. See the following section for the corresponding get feature:

Show Error Injection

Examples

> C:\Users\remlab>IntelMAS set -intelssd 1 -ErrorInjection

ErrorInjectionEntryFile=errorinjection.xml

Completed successfully.

> C:\Users\remlab>IntelMAS set -intelssd 1 -ErrorInjection >

C:\Users\remlab>IntelMAS set -intelssd 1 -ErrorInjection
ErrorInjectionEntries=1.0.0x3.0x44~0.1.0x12.0x3D~1.1.0x3.0xA16E

Completed successfully.

3.2.11 Clear PCIe* Correctable

The set -PCIeCorrectable command sends a set feature command with the
specified feature id (FID) for Intel® SSDs. Used to clear the PCIe* correctable
counter.

Only supported on NVMe* devices that support the NVMe* Cloud SSD
Specification from the OCP.

Syntax:

IntelMAS set [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd

(Index|SerialNumber|PhysicalPath) -PCIeCorrectable ClearCounter = ((true))

Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

Specifies that clear PCIe correctable counter is

-PCIeCorrectable requested.
No input required.

[-intelssd (Optional) Restricts output to specific Intel® SSD by

(Index|SerialNumber|PhysicalPath)] supplying the Intel® SSD Index or Serial Number.

56 Document Number: 342245, Revision: 015US

Properties
Below are the properties that can be modified.
Property Description

ClearCounter Set to ‘true’ to clear the counter.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software. The specified device must be an NVMe* Intel® SSD.

This command is only supported on NVMe* devices that support the NVMe*
Cloud SSD Specification from the OCP.

Return Data
This command will send and return the status of the NVMe* clear PCIe*
correctable counter. Examples

> IntelMAS set -intelssd 1 -PCIeCorrectable ClearCounter=True

Set ClearCounter successful. Completed successfully.

3.2.12 Drive Scan

Scan the drive for Data Integrity, Read Scans, or Logs.

Note: Log scan output will be saved to the output/TIME_STAMP directory relative to
the directory in which the command was run unless overridden by the
DirectoryPath property.

Syntax

start [-help|-h] [-output|-o (text|nvmxml|json)] -scan

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Change the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Document Number: 342245, Revision: 015US 57

Targets
Target Description

-intelssd (Required) A specific Intel® SSD selected by supplying the

(Index|SerialNumber||PhysicalPath) Intel® SSD Index or Serial Number must be provided.
-scan (Required) Command to scan information on the drive.
[(DataIntegrity|ReadScan|Logs)] Options:
DataIntegrity
ReadScan
Logs

Properties
Property Description

[IncludeOS = (true|false)] (Optional) Scan OS partition and/or drive as part of scan.

[FullScan = (true|false)] (Optional) Must the command perform Full or Quick scan.

(Optional) Path to drive partition to scan. Only applicable for

[Path = ((drive letter))] DataIntegrity

(Optional) Specify path where drive and system logs must be

[DirectoryPath = ((file path))] saved Default is “output/” in current directory.
[IncludeSystemInfo = (Optional) Must system information be included in the scan.
(true|false)]

Limitations
To successfully execute this command, the caller must have the appropriate
privileges and the specified Intel® SSD must be manageable by the host
software.

Return Data
This will return status of the command.

3.2.13 Read System Snapshot

Read the system snapshot from the device and save it to a binary file.

Syntax

Dump [-help|-h] [-destination (path)] [-output|-o (text|nvmxml|json)] -

intelssd (Index|SerialNumber|PhysicalPath) -SystemSnapshot

Options
Option Description

[-help|-h] Displays help for the command.

[-destination (path)] Specify an alternate destination and file name for the output file.

58 Document Number: 342245, Revision: 015US

Option Description

[-output|-o (text | nvmxml | Change the format of the Return Data. Supported output options
json)] are: ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-intelssd (Required) A specific Intel® SSD selected by supplying the Intel®

(Index|SerialNumber||PhysicalPath) SSD Index or Serial Number must be provided.

-SystemSnapshot (Required) Read the System Snapshot from the device.

Properties
No properties are applicable for this command.

Limitations
To successfully execute this command, the caller must have the appropriate
privileges and the specified Intel® SSD must be manageable by the host
software.

Return Data
This will return status of the command.

Examples

> IntelMAS dump -intelssd 1 -systemsnapshot

SystemSnapshot_SerialNumber : Successfully written SystemSnapshot to

SystemSnapshot_SerialNumber.bin

Configure Namespaces

3.3.1 Create a Namespace

Create a namespace. Supported on NVMe* 1.2+ devices. The NVMe* controller
of the device will determine the Namespace ID of the newly created
namespace.

Syntax

create [-help|-h] [-output|-o (text|nvmxml|json)] -namespace -intelssd

(Index|SerialNumber||PhysicalPath) Size = (blocks) [LBAFormat = (0-
NumLBAFormats)] [ProtectionInformation = (0|1)] [MultiPathIoCapabilities =
(0|1)]

Document Number: 342245, Revision: 015US 59

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Change the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-intelssd A specific Intel® SSD selected by supplying the Intel® SSD Index
(Index|SerialNumber||PhysicalPath) or Serial Number must be provided.

The -namespace target is required. It specifies that a namespace

-namespace is to be created.

Properties
Properties Description

The size property is required. It specifies the size of the new namespace
Size = (blocks) in terms of blocks.

The LBAFormat property is optional. By default, an LBAFormat of 0 will

be used. Valid options are 0 to Number of supported LBA Formats
specified in the Identify Controller structure. See the NumLBAFormats
[LBAFormat = (0-NumLBAFormats)] from show -intelssd. The main thing this value determines is the
formatted sector size.
Note: you cannot have different namespaces with different LBA sector
sizes.

The ProtectionInformation property is optional. By default a value of 0

[ProtectionInformation = (0|1)] will be used. 0 = protection information is disabled. 1 = protection
information type 1 is used.

The MultiPathIoCapabilities property is optional. By default a value of 1

[MultiPathIoCapabilities =
will be used. 0 = Private namespace is created. 1 = shared namespace is
(0|1)] created.

Limitations
To successfully execute this command, the caller must have the appropriate
privileges and the specified Intel® SSD must be manageable by the host
software.

Return Data
The CLI will return status of the command.

3.3.2 Attach a Namespace

Attach a namespace. May specify an NVMe* controller ID using the -
nvmecontrollerid target. Supported on NVMe* 1.2+ devices.

60 Document Number: 342245, Revision: 015US

Syntax

attach [-help|-h] [-output|-o (text|nvmxml|json)] -namespace (id) -

intelssd (Index|SerialNumber||PhysicalPath) [-nvmecontroller (controller
ID integer)]

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Change the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-intelssd A specific Intel® SSD selected by supplying the Intel® SSD Index
(Index|SerialNumber||PhysicalPath) or Serial Number must be provided.

The -namespace target is required and a valid namespace ID. It

-namespace (id) specifies that a namespace is to be attached.

The -nvmecontroller target is optional. If used, a valid controller

[-nvmecontroller (controller ID
ID must be given. Used in the case of dual port drives in which a
integer)] device may have more than one NVMe* controller.

Properties
This command does not support any properties.

Limitations
To successfully execute this command, the caller must have the appropriate
privileges and the specified Intel® SSD must be manageable by the host
software.

Return Data
The CLI will return status of the command.

3.3.3 Detach a Namespace

Detach a namespace. Supported on NVMe* 1.2+ devices.

Syntax

detach [-help|-h] [-output|-o (text|nvmxml|json)] -namespace (id) -

intelssd (Index|SerialNumber||PhysicalPath) [-nvmecontroller (controller
ID integer)]

Document Number: 342245, Revision: 015US 61

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Change the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-intelssd (Required) A specific Intel® SSD selected by supplying the Intel®

(Index|SerialNumber||PhysicalPath) SSD Index or Serial Number must be provided.

(Required) The -namespace target is required and a valid

-namespace (id) namespace ID. It specifies that a namespace is to be detached.

The -nvmecontroller target is optional. If used, a valid controller

[-nvmecontroller (controller ID ID must be given. Used in the case of dual port drives in which a
integer)] device may have more than one NVMe* controller.

Properties
This command does not support any properties.

Limitations
To successfully execute this command, the caller must have the appropriate
privileges and the specified Intel® SSD must be manageable by the host
software.

Return Data
The CLI will return status of the command.

3.3.4 Delete a Namespace

Delete a namespace. Supported on NVMe* 1.2+ devices.

Syntax

delete [-help|-h] [-force|-f] [-output|-o (text|nvmxml|json)] -namespace

(id) -intelssd (Index|SerialNumber||PhysicalPath)

Options
Option Description

[-help|-h] Displays help for the command.

The tool will display a prompt by default when invoking delete. Use this
[-force|-f]] option to bypass the prompt. This option will also ignore partitions on
the device.

62 Document Number: 342245, Revision: 015US

Option Description

[-output|-o (text | nvmxml | Change the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-intelssd (Required) A specific Intel® SSD selected by supplying the Intel®

(Index|SerialNumber||PhysicalPath) SSD Index or Serial Number must be provided.

The -namespace target is required, and a valid namespace id

-namespace (id) must be provided. This selects which namespace to delete.

Properties
This command does not support any properties.

Limitations
To successfully execute this command, the caller must have the appropriate
privileges and the specified Intel® SSD must be manageable by the host
software.

RedHat* and CentOS*: Kernel bug can cause deadlock on delete namespace in
RHEL*/CentOS* 8.2

Return Data
The CLI will return status of the command.

Instrumentation Commands

3.4.1 Show Tool Configuration

Show tool configuration properties.

Syntax

IntelMAS show [-all|-a] [-display|-d] [-help|-h] [-output|-o

(text|nvmxml|json)] -system

Options
Option Description

[-all|-a] Show all properties.

Filters the returned properties by explicitly specifying a comma

[-display|-d] separated list of any of the properties defined in the Return Data
section.

Document Number: 342245, Revision: 015US 63

Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-system Represents the host system. This target has no parameters.

Properties
This command option does not support any properties.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software.

Return Data
The command displays the following Tool configuration properties. This output
could be filtered by specifying the Properties with the –display option.
Property Description

True or False. Whether or not the LSIAdapter library is loaded. This affects
EnableLSIAdapter LSI Mega RAID Controller Support.
(Default value is False)

True or False. Whether or not to save the Tool’s debug log file.
EnableLog
(Default value is False)

Filename of the Tool’s debug log file. Only saved if EnableLog is true. Can
contain full qualified file system path.
LogFile Log location:
Windows: c:\Program Files(x86)\Intel\
Linux: /usr/bin/IntelSSDDataCenterTool/TDKI.log

Examples
Default show output for –system target in default text format.

>IntelMAS.exe show –system

- IntelMAS Config -
EnableLSIAdapter: false
EnableLog: false
LogFile: C:\Intel\log\TDKI.log

64 Document Number: 342245, Revision: 015US

3.4.2 Modify Tool Configuration
Change the Tool’s configurable settings on the host system. You can only
change one setting at a time.

Syntax

IntelMAS set [-help|-h] [-output|-o (text|nvmxml|json)] –system

[Property=]

Options
Option Description

[-help|-h] Displays help for the command.

Changes the format of the Return Data. Supported output options are:
[-output|-o (text | nvmxml | json)]
‘text’ (Default), “json”, and ‘nvmxml’.

Targets
Target Description

-system Represents the host system. This target has no parameters.

Properties
One, and only one, property can be specified at a time.
Property Description

Enable or disable the loading of the LSI Adapter library. Supported values are “True” and
EnableLSIAdapter “False”

Enable or disable the Tool from saving a debug log file. Supported values are “True” and
EnableLog “False”

Specify the filename (and path if desired) of the Debug log file. Debug log is only saved if
LogFile EnableLog=True and LogFile is a valid file name and path.

Limitations
To run this command option, the specified Intel® SSDs must be manageable by
the host software.

Return Data
The CLI will indicate the status of the operation.

Sample Output:

Set EnableLog successful.

Document Number: 342245, Revision: 015US 65

Examples

set –system EnableLog=True

Enable the tool’s debug log file.

set –system LogFile=myNewLogFile.txt

Set the tool’s debug log file. If no path is given the file will be saved in the
working directory.

set –system EnableLSIAdapter=False

Disable the loading of the LSIAdapter library.

3.4.3 Dump Device Data

This command will read binary data from the device and save it to a file. This
feature currently supports dumping:
• nLog
• Event Log
• Assert Log
• Telemetry Log

Syntax

dump[-help|-h] [–destination (filename)] [-output|-o (text|nvmxml|json)]

[-intelssd (Index|SerialNumber|PhysicalPath)] -nlog

dump[-help|-h] [–destination (filename)] [-output|-o (text|nvmxml|json)]

[-intelssd (Index|SerialNumber|PhysicalPath)] -eventlog

dump[-help|-h] [–destination (filename)] [-output|-o (text|nvmxml|json)]

[-intelssd (Index|SerialNumber|PhysicalPath)] -assertlog

dump -destination <output binary> -intelssd <index|serial|physicalpath> -

telemetrylog

dump[-help|-h] [–destination (filename)] [-output|-o (text|nvmxml|json)]

[-intelssd (Index|SerialNumber|PhysicalPath)] -persistenteventlog
(‘read’|’release’) [NewContext = [(‘true’|’false’)]]

Options
Option Description

[-help|-h] Displays help for the command.

66 Document Number: 342245, Revision: 015US

Option Description

Specifies a filename to save the dump data to.

[-destination (filename)] If -destination option is not given, default filename is assigned based on
target and drive serial number.

Changes the format of the Return Data. Supported output options are:
[-output|-o (text | nvmxml |
‘text’ (Default), “json”, and ‘nvmxml’. This option does not affect the
json)] output in the binary file.

Targets
Target Description

-intelssd Dump the selected data from the given Intel® SSD.
(Index|SerialNumber|PhysicalPath)
-nlog Read the nlog binary data from the device and save it to binary file.

Read the event log binary data from the device and save it to
-eventlog binary file.

Read the Assert log binary data from the device and save it to
-assertlog binary file.

Read the telemetry log binary data from the device and save it to
-telemetrylog binary file

-persistenteventlog Read the persistent event log binary data from the current context,
(‘read’|’release’) create a new context, or release the current context

Properties
This command does not support any properties.

Limitations
To run this command, the specified Intel® SSD must be manageable by the
host software.

Telemetry is only available on selected drives.

Return Data
Binary data is saved to default file destination or if –destination option is
given, output will be saved to given filename. Status of reading the binary data
from the selected device, and saving it to file, is returned.

Examples
Extract Telemetry log to file telelmetry_data.bin

IntelMAS.exe dump -destination telemetry_data.bin -intelssd 1 -

telemetrylog

Read Persistent event log data from the current context

Document Number: 342245, Revision: 015US 67

IntelMAS.exe dump -destination PEL_data.bin -intelssd 1 -
persistenteventlog read

Establish a new persistent event log context and read from it

IntelMAS.exe dump -destination PEL_data.bin -intelssd 1 -

persistenteventlog read NewContext = true

Release the current persistent event log context (does not read or output any
data)

IntelMAS.exe dump -destination PEL_data.bin -intelssd 1 -

persistenteventlog release

Support Commands
Support commands consist of Help and Version.

3.5.1 Help Command

Shows help for the supported commands.

Syntax

IntelMAS help [-help|-h] [-output|-o (text|nvmxml|json)] [Verb=(verb)]

[Name=(command)]

Options
Option Description

[-help|-h] Displays help for the command.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options are: ‘text’
json)] (Default), “json”, and ‘nvmxml’.

Targets
This command does not support any targets.

68 Document Number: 342245, Revision: 015US

Properties
Property Default Description

Filters help to a specific verb. One of:

• delete
• dump
• help
Verb All Verbs • load
• set
• show
• start
• version
Name All commands Filters help to a specific command by name.

Return Data
By default, the command displays an introduction to Intel® MAS followed by a
list of the supported commands. When the command list can be filtered to just
one command, detailed information is displayed. When the command list
includes more than one command, only the command name and synopsis are
displayed.

3.5.1.5.1 Sample Output (Multiple Commands)

Note: Not all commands are displayed. This is just to view how the output appears.

>IntelMAS.exe help
Usage: IntelMAS.exe <verb>[<options>][<targets>][<properties>]

Commands:

Help:
help [-help|-h] [-output|-o (text|nvmxml|json)] [Name = (name)] [verb =
(verb)]

EnduranceAnalyzer:
set [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd
(Index|SerialNumber||PhysicalPath) EnduranceAnalyzer = ('reset')

MaximumLBA:
set [-help|-h] [-output|-o (text|nvmxml|json)] -intelssd
(Index|SerialNumber||PhysicalPath) MaximumLBA = (numGB|1-
100%|LBA|'native')

FirmwareUpdate:
load [-help|-h] [-force|-f] [-output|-o (text|nvmxml|json)] -intelssd
(Index|SerialNumber||PhysicalPath)

Document Number: 342245, Revision: 015US 69

[(Index|SerialNumber|PhysicalPath)]]

[(Index|SerialNumber|PhysicalPath)]]

[(Index|SerialNumber|PhysicalPath)]]

[('ErrorInfo'|'SmartHealthInfo'|'FirmwareSlotInfo'|'TemperatureStatistics'
)]

Delete:
delete [-help|-h] [-force|-f] [-output|-o (text|nvmxml|json)] -intelssd
(Index|SerialNumber||PhysicalPath)

3.5.1.5.2 Sample Output (verb filter to multiple commands)

Specifying the verb property filters the list to only the commands starting with
the specified verb.

IntelMAS.exe help verb=show

Usage: IntelMAS.exe <verb>[<options>][<targets>][<properties>]

Commands:

[(Index|SerialNumber|PhysicalPath)]]

[(Index|SerialNumber|PhysicalPath)]]

70 Document Number: 342245, Revision: 015US

[(Index|SerialNumber|PhysicalPath)]]

[('ErrorInfo'|'SmartHealthInfo'|'FirmwareSlotInfo'|'TemperatureStatistics'
)]

[-nvmecontroller] [-intelssd [(Index|SerialNumber|PhysicalPath)]]

NVMeControllerList:
show [-help|-h] [-output|-o (text|nvmxml|json)] [-namespace (namespace
id)] -nvmecontroller [-intelssd

[(Index|SerialNumber|PhysicalPath)]]

3.5.1.5.1 Sample Output (single command)

Specifying the Name property filters the list to a specific command and detailed
information is returned.

IntelMAS.exe help Name=Firmware

Name: FirmwareUpdate

Description:
Update the device's firmware. See the device's FirmwareUpdateAvailable
property for any eligible updates. To by-pass the prompt specify the -
force option.

Synopsis:
load [-help|-h] [-force|-f] [-output|-o (text|nvmxml|json)] -intelssd
(Index|SerialNumber||PhysicalPath)

Verb:
load

Options:
[-help|-h] -- Display help for the command.

[-force|-f] -- Force the operation

Document Number: 342245, Revision: 015US 71

[-output|-o (text|nvmxml|json)] -- Change the output format. One of
"text", "nvmxml" or "json".

Targets:
-intelssd (Index|SerialNumber||PhysicalPath) -- Device index or serial
number is required.

Properties:

Examples
Lists all supported commands

IntelMAS help

Lists all commands where the verb is set

IntelMAS help verb=show

Lists the detailed help for the given Name WriteCacheState

IntelMAS help Name=WriteCacheState

3.5.2 Version Command

Shows the Intel® MAS version and End-User License.

Syntax

IntelMAS version [-help|-h] [-display|-d] [-all|-a] [-output|-o

(text|nvmxml|json)]

Options
Option Description

[-help|-h] Displays help for the command.

Filters the returned properties by explicitly specifying a comma separated

[-display|-d] list of any of the properties defined in the Return Data section.

[-output|-o (text | nvmxml | Changes the format of the Return Data. Supported output options are:
json)] ‘text’ (Default), “json”, and ‘nvmxml’.

Targets
This command does not support any targets.

72 Document Number: 342245, Revision: 015US

Properties
This command does not support any properties.

Return Data
By default, the command returns the Intel® MAS version information. With the
–display option, it shows the License property.
Property Description

License Shows the End-User License for the Intel® MAS.

3.5.2.5.1 Sample Output

Default output in text.

> IntelMAS.exe version

- Version Information -

Name: Intel(R) Intel® Memory and Storage Tool

Version: 3.0.0
Description: Interact and configure Intel SSDs.

Default output in JSON.

> IntelMAS.exe version –o json

{

"Version Information":
{
"Name":"Intel(R) Intel® Memory and Storage Too",
"Version":"3.0.0",
"Description":"Interact and configure Intel SSDs."
}
}

Examples
Display the available version information for the Intel® MAS software.

version

Display the End-User License for the Intel® MAS software components.

version –d license

Document Number: 342245, Revision: 015US 73

Debug

3.6.1 Tool Debug File

The Intel® MAS saves appends to a debug file that contains detailed
information on the tool execution. This file is very useful for the Tool
Developers when having to debug issues. Whenever requesting assistance from
the Tools team on a potential issue with the tool this file will be requested. See
Show Tool Configuration and Modify Tool Configuration for more information on
enabling the debug log.

74 Document Number: 342245, Revision: 015US

4 Response Codes
The following table lists all the possible error and status codes that are
returned from the Intel® MAS. The first column lists the numeric value of the
error/status code returned by the tool. In Windows*, to display the numeric
return value, type the following at the command prompt after running the tool:

>echo %errorlevel%

Code Description

0 Completed successfully.

1 Failed to load the Intel TDK Interface library.

2 An error occurred with interacting with the TDK Interface Library.

3 An error was returned from the TDK Interface when executing the given CLI functionality.

4 Encountered a read file error.

5 Encountered a write file error.

6 Invalid Boolean values were given.

7 Invalid property given.

8 Invalid CLI argument given.

Document Number: 342245, Revision: 015US 75

5 Examples
Display Tool Help
Use help command line option to display the help table.

IntelMAS.exe help

Display Tool License

Use the version command with the license property to display the End-User
license agreement for Intel® MAS.

IntelMAS.exe version –d license

Display Drives
Use the show command to display a list of drives on the system.

IntelMAS.exe show –intelssd

Bypass Prompts (force)

Use the force option to bypass the warning prompts associated with load and
start commands.

Debug Log Files

The tool generates a detailed log of the tool’s functionality that you can use for
debugging purposes and send out for further analysis of tool issues. See Debug
section.

Display Drive Info

Use the show command’s –intelssd option to select which drive to execute
functions on and provides a simple summary of each drive found. Use the
show command’s –a –intelssd 1 option to display a verbose output of all the
information the tool can get on that particular drive.

IntelMAS.exe show –a -intelssd 1

76 Document Number: 342245, Revision: 015US

Identify Device
Use the show verb along with the –identify target to read and parse identify
information. See Show Device Identification Structures for details.

Note: Identify device contains a large amount of data and the console window may
not be large enough to display it in a readable format.

IntelMAS.exe show –identify –intelssd 1

IntelMAS.exe show –identify –intelssd 1 -nvmecontroller

Sensor or SMART Data

Use the -sensor command to read and parse the Health Sensors. Use the –
smart command to read and parse the SMART attribute information of the
selected drive.

Show all the sensor information for all Intel® SSDs

IntelMAS.exe show –sensor

Show all the SMART properties for the Intel® SSD at index 1.

IntelMAS.exe show –smart –intelssd 1

Delete
Use the Delete command to erase all the data on the drive.

IntelMAS.exe delete –intelssd 1

You will be prompted unless using the –force option.

WARNING: You have selected to delete the drive!

Proceed with the delete? (Y/N)

To bypass the warning prompts, use the –force option.

IntelMAS.exe delete –f –intelssd 1

Change Maximum LBA

Use the MaximumLBA property to change the drive’s maximum storage capacity
up to the native capacity of the drive (that is, MAX LBA).

Document Number: 342245, Revision: 015US 77

Note: Always run the delete command before altering the Maximum LBA of a drive.
After modifying the maximum LBA, you must perform a complete power
shutdown to properly reflect the changes.

The MaximumLBA property has four options:

The native option resets the drive back to its native Max LBA, or 100% of the
drive.

IntelMAS.exe set –intelssd 1 MaximumLBA=native

The LBA option specifies the drive’s max LBA with a specific number. The
number entered must be a decimal literal.

This example sets the drive’s Max LBA to 55555:

IntelMAS.exe set –intelssd 1 MaximumLBA=55555

The x% percent changes the drive’s size based on a percentage of native max.
Values of 1-100 are valid, where a value of 100 is equivalent to using the
native option.

IntelMAS.exe set –intelssd 1 MaximumLBA=80%

The xGB capacity option sets the drive to a specific capacity in gigabytes. This
will result in an error if the given number of gigabytes is less than 1 or is
greater than the drive’s max capacity.

IntelMAS.exe set –intelssd 1 MaximumLBA=80GB

Update Firmware
Firmware Update is achieved through the load command verb and is used to
update the firmware of the selected drive:

IntelMAS.exe load -intelssd 1

The Intel® MAS handles both updates using Windows* process or Linux*
process.

Full Windows* Process: The tool handles both updates automatically. For
example:

IntelMAS.exe show –intelssd 1

- IntelSSD Index 1 –
Bootloader: 8B1B012E
DevicePath: \\\\.\\PHYSICALDRIVE1
DeviceStatus: Healthy

78 Document Number: 342245, Revision: 015US

Firmware: 8DV10131
FirmwareUpdateAvailable: Firmware=8DV10151 Bootloader=8B1B012F
Index: 1
ProductFamily: Intel SSD DC P3700 Series
ModelNumber: INTEL SSDPEDMD800G4
SerialNumber: CVFT4174002A800CGN

IntelMAS.exe load –intelssd 1

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): y
Updating firmware…
Firmware update successful. Please reboot the system.

IntelMAS.exe show –intelssd 1

- IntelSSD Index 1 -
Bootloader: 8B1B012F
DevicePath: \\\\.\\PHYSICALDRIVE1
DeviceStatus: Healthy
Firmware: 8DV10151
FirmwareUpdateAvailable: Firmware is up to date as of this tool release.
Index: 1
ProductFamily: Intel SSD DC P3700 Series
ModelNumber: INTEL SSDPEDMD800G4
SerialNumber: CVFT4174002A800CGN

Linux* Process: user must call the “load” function twice with a system
shutdown and reboot in between.

First update:

IntelMAS show –intelssd

- IntelSSD Index 0 –
Bootloader: 8B1B012E
DevicePath: /dev/nvme0n1
DeviceStatus: Healthy
Firmware: 8DV10131
FirmwareUpdateAvailable: Firmware=8DV10151
Index: 0
ProductFamily: Intel SSD DC P3700 Series
ModelNumber: INTEL SSDPEDMD800G4
SerialNumber: CVFT4174002A800CGN

[root@linuxul2br remlab]# IntelMAS load –intelssd 0

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): y
Updating firmware…
Firmware update successful. Please reboot the system.
[root@linuxul2br remlab]#

The user then shuts down the system and reboots.

In the second update, the tool shows the next update to the BL12E and FW 131
combined package:

IntelMAS show –intelssd

- IntelSSD Index 0 –
Bootloader: 8B1B012E

Document Number: 342245, Revision: 015US 79

DevicePath: /dev/nvme0n1
DeviceStatus: Healthy
Firmware: 8DV10131
FirmwareUpdateAvailable: Firmware=8DV10151 Bootloader=8B1B012F
Index: 0
ProductFamily: Intel SSD DC P3700 Series
ModelNumber: INTEL SSDPEDMD800G4
SerialNumber: CVFT4174002A800CGN

[root@linuxul2br remlab]# IntelMAS load –intelssd 0

WARNING! You have selected to update the drives firmware!
Proceed with the update? (Y|N): y
Updating firmware…
Firmware update successful. Please reboot the system.
[root@linuxul2br remlab]#

The user shuts down the system and reboots.

IntelMAS show –intelssd

- IntelSSD Index 0 –
Bootloader: 8B1B012F
DevicePath: /dev/nvme0n1
DeviceStatus: Healthy
Firmware: 8DV10151
FirmwareUpdateAvailable: Firmware is up to date as of this tool release
Index: 0
ProductFamily: Intel SSD DC P3700 Series
ModelNumber: INTEL SSDPEDMD800G4
SerialNumber: CVFT4174002A800CGN

Endurance Analyzer
Use the enduranceanalyzer property to calculate the life expectancy of the
drive’s media based on a user workload. Please note that this feature
specifically measures the expected lifetime of the media, not the overall
expected lifetime of the drive.

The steps are:

1. Reset SMART Attributes using the reset option.

IntelMAS.exe set –intelssd 2 enduranceanalyzer=reset

2. Optionally, remove the SSD and install in test system.

3. Apply minimum 60-minute workload to SSD.
4. Reinstall SSD in original system if needed. Compute endurance using the
show command. You can also specify the EnduranceAnalyzer property
specifically using the –display (-d) option.

IntelMAS.exe show –a –intelssd 2

IntelMAS.exe show –d EnduranceAnalyzer –intelssd 2

80 Document Number: 342245, Revision: 015US

5. Read the Endurance Analyzer value which represents the life expectancy
of the drive’s media in years.

Note: The wear leveling of Intel® Optane™ based SSDs will stay at 0% until after
several thousand full pack writes. The counter will update normally for all
other drives.

Note: Endurance analyzer measures media wear only. Using media wear,
calculations are performed to determine the expected life of the drive media.
Please do not use this feature as an overall indicator of drive life expectancy.
Media is one component of many affecting drive lifespan.

Power Governor Mode

Use PowerGovernorMode to display and/or change the selected drive’s power
governor mode. The supported modes are:
• 0 – 25 watts for NVMe drives, unconstrained for ATA devices
• 1 – 20 watts for NVMe drives, Typical (7W) for ATA devices
• 2 – 10 watts for NVMe drives, Low (5W) for ATA devices

To view the current setting, use the show command and view the current
setting. You can also specify the PowerGovernorMode property specifically
using the –display (-d) option.

IntelMAS.exe show -a –intelssd 1

IntelMAS.exe show –d PowerGovernorMode –intelssd 1

To explicitly set the power governor mode, provide one of the supported mode
options.

IntelMAS.exe set –intelssd 1 PowerGovernorMode=0

Document Number: 342245, Revision: 015US 81

KBL Consumer FW Bring Up Guide
100% (1)
KBL Consumer FW Bring Up Guide
147 pages
Intel RST Installation and User Guide
No ratings yet
Intel RST Installation and User Guide
189 pages
Intelserversystembiossetuputilityguide10 Final
No ratings yet
Intelserversystembiossetuputilityguide10 Final
119 pages
System Tools User Guide
No ratings yet
System Tools User Guide
172 pages
SPT Consumer FW Bring Up Guide
No ratings yet
SPT Consumer FW Bring Up Guide
122 pages
Intel® Solid State Drive Data Center Tool: User Guide September 2015 Software Version 2.3.x
No ratings yet
Intel® Solid State Drive Data Center Tool: User Guide September 2015 Software Version 2.3.x
54 pages
RKL-S Consumer Bring Up Guide
No ratings yet
RKL-S Consumer Bring Up Guide
141 pages
Intel® Memory and Storage Tool GUI
No ratings yet
Intel® Memory and Storage Tool GUI
40 pages
Intel - Memory - and - Storage - Tool - User Guide-Public-342245-003US
No ratings yet
Intel - Memory - and - Storage - Tool - User Guide-Public-342245-003US
80 pages
Intel MAS GUI User Guide 002US
No ratings yet
Intel MAS GUI User Guide 002US
40 pages
User's Guide: Quick Links
No ratings yet
User's Guide: Quick Links
48 pages
Simics Unleashed - Applications of Virtual Platforms 2013
No ratings yet
Simics Unleashed - Applications of Virtual Platforms 2013
197 pages
Intel Audience Impression Metrics Suite: User Guide
No ratings yet
Intel Audience Impression Metrics Suite: User Guide
71 pages
APL System Tools User Guide TXE 3 0
No ratings yet
APL System Tools User Guide TXE 3 0
89 pages
7th Gen X Series Datasheet Vol 1
No ratings yet
7th Gen X Series Datasheet Vol 1
86 pages
CLI Intel MAS 1.12 Release Notes 342335 015US
No ratings yet
CLI Intel MAS 1.12 Release Notes 342335 015US
15 pages
FW Bringup Guide
No ratings yet
FW Bringup Guide
87 pages
Intelr Technology Journal Volume 17 Issue 1 2013
No ratings yet
Intelr Technology Journal Volume 17 Issue 1 2013
200 pages
SSD DC s3500 Spec 275867
No ratings yet
SSD DC s3500 Spec 275867
35 pages
f429426464 Intel 7 Series Family Intel ME 8 0 FW Bring Up Guide
No ratings yet
f429426464 Intel 7 Series Family Intel ME 8 0 FW Bring Up Guide
70 pages
Intel SSD ProAdmin Tool User Guide 329902 003
No ratings yet
Intel SSD ProAdmin Tool User Guide 329902 003
19 pages
CLI IMAS Release Notes - Rev020US
No ratings yet
CLI IMAS Release Notes - Rev020US
11 pages
CLI IMAS Tool Install Guide Public - Rev011US
No ratings yet
CLI IMAS Tool Install Guide Public - Rev011US
7 pages
Intel Optane Memory User Installation
No ratings yet
Intel Optane Memory User Installation
66 pages
7th Gen Core Family Mobile U y Processor Lines Datasheet Vol1 Rev008
No ratings yet
7th Gen Core Family Mobile U y Processor Lines Datasheet Vol1 Rev008
216 pages
7th Generation Intel Processor Families For S Platforms and Intel Core™ X-Series Processor Family
No ratings yet
7th Generation Intel Processor Families For S Platforms and Intel Core™ X-Series Processor Family
128 pages
8th Gen Core Family Datasheet Vol 1 Rev009
No ratings yet
8th Gen Core Family Datasheet Vol 1 Rev009
155 pages
System Tools User Guide For Intel Management Engine PDF
No ratings yet
System Tools User Guide For Intel Management Engine PDF
147 pages
GUI IMAS Release Notes - Rev018US
No ratings yet
GUI IMAS Release Notes - Rev018US
11 pages
System Tools User Guide
No ratings yet
System Tools User Guide
136 pages
SSD DC s3700 Spec
No ratings yet
SSD DC s3700 Spec
34 pages
VSCCommn - Bin Content
No ratings yet
VSCCommn - Bin Content
13 pages
Intel - Public Roadmap Article
No ratings yet
Intel - Public Roadmap Article
13 pages
System Tools User Guide
No ratings yet
System Tools User Guide
179 pages
Intel SSD Firmware Update Tool Release Notes Rev038US
No ratings yet
Intel SSD Firmware Update Tool Release Notes Rev038US
8 pages
Intel SSD Firmware Update Tool Release Notes Rev037US
No ratings yet
Intel SSD Firmware Update Tool Release Notes Rev037US
8 pages
Intel Architecture Code Analyzer, IACA-Guide
No ratings yet
Intel Architecture Code Analyzer, IACA-Guide
18 pages
Siemens, Teamcenter PDF
No ratings yet
Siemens, Teamcenter PDF
20 pages
SATA SSD Firmware Update Tool Guidelines 322570
No ratings yet
SATA SSD Firmware Update Tool Guidelines 322570
21 pages
Intel Non-Volatile Memory Solutions Group: October 2020 Contact Handeep Kaur
No ratings yet
Intel Non-Volatile Memory Solutions Group: October 2020 Contact Handeep Kaur
4 pages
Intel Optane™ Memory: Quick Start Guide
No ratings yet
Intel Optane™ Memory: Quick Start Guide
5 pages
1.5MB FW Release Notes 8 1 30 1350 (MR)
No ratings yet
1.5MB FW Release Notes 8 1 30 1350 (MR)
48 pages
OEM Technical Guide 15.0 Revision1.0
No ratings yet
OEM Technical Guide 15.0 Revision1.0
247 pages
Core M Processor Family Spec Update
No ratings yet
Core M Processor Family Spec Update
30 pages
8th Gen Core Family Datasheet Vol 1
No ratings yet
8th Gen Core Family Datasheet Vol 1
135 pages
Intel NUC Software Studio User Guide-Intel NUC M15 Laptop Kit and Intel NUC P14E Laptop Element-V1.4
No ratings yet
Intel NUC Software Studio User Guide-Intel NUC M15 Laptop Kit and Intel NUC P14E Laptop Element-V1.4
13 pages
Intel (R) ME Firmware Integrated Clock Control (ICC) Tools User Guide
No ratings yet
Intel (R) ME Firmware Integrated Clock Control (ICC) Tools User Guide
24 pages
Braidwood Tools User Guide
No ratings yet
Braidwood Tools User Guide
16 pages
Intel Xeon E5 v3 Thermal Guide
No ratings yet
Intel Xeon E5 v3 Thermal Guide
102 pages
1.5MB FW Bring Up Guide 8.1.0.1248 PV
No ratings yet
1.5MB FW Bring Up Guide 8.1.0.1248 PV
131 pages
Intel SSD 330 Productbrief
No ratings yet
Intel SSD 330 Productbrief
2 pages
Intel SSD 335 Series Product Brief
No ratings yet
Intel SSD 335 Series Product Brief
2 pages
Intel (R) MEBX User Guide PDF
No ratings yet
Intel (R) MEBX User Guide PDF
57 pages
System Tools User Guide For Intel Management Engine PDF
No ratings yet
System Tools User Guide For Intel Management Engine PDF
147 pages
More Time. Less Grind.: A High-Endurance SSD Designed For Data Center Performance
No ratings yet
More Time. Less Grind.: A High-Endurance SSD Designed For Data Center Performance
2 pages
The SQL Tutorial For Data Analysis
No ratings yet
The SQL Tutorial For Data Analysis
103 pages
1 5MB FW Release Notes 7 1 52 1176 HF
No ratings yet
1 5MB FW Release Notes 7 1 52 1176 HF
60 pages
MRD7 Windows Driver Installation Readme PDF
No ratings yet
MRD7 Windows Driver Installation Readme PDF
7 pages
IHub Interface Guide
No ratings yet
IHub Interface Guide
66 pages
Vbuilder Manual PDF
No ratings yet
Vbuilder Manual PDF
303 pages
SSD DC s3500 Brief
No ratings yet
SSD DC s3500 Brief
2 pages
Practice Activity 1: Perform The Indicated Operations
No ratings yet
Practice Activity 1: Perform The Indicated Operations
4 pages
20ec755 Unit 3 Notes
No ratings yet
20ec755 Unit 3 Notes
21 pages
Millions of People Every Year Move To English
No ratings yet
Millions of People Every Year Move To English
12 pages
SDLC
No ratings yet
SDLC
28 pages
Checksum TR - 4 - Automated Test System - Instr Manual PDF
No ratings yet
Checksum TR - 4 - Automated Test System - Instr Manual PDF
376 pages
Curriculum Vitae: Jalan Perindustrian PBP3, Pusat Bandar Puchong 47100 Punchong, Selangor Darul Ehsan
No ratings yet
Curriculum Vitae: Jalan Perindustrian PBP3, Pusat Bandar Puchong 47100 Punchong, Selangor Darul Ehsan
5 pages
ACS Real Life
No ratings yet
ACS Real Life
50 pages
MIT06
No ratings yet
MIT06
40 pages
Administering Active Directory 1st Edition Mark Wilkins PDF Download
No ratings yet
Administering Active Directory 1st Edition Mark Wilkins PDF Download
49 pages
Compose and Install Laravel
No ratings yet
Compose and Install Laravel
25 pages
Arista-FreeRadius 01dec2024
No ratings yet
Arista-FreeRadius 01dec2024
16 pages
Example CV Customer Service 1
No ratings yet
Example CV Customer Service 1
2 pages
Financial Safety and Security in The Cyber World
No ratings yet
Financial Safety and Security in The Cyber World
53 pages
Birla Institute of Technology Welfare Society: Mess Fee Deposit Procedure
No ratings yet
Birla Institute of Technology Welfare Society: Mess Fee Deposit Procedure
9 pages
Appendix I-Handover Package and Folder Structure
No ratings yet
Appendix I-Handover Package and Folder Structure
6 pages
Comptia Security+ Study Guide (Sy0-501) : Chapter 1: Managing Risk
No ratings yet
Comptia Security+ Study Guide (Sy0-501) : Chapter 1: Managing Risk
9 pages
Aerissecurityv 721663682410091
No ratings yet
Aerissecurityv 721663682410091
6 pages
Cisco 5915 Embedded Services Router: Data Sheet
No ratings yet
Cisco 5915 Embedded Services Router: Data Sheet
9 pages
Unit 2 DBMS
No ratings yet
Unit 2 DBMS
35 pages
AS-IS & GAP Analysis: Mobile POS With NFC
No ratings yet
AS-IS & GAP Analysis: Mobile POS With NFC
7 pages
App Dna Lga
No ratings yet
App Dna Lga
15 pages
My First HPS
No ratings yet
My First HPS
13 pages
Attia Elmoslimany ElKeyi JCM 2012
No ratings yet
Attia Elmoslimany ElKeyi JCM 2012
15 pages
Conformity Analysis of HTTP Strict Transport Security HSTS Configuration and Implementation Using Bettercap Tools
No ratings yet
Conformity Analysis of HTTP Strict Transport Security HSTS Configuration and Implementation Using Bettercap Tools
6 pages
Ti c55x DSP
No ratings yet
Ti c55x DSP
2 pages
Provision-IsR CMS - PC Decode & Record Capabilities
No ratings yet
Provision-IsR CMS - PC Decode & Record Capabilities
1 page
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
From Everand
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
Matthew C. Smith
No ratings yet
ChatGPT for Business: Strategies for Success
From Everand
ChatGPT for Business: Strategies for Success
Matthew C. Smith
No ratings yet
Software Patterns Made Easy
From Everand
Software Patterns Made Easy
Justice Nanhou
No ratings yet

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.