HGST Device Manager User Manual

HGST Device Manager

Version 3.2

User Guide

Document Number:

61600-00180-309

Document Version:

3.09

Software Version:

HDM 3.2

Revision Date:

May 31, 2016

Warning: Printed copies of this document are considered current only on the date of print. Replacement and disposal of down-level versions is the responsibility of the document holder.

HGST Device Manager User Guide – Version 3.2

3RD Edition (Document Version 3.09)

May 31, 2016

The following paragraph does not apply to the United Kingdom or any country where such provisions are inconsistent with local law: HGST, INC., PROVIDES THIS PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer or express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This publication could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of this publication. HGST may make improvements or changes in any products or programs described in this publication at any time.

It is possible that this publication may contain reference to, or information about, HGST products (machines and programs), programming, or services that are not announced in your country. Such references or information must not be construed to mean that HGST intends to announce such HGST products, programming, or services in your country.

Technical information about this product is available by contacting your local HGST representative or on the Internet at http://www.hgst.com.

HGST may have patents or pending patent applications covering the subject matter in this document. The furnishing of this document does not give you any license to these patents.

HGST Device Manager User Guide – Version 3.2

iii

End-User License Agreement

IMPORTANT: PLEASE READ THIS END USER LICENSE AGREEMENT CAREFULLY. DOWNLOADING, INSTALLING OR USING THE ACCOMPANYING SOFTWARE CONSTITUTES ACCEPTANCE OF THIS END USER LICENSE AGREEMENT.

HGST, INC. AND ITS AFFILIATES (COLLECTIVELY, “HGST”) IS WILLING TO LICENSE THE

SOFTWARE ONLY IF YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS END USER LICENSE AGREEMENT (THE “EULA”).

1. BY DOWNLOADING, INSTALLING OR USING THE SOFTWARE OR OTHERWISE EXPRESSING YOUR AGREEMENT TO THE TERMS CONTAINED IN THIS END USER LICENSE AGREEMENT, YOU INDIVIDUALLY AND ON BEHALF OF THE ENTITY THAT YOU REPRESENT (COLLECTIVELY,

“LICENSEE”) CONSENT TO BE BOUND BY THIS EULA AND THE AGREEMENT. IF YOU DO NOT

OR CANNOT AGREE TO THE TERMS CONTAINED IN THIS AGREEMENT, THEN (A) DO NOT DOWNLOAD, INSTALL OR USE THE SOFTWARE RETURN THE SOFTWARE TO HGST.

1.1. No Sale. This EULA governs Licensee’s use of and access to the Software (as defined below) for

any Software first placed in use on or after the release date of this EULA (the “Release Date”). Licensee agrees and acknowledges that all Software is licensed and not sold, and that all use of

“purchase” or “sell” in connection with any Software shall be deemed to mean “license.” Any term

in Licensee’s purchase order or other document purporting to require the sale of Software instead

of the license thereof is hereby rejected by HGST and is not part of the Agreement.

1.2. No Implied Licenses; Licensed Material. Nothing in this EULA shall be deemed to provide to

Customer any right, title or interest in (i) any product sold by HGST or an authorized reseller of HGST (a “Product”); (ii) any instance of a program, module, feature, function, service, application, operation or capability of the software HGST intentionally delivers under this EULA; or (iii) any documentation related to any Software (the “Documentation”), other than the express license rights set forth in Section 3 hereof.

2. Definitions. In this EULA, the following capitalized terms shall have the meaning set forth below:

2.1. “Agreement” shall mean this EULA.

2.2. “Affiliate” of a Party means such Party’s parent corporation, an entity under the control of such

Party’s parent corporation at any tier or an entity controlled by such Party at any tier. For these

purposes, “control” shall mean the power to direct or cause the direction of the management and

policies of the entity, whether through the ownership of more than 50% of the outstanding voting interests in such entity or otherwise.

2.3. “Party” means either Licensee or HGST and “Parties” means both Licensee and HGST.

2.4. “Software” shall mean the software utility tool delivered under this EULA.

2.5. “Third Party” means an individual or entity other than Licensee, HGST and HGST’s Affiliates.

2.6. “User” means an individual able to use or gain access to any Software functionality.

3. License Grant.

3.1. Grant. Subject to the terms and conditions of this Agreement, HGST hereby grants to Licensee,

and Licensee accepts, upon delivery of the Software, a nonexclusive, nontransferable license to install and use (subject to the limitations in Sections 3.2 and 3.3) each copy of the Software, in executable form only, supplied by HGST, and to use the accompanying Documentation, only for Licensee’s internal use in connection with the testing and support of HGST hardware products. Licensee may make a reasonable number of copies of the Software for inactive backup and archival purposes.

3.2. No Right to Sublicense or Assign. Except to the extent otherwise required by applicable law or

expressly provided for assignment generally in the Agreement, including without limitation in this EULA, no license provided in this Section 3 is sublicensable, transferable or assignable by

HGST Device Manager User Guide – Version 3.2

Licensee, including by operation of law, change of control, merger, purchase or otherwise, without the prior written consent of HGST in each instance. Other than as expressly permitted by the foregoing, any attempted sublicense, transfer or assignment by Licensee shall be null and void.

3.3. License Prohibitions. Notwithstanding anything to the contrary in this EULA, Licensee shall not,

alone, through a User, an Affiliate or a Third Party (or allow a User, an Affiliate or a Third Party to): (a) sell, transfer, license, lease pledge, loan or otherwise make available to Third Parties any

Software; (b) modify any Software; (c) reverse compile, reverse assemble, reverse engineer or otherwise translate all or any portion

of any Software; (d) pledge, rent, lease, share, distribute, sell or create derivative works of any Software; (e) use any Software on a time sharing, service bureau, application service provider (ASP), rental

or other similar basis; (f) make copies of any Software, except as provided for in the license grant above; (g) transfer any Software from a Product supplied by HGST to any hardware supplied by a Third

Party; (h) remove, alter or deface (or attempt any of the foregoing) proprietary notices, labels or marks

in any Software; (i) distribute any copy of any Software to any Third Party, including without limitation selling any

Product with Software in a secondhand market; (j) use any Embedded Software other than with Products supplied by HGST or an authorized

reseller of HGST or for more than the number of Products purchased from HGST or an

authorized reseller of HGST; (k) disclose the results of testing or benchmarking of any Software to any Third Party without the

prior written consent of HGST; (l) use any Update or Upgrade beyond those to which Licensee is entitled or with any Software

to which Licensee does not have a valid, current license; (m) circumvent or disable HGST’s copyright protection mechanisms or license management

mechanisms; (n) use the Software in violation of any applicable law or to support any illegal activity; or (o) attempt any of the foregoing.

HGST expressly reserves the right to seek all available legal and equitable remedies to prevent any of the foregoing and to recover any lost profits, damages or costs resulting from any of the foregoing.

3.4. Legal Exception. Licensee agrees that, to the extent that any applicable laws (including without limitation national laws implementing EC Directive 91/250 on the Legal Protection of Computer Programs) give Licensee the right to reverse engineer any Software to make it interoperable

without HGST’s consent, before Licensee exercises any such rights, Licensee shall notify HGST

of such desire and, no later than sixty (60) days following receipt of such request, HGST may decide either: (a) to perform the work to achieve such interoperability and charge its then-standard rates for such work to Licensee; or (b) to permit Licensee to reverse engineer parts of the Software only to the extent necessary to achieve such interoperability. Only if and after HGST, at its sole

discretion, partly or completely denies Licensee’s request, shall Licensee exercise its statutory

rights.

3.5. Third Party Software. Portions of the Software may be owned by one or more Third Parties and licensed to HGST. HGST and Licensee intend and agree that Software owned by Third Parties and supplied hereunder is being sublicensed to Licensee, that such Third Parties retain ownership

HGST Device Manager User Guide – Version 3.2

of and title to such Software, network and that such Third Parties may directly enforce Licensee’s obligations hereunder to protect their respective interests in such Software. The warranty and indemnification provisions set forth herein shall not apply to Software owned by Third Parties and supplied hereunder. The licenses/terms applicable to such Third Party licenses are set forth in Exhibit A.

3.6. Software Support. Unless otherwise agreed to as part of the Agreement, HGST does not offer or provide any technical support or other services under this EULA.

4. Confidentiality. Subject to any other confidentiality restrictions set forth in the Agreement, Licensee agrees the Software and Documentation are the confidential information of HGST. Licensee shall maintain the Software and Documentation in confidence, using the same degree of care it uses for its own confidential information of a similar nature, which shall be no less than reasonable and customary efforts in the software industry.

5. Software Warranty. TO THE MAXIMUM EXTENT PERMITTED BY LAW, EXCEPT AS PROVIDED FOR IN THE AGREEMENT, THE SOFTWARE AND DOCUMENTATION ARE PROVIDED “AS IS”. HGST, INCLUDING ITS AFFILIATES AND SUPPLIERS, MAKES NO OTHER WARRANTIES, EXPRESS OR IMPLIED, AND SPECIFICALLY DISCLAIMS THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT WITH RESPECT TO THE SOFTWARE AND THE DOCUMENTATION. IN ADDITION, HGST DOES NOT WARRANT THAT THE SOFTWARE’S OPERATION WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ALL DEFECTS WILL BE CORRECTED.

6. Exclusive Remedies and Limitation of Liability.

6.1. Definitions. For purposes of the exclusive remedies and limitations of liability set forth in this

Section 7, HGST shall be deemed to include its directors, officers, employees, agents, representatives, shareholders, subcontractors, licensors and suppliers; and “damages” shall be deemed to refer collectively to all injury, damage, loss or expense incurred.

6.2. Maximum Liability. Except as may otherwise be provided in the Agreement, HGST’s maximum

aggregate liability arising from or relating to this EULA or the use of the Software and Products shall not to exceed the total amount paid by Licensee to HGST during the twelve (12) month period that immediately preceded the event that gave rise to the applicable claim.

6.3. Limitation of Liability. NOTWITHSTANDING ANY OTHER PROVISION OF THIS EULA BUT

SUBJECT IN ALL RESPECTS TO THE AGREEMENT, TO THE MAXIMUM EXTENT PERMITTED BY LAW, HGST, INCLUDING ITS AFFILIATES AND SUPPLIERS, SHALL NOT BE LIABLE FOR INCIDENTAL, SPECIAL, EXEMPLARY, CONSEQUENTIAL OR OTHER INDIRECT DAMAGES, INCLUDING BUT NOT LIMITED TO LOSS OF DATA, LOSS OR INTERRUPTION OF USE, LOST PROFITS, SAVINGS OR REVENUES OF ANY KIND, WHETHER OR NOT HGST HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THIS PROVISION SHALL APPLY EVEN IN THE EVENT OF THE FAILURE OF AN EXCLUSIVE REMEDY.

7. Term And Termination.

7.1. Term. The term of this EULA is while any Software is under Licensee’s control or possession,

unless terminated earlier (the “License Term”).

7.2. Termination. HGST shall have the right to terminate this EULA (a) upon thirty (30) days’ prior

written notice to Licensee if Licensee has not cured any material breach of this EULA by the end of such thirty (30) day notice period; (b) if Licensee has not paid an invoice to HGST regarding such Software sixty (60) days after such invoice is due, at any time thereafter upon written notice

to Licensee; (c) if the Software is found to infringe or misappropriate any Third Party’s intellectual

property or proprietary rights, or becomes subject to an injunction prohibiting its use, or HGS T reasonably believes either of the foregoing conditions is likely to occur; or (d) as otherwise provided for in the Agreement. Upon termination of this EULA for any reason, (i) Licensee shall be responsible for payment for all purchase orders delivered to Licensee by HGST before the effective

date of termination; and (ii) Licensee shall destroy all copies of the Software under Licensee’s

control or possession. Further, the licenses granted under this EULA for Embedded Software

HGST Device Manager User Guide – Version 3.2

shall automatically terminate when Licensee’s lawful possession of the applicable Product provided hereunder ceases, unless earlier terminated as provided herein.

7.3. Survival. The provisions of Sections 1, 2, 3.5, 3.6, 3.8, 3.9, 4, 5.3, 6, 7, 8.3, and 9 of this EULA

shall survive any termination in accordance with their terms, in addition to any accrued obligations.

8. Miscellaneous.

8.1. Choice of Law; Jurisdiction. The Agreement shall be governed by the laws of the State of

California, excluding (a) its conflicts of law rules that would result in the application of the law of any other jurisdiction; and (b) the United Nations Convention for the International Sale of Goods. The federal and state courts located in San Jose, California shall have exclusive jurisdiction with respect to any dispute arising under this Agreement.

8.2. Assignment. Neither Party may assign its rights and obligations hereunder without the prior written

consent of the other Party. Notwithstanding the foregoing, either Party may assign this EULA to any Affiliate of the other or to an acquirer (by purchase, merger or otherwise) of all or substantially

all of such Party’s business or assets relating to this EULA, provided that (i) the assignee agrees

in writing to be bound by the terms and conditions of this EULA, (ii) neither the assignor nor assignee are in default hereunder. Any attempted assignment other than as permitted shall be null and void.

8.3. Non-Waiver. No course of dealing or failure of either party to strictly enforce any term, right or

condition of this Agreement shall be construed as a waiver of such term, right or condition. In the event of any breach or threatened breach of Section 3, Licensee agrees that HGST will suffer irreparable damage for which HGST will have no adequate remedy at law. Accordingly, in addition to any other remedy, HGST shall be entitled to injunctive and other equitable remedies to prevent or restrain such breach or threatened breach, without the necessity of proving actual damages or posting any bond.

8.4. Export Regulations. Licensee understands that HGST is subject to regulation by the U.S.

government and its agencies, which prohibit export or diversion of certain technical products and information to certain countries and individuals. Licensee warrants to HGST that Licensee will comply in all respects with all export and re-export restrictions applicable to the technology and documentation provided hereunder.

8.5. Restricted Party. Licensee represents to HGST that Licensee is not a Restricted Party, which shall

be deemed to include any person or entity: (1) located in or a national of Cuba, Iran, Libya, North Korea, Sudan, Syria, or any other countries that may, from time to time, become subject to U.S. export controls for anti-terrorism reasons or with which U.S. persons are generally prohibited from engaging in financial transactions; (2) on the U.S. Department of Commerce Denied Person’s List, Entity List, or Unverified List; U.S. Department of the Treasury list of Specially Designated Nationals and Blocked Persons; or U.S. Department of State List of Debarred Parties; (3) engaged in activities involving nuclear materials or weapons, missile or rocket technologies, or proliferation of chemical or biological weapons; or (4) affiliated with or a part of any non-U.S. military organization. Licensee shall not sell, resell, loan, disclose, or otherwise transfer any Software, Product or Documentation to any Restricted Person without prior, express written authorization from HGST and the appropriate U.S. Government agency. If Licensee becomes a Restricted Person during the Term, this EULA shall automatically terminate and Licensee shall immediately cease all use of the Software.

8.6. United States Government Restricted Rights. The Software and Documentation is provided with

restricted rights and qualifies as “commercial items” consisting of “commercial computer software”

and “computer software documentation” as such terms are defined and used at FAR (48 C.F.R.)

2.101 and FAR 12.212. Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(f)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c) (1) and (2) of the Commercial Computer SoftwareRestricted Rights at 48 C.F.R. S:52.227-19, as applicable. For clarity, this Section 9.6 shall also be construed to apply to the state or local government counterparts, or the foreign counterpart specified as the Territory, as applicable.

HGST Device Manager User Guide – Version 3.2

vii

8.7. Order of Precedence; Entire Agreement. To the extent of any conflict among this EULA, any

additional terms in an agreement signed by Licensee and HGST, any HGST “click -accept”

agreement, any terms on a purchase order and HGST’s terms and conditions of sale, the order of

precedence shall be (a) an agreement signed by Licensee and HGST; (b) this EULA; (c) a “click-

accept” agreement, including any agreement regarding the Features to be included as part of the Software; (d) HGST’s terms and conditions of sale; and (e) HGST’s purchase order acceptance

(collectively, (a)-(e), after applying the order of precedence, the “Agreement”). The terms and conditions contained in the Agreement supersede all prior oral or written understandings between the Parties and shall constitute the entire agreement between the Parties with respect to the subject matter of the Agreement. This Agreement shall not be modified or amended except by a writing signed by Licensee and HGST.

8.8. Construction; Severability. The headings used in this Agreement are for reference purposes only

and will not be deemed to limit, expand or in any way affect the interpretation of any term or provision hereof. If any provision or part hereof shall be held to be invalid or unenforceable for any reason, then the meaning of such provision or part hereof shall be construed so as to render it enforceable to the extent feasible. If no feasible interpretation would save such provision or part hereof, it shall be severed herefrom, but without in any way affecting the remainder of such provision or any other provision contained herein, all of which shall continue in full force and effect unless such severance effects such a material change as to render the Agreement unreasonable.

HGST Device Manager User Guide – Version 3.2

viii

License

Component

License Available at

MIT

libuv

https://github.com/joyent/libuv/blob/master/LICENSE

Public Domain

MurmurHash3 Function

https://code.google.com/p/smhasher

Apache Version 2.0

Android Open Source Project (hashtable)

https://android.googlesource.com/platform/system/core/+/master/libcutils/hashmap.c

MIT

uint128 class

http://codef00.com/code/uint128.h

MIT

Jansson JSON String Dump Utility

http://www.digip.org/jansson

License

Component

License Available at

N/A

Exhibit A

Third Party Licenses

The Software contains open source components as set forth in this Exhibit A. Please refer to the table below for the open source components and the associated license(s) for the terms and conditions for their use. The source code for the components listed in Table 1 below may be obtained from HGST. HGST may provide the open source code to you on a physical storage medium for a charge covering the cost of performing such distribution, which may include, without limitation the cost of media, shipping and handling.

Table 1

Notwithstanding anything to the contrary in this EULA, this EULA does not prohibit Licensee from modifying, or reverse engineering to debug any such modifications to, any component of the Software that is subject to an LGPL or GPL license. Any such component is provided und er the terms of the applicable LGPL or GPL license, as specified in Table 1.

Please also be informed that the Software may contain other Third Party Software listed in Table 2 below.

Table 2

HGST Device Manager User Guide – Version 3.2

Conventions

Description

CAUTION

This icon denotes the use of extreme caution and the user must exercise good judgment according to previous experience before advancing to the next procedure. The icon also indicates the existence of a hazard that could result in equipment or property damage, or equipment failure if the instructions are not observed.

NOTE

This icon denotes additional or related information that the user may find useful. It also identifies any information that relates to the safe operation of the equipment, software, or related items.

Bold.

Text

Used to indicate important technical notes.

Bold Italic

Text

Used to indicate critical instructions.

Light Blue Italic

Text

Used to indicate a hyperlink or “jump” to a related topic

or subtopic. In addition, the text may be bold.

Conventions

The following icon and text conventions are used throughout this document to identify additional information of which the reader should be aware.

HGST Device Manager User Guide – Version 3.2

Revision

Date

Page(s)

Description

-300

12/20/2014

All

Initial release.

-301

03/02/2015

All

Preliminary release.

-302

03/20/2015

Topic; Shared Library (Linux Installation) struck from user guide. Obsolete specification.

Topic; Shared Library (Windows Installation) struck from user guide. Obsolete specification. Also added note explaining the necessity of using the HGST In-house Driver.

Topic; Device References. Note 3 struck due to inaccuracy.

Topic; Output Types. Minor edit of Sentence #2 to include mini (MINI) output type.

Topic; alias command updated.

Topic; Beta Limitations. Statement updated to reflect latest beta release.

Topic; configure-smart options temperature and availablespare documented.

Topic; generate-report Examples updated to include both redirection and console output.

Topic; get-feature NVMe Feature --feature options documented.

Topic; get-log-page NVMe --page options documented.

Topic; get-statistics Example syntax corrected.

46, 47, 48

Topic; get-statistics category examples updated.

Topic; resize command. Added table listing valid resize ranges for resize command.

-303

04/15/2015

All

Struck references to “Beta” in preparation for GA Releas e.

All

Global Search/Replace; The default is “mini”.

viii

Exhibit A; struck Public Dom ain com ponent “murmur3 hash

function” from Table 1. Obsolete specification.

Topic; “Beta Limitations” changed to “GA Lim itations” and

note re-worded to reflect GA software release.

Topic; Linux Installation. Installation Notes updated.

Topic; Windows Installation. Installation Notes updated.

Figure 1 updated to show mini output format.

28-52

The example output, where applicable, is now the mini, rather than the text, output format.

Table 5, Command Exit Status Codes matrix updated.

-303

(continued)

Topic; monitor Command. Cautionary note added in regards to the --interval and --count values.

Topic; reset-to-defaults Command. Cautionary note added in regards to power cycle of system.

Topic; resize Command. Cautionary notes added in regards to resize command functionality and support.

Revision History

HGST Device Manager User Guide – Version 3.2

Revision

Date

Page(s)

Description

-304

07/17/2015

Title

Title page information updated.

viii

Exhibit A; updated to reflect legal requirements.

Topic; Linux Directory Trees vs. Windows Device Instance IDs. Informational only.

Topic; Short Form Syntax. Table of “Long Form” and “Short

Form” equivalent options implemented in HDM 3.1.

Topic; Configuration Files. The short form -c option documented for the --config PATH option.

Topic; Output Types. The short form -o option documented for the --output-format FORMAT option.

Topic; Command Confirmation developed for destructive commands.

Topic; configure-trace. The short form –f option documented for the --file FILE parameter.

54-56

Topic: manage-namespaces developed for HDM 3.1.

Topic; manage-power developed for HDM 3.1.

Topic; prepare-for-removal developed for HDM 3.1.

Topic; secure-purge developed for HDM 3.1.

-305

07/30/2015

Topic; configure-smart command. Note added to clarify available spare threshold limitations vs. currently available spare threshold value and read-only mode.

Topic; manage-power command. Note added in regards to proper usage of command and the possible adverse consequences to changing the power state of the device.

Topic; resize command. Updated table listing the minimum and maximum ranges according to drive capacity.

-306

11/09/2015

Title

Title updated to reflect HDM 3.2 Alpha release.

Topic; Linux DEB Installation documented.

37-39

Topic; format command. Complete re-write of topic, with explanation of valid option combinations for SAS and NVMe drives.

41-42

Topic; get-capabilities command documented.

-307

05/12/2016

Table 1; list of Supported Products updated to included Ultrastar SAS series of SSDs.

Topic; Operating Systems. Listed Ubuntu Linux 16.04 POWER8, Little-Endian (LE).

Topic; configure-smart command. Updated functional description of --clear-all, --clear, --restore and

--restore-all options.

Topic; clarified the overwrite option for the sanitize command.

-308

05/12/2016

Many

Mass changes to all sections for accuracy, brevity, and to broaden document to apply to SAS SSDs as well.

HGST Device Manager User Guide – Version 3.2

xii

Revision

Date

Page(s)

Description

-309

05/26/2016

Many

Widespread changes to document, EULA, and footers to reflect that this document is for a GA release.

HGST Device Manager User Guide – Version 3.2

xiii

Table of Contents

Scope ..........................................................................................................................................................................................16

Overview ................................................................................................................................... 16

Audience ................................................................................................................................... 16

Features................................ ................................................................................................ .... 16

Specifications ............................................................................................................................ 16

Supported Products ................................................................................................................... 17

Supported Controllers ................................................................................................................ 17

Installation .................................................................................................................................................................................18

Overview ................................................................................................................................... 18

Prerequisites ............................................................................................................................. 18

Operating Systems..................................................................................................................... 18

User Privileges .......................................................................................................................... 19

Supported Drivers ...................................................................................................................... 19

System Hardware Requirements................................................................................................. 20

Installation Packages ................................................................................................................. 21

Event Logging................................................................................................ ............................ 21

Linux RPM Installation................................................................................................................ 22

Uninstall Procedure................................ ................................................................................. 22

Linux DEB Installation ................................ ................................................................................ 22

Uninstall Procedure................................ ................................................................................. 22

Windows Installation .................................................................................................................. 23

Uninstall Procedure................................ ................................................................................. 23

Installation Notes .................................................................................................................... 23

Command Line Interface........................................................................................................................................................24

Overview ................................................................................................................................... 24

Command Execution .................................................................................................................. 24

Command Syntax ...................................................................................................................... 24

Command Arguments ................................................................ ............................................. 24

Device References ................................................................................................................. 24

Device Reference Examples.................................................................................................... 25

OS Path Example................................................................................................................ 25

Alias Example .................................................................................................................... 25

Device Unique Identifier Example ....................................................................................... 25

Linux Directory Trees vs. Windows Device Instance IDs............................................................ 25

Short Form Syntax ................................................................................................ .................. 26

Configuration Files ................................................................................................ .................. 26

Listing the Installed Devices .................................................................................................... 27

Output Types ............................................................................................................................. 28

MINI Output............................................................................................................................ 28

Text Output ............................................................................................................................ 28

JSON Output ................................................................................................ .......................... 29

CSV Output ............................................................................................................................ 29

Commands ................................................................................................................................ 30

Command Support ..................................................................................................................... 31

Help System .............................................................................................................................. 32

Complete Command Listing .................................................................................................... 32

Specific Command Help .......................................................................................................... 33

Command Confirmation.............................................................................................................. 33

Command Exit Status Codes ...................................................................................................... 33

HGST Device Manager User Guide – Version 3.2

xiv

alias .......................................................................................................................................... 34

capture-diagnostics .................................................................................................................... 35

configure-smart.......................................................................................................................... 36

configure-trace................................................................................................ ........................... 38

format ....................................................................................................................................... 39

generate-report .......................................................................................................................... 42

get-capabilities........................................................................................................................... 43

get-feature................................................................................................................................. 45

get-info ...................................................................................................................................... 47

get-log-page ................................................................................................ .............................. 50

get-smart ................................................................................................................................... 52

get-state .................................................................................................................................... 54

get-statistics .............................................................................................................................. 56

locate ........................................................................................................................................ 60

manage-firmware ....................................................................................................................... 61

manage-namespaces ................................................................................................................. 63

manage-power................................................................................................ ........................... 65

monitor ................................................................................................................................ ...... 67

prepare-for-removal ................................................................................................................... 68

reset-to-defaults ......................................................................................................................... 69

resize ........................................................................................................................................ 70

sanitize...................................................................................................................................... 71

scan .......................................................................................................................................... 74

secure-erase ............................................................................................................................. 75

secure-purge ............................................................................................................................. 76

version ................................ ................................................................................................ ...... 78

Contact Information ................................................................................................................................................................79

General Information ................................................................................................................... 79

Technical Support ...................................................................................................................... 79

Email Support and Telephone Support ........................................................................................ 79

List of Tables

Table 1: Supported Products ................................................................ ............................................. 17

Table 2: Supported Controllers .......................................................................................................... 17

Table 3: Supported Operating Systems .............................................................................................. 18

Table 4: User Privileges .................................................................................................................... 19

Table 5: Supported Drivers ................................................................................................................ 19

Table 6: System Hardware Requirements .......................................................................................... 20

Table 7: Installation Packages ................................ ........................................................................... 21

Table 8: Device References .............................................................................................................. 24

Table 9: Short Form Command Arguments......................................................................................... 26

Table 10: HDM Commands ................................................................ ............................................... 30

Table 11: Supported Commands ....................................................................................................... 31

Table 12: Command Exit Status Codes .............................................................................................. 33

HGST Device Manager User Guide – Version 3.2

List of Figures

Figure 1: Listing the Installed Devices ................................................................................................ 27

Figure 2: MINI Output Example.......................................................................................................... 28

Figure 3: Text Output Example .......................................................................................................... 28

Figure 4: JSON Output Example ........................................................................................................ 29

Figure 5: CSV Output Example .......................................................................................................... 29

HGST Device Manager User Guide – Version 3.2

Feature

Description

Cross-Platform Solution

Simplifies the management of SSDs in Linux 64-Bit and Windows 64-bit environments.

Command Line Interface (CLI)

A consistent command line interface that supports the use of Linux scripts or Windows batch files to automate tasks. The user can choose from four (4)

modes of output: mini, text, json and csv. The mini option (default) presents the output in an abridged format, the text output is a humanreadable format, the json output is for a scripting environment, and the csv format can be used for data mining purposes and analysis.

Specification

Description

Overview

Software solution that operates independently of host hardware for managing multiple drives.

Solid-State Device Compatibility

See Supported Products.

Operating Systems

See Operating Systems under Prerequisites.

Capabilities

Integrated solid-state device solution; firmware management, namespace management, power management, report generation, secure erase and secure purge, factory reset and format, resize, statistics, diagnostic capture, and S.M.A.R.T. data retrieval.

Management

CLI utilities to manage solid-state devices.

Scope

Overview

The HGST Device Manager (HDM) is designed to efficiently assist in the administration of HGST SolidState Drive (SSD) devices. While many IT organizations have embraced the benefits of solid-state technology, many of the current hard disk drive utilities have proven woefully inadequate in the management of enterprise solid-state devices. HDM provides the ability to easily update, manage, and configure SSDs.

Audience

This user guide is intended for system administrators, network administrators, and other IT professionals. It is therefore written specifically for a technically advanced audience; it is not intended for end-users that will eventually purchase the commercially available product. The user, as referenced throughout this guide, is primary concerned with industrial, commercial and enterprise networking applications.

Features

Specifications

HGST Device Manager User Guide – Version 3.2

HDM 3.2 requires that Firmware Version KMGNP110 or later be installed on the SN100 or SN150 Series SSDs; otherwise, the execution of the resize, reset-to-defaults and

manage-namespaces commands will return an error.

Product Family

Description

Ultrastar® SN100 Series

SN100 NVMe PCIe 3.0 x4 Lane 2.5-Inch SFF Solid-State Drives

Ultrastar® SN150 Series

SN150 NVMe PCIe 3.0 x4 Lane HH-HL Edge Card Solid-State Drives

Ultrastar® SSD800MH

Ultrastar 2.5-Inch 12Gbps SAS-3 SFF MLC HE Solid-State Drives

Ultrastar® SSD800MM

Ultrastar 2.5-Inch 12Gbps SAS-3 SFF MLC ME Solid-State Drives

Ultrastar® SSD800MH.B

Ultrastar 2.5-Inch 12Gbps SAS-3 SFF MLC HE Solid-State Drives

Ultrastar® SSD1000MR

Ultrastar 2.5-Inch 12Gbps SAS-3 SFF MLC RI Solid-State Drives

Ultrastar® SSD1600MM

Ultrastar 2.5-Inch 12Gbps SAS-3 SFF MLC ME Solid-State Drives

Ultrastar® SSD1600MR

Ultrastar 2.5-Inch 12Gbps SAS-3 SFF MLC RI Solid-State Drives

Controller Vendor

Controller Family

Avago

SAS/SATA 92xx Host Bus Adapters

Avago

SAS/SATA 93xx Host Bus Adapters

Avago

MegaRAID SATA + SAS 92xx RAID Controllers

Avago

MegaRAID SATA + SAS 93xx RAID Controllers

ATTO

ExpressSAS SAS/SATA H6xx Host Bus Adapters

ATTO

ExpressSAS SAS/SATA H6xx Host Bus Adapters

Supported Products

HDM can discover and manage the following SSDs as outlined in Table 1: Supported Products.

Table 1: Supported Products

Supported Controllers

HDM can discover and manage Serial Attached SCSI (SAS) SSDs managed by the following controllers outlined in Table 2: Supported Controllers.

Table 2: Supported Controllers

HGST Device Manager User Guide – Version 3.2

The prerequisite platform or software described below should be installed and configured before you install HDM.

HDM 3.2 only supports the kernels that are supplied with the operating systems distributed by the OS vendors. If the user should compile any other kernel versions into the operating systems, then the configuration shall not be considered officially supported by HDM.

Operating System

Description

Red Hat Enterprise Linux (RHEL)

RHEL 6.6 and 6.7, x86_64 with supplied kernel

RHEL 7, 7.1, and 7.2, x86_64 with supplied kernel

RHEL 7.2, POWER Little-Endian with supplied kernel

RHEL 7.2, POWER Big-Endian with supplied kernel

Community Enterprise Linux (CentOS)

CentOS 6.7, x86_64 with supplied kernel

CentOS 7.2, x86_64 with supplied kernel

SUSE Linux Enterprise Server (SLES)

SLES 11 SP2, 11 SP3, and 11 SP4, x86_64 with supplied kernel

SLES 11 SP4, POWER Big-Endian with supplied kernel

SLES 12 and 12 SP1, x86_64 with supplied kernel

Ubuntu Server Linux

Ubuntu 14.04, 15.04, and 16.04, x86_64, with supplied kernel

Ubuntu 15.04 and 16.04, POWER Little-Endian with supplied kernel

Microsoft Windows

Windows Server 2008 R2, 64-bit

Windows Server 2012, 64-bit

Windows Server 2012 R2, 64-bit

Windows 7, 64-bit

Windows 8 and 8.1, 64-bit

Installation

Overview

This section addresses issues regarding the compatibility, system requirements, installation and configuration of HDM.

Prerequisites

Operating Systems

Table 3: Supported Operating Systems

HGST Device Manager User Guide – Version 3.2

Prerequisite

Description

Linux Distributions

root

Microsoft Windows

Administrator

The minimum version of the HGST NVMe driver required by HDM 3.2 is 1.0.1.50625. The corresponding driver file names will be prefixed by “HGST-NVMe-10150625”.

It is strongly recommended to upgrade Serial Attached SCSI (SAS) Host Bus Adapters (HBAs) or RAID controllers to the latest driver.

Prerequisite

Description

HGST NVMe Windows Driver

Windows NVMe Driver provided by HGST, Inc.

Note: HDM is not compatible with Windows In-box NVMe drivers due to the limitations of these drivers.

HGST NVMe Linux Driver

Linux NVMe Driver provided by HGST, Inc.

Linux In-box NVMe Drivers

NVMe drivers included with Linux Distributions.

HBA and RAID controller Drivers

Drivers provided by vendors of Host Bus Adapters and RAID controllers.

User Privileges

Supported Drivers

Table 4: User Privileges

Table 5: Supported Drivers

HGST Device Manager User Guide – Version 3.2

Prerequisite

Description

CPU

Intel Single-Core 64-bit Processor

AMD x86_64 Processor

Display

1024 x 768 or higher resolution monitor.

Hard Disk Drive

2.0 MB available disk space minimum.

Memory

512MB RAM

Network

Internet connection required for downloads and upgrades.

Optical Drive

CD-ROM/DVD-ROM optional.

Peripherals

Keyboard and Mouse (Printer optional).

System Hardware Requirements

Table 6: System Hardware Requirements

HGST Device Manager User Guide – Version 3.2

Part Number

Installation Package

Description

66000-00053-003

HGST Device Manager-3.2.0-win64.msi

For Windows 64-bit platforms

66000-00054-003

hdm-core-3.2.0-x.yy-x86_64.rpm

For RHEL-based Linux 64-bit x86 platforms

66000-00080-001

hdm-core-3.2.0-x.yy-ppc64le.rpm

For RHEL-based Linux 64-bit POWER Little Endian platforms

66000-00081-001

hdm-core-3.2.0-x.yy-amd64.deb

For Debian-based Linux 64-bit x86 platforms

66000-00082-001

hdm-core-3.2.0-x.yy-ppc64el.deb

For Debian-based Linux 64-bit POWER Little Endian platforms

66000-00TBD-001

hdm-core-3.2.0-x.yy-ppc64.deb

For Debian-based Linux 64-bit POWER Big Endian platforms

Note: x = build number, yy = build type

It is strongly recommended that the user completely review each installation procedure respective to the individual platform, including any Installation Notes.

It is strongly recommended that the user uninstall any previous versions of HDM before installing the latest version.

The installation packages are only compatible with 64-bit systems.

The installer will check whether the necessary prerequisite packages are present before continuing the installation.

Ultrastar PCIe NVMe drives require an NVMe driver to function. Most operating systems supported by HDM provide an inbox NVMe driver. HGST also provides an NVMe driver for Linux and Windows. HDM is compatible with all HGST NVMe drivers as well as NVMe drivers for all supported Linux operating systems. HDM is not compatible with inbox NVMe drivers for Windows operating systems due to the limitations of these drivers.

Installation Packages

HDM installers are available for a variety of platforms. It is the responsibility of the user to be knowledgeable of the specific platform on which HDM will be installed. An authorized representative will e-mail the desired version of HDM to the user, or the user may download the package(s) from the HGST Support website. The packages must be unpacked in a default directory or a temporary directory. It is recommended that the user create the default or temporary directories off the root of the drive hierarchy. Table 7: Installation Packages lists the available installer packages and descriptions.

Table 7: Installation Packages

Event Logging

HDM supports the use of event logging as a method of tracking drive health and operation. Event messages are usually logged to and operating system event log such as the Event Viewer (Windows) or /var/log/syslog (Linux).

HGST Device Manager User Guide – Version 3.2

Linux RPM Installation

To install the RPM package(s):

1. Logon to the system with root privileges.

2. Create a temporary installation folder or directory.

3. Download the HDM 3.2 installable (RPM) file to the temporary installation folder or directory. See

Installation Packages to determine which rpm file to download.

4. Open a terminal window and change directories to the temporary installation folder or directory.

5. Use the rpm command to install the RPM file, e.g., rpm -ivh <HDM RPM file name>.

Uninstall Procedure

To uninstall HDM:

1. Logon to the system with root privileges.

2. Open a terminal window or console.

3. Run rpm -e <hdm-core>.

Linux DEB Installation

To install the DEB package(s):

1. Logon to the system with root privileges.

2. Create a temporary installation folder or directory.

3. Download the HDM 3.2 installable (DEB) file to the temporary installation folder or directory. See

Installation Packages to determine which deb file to download.

4. Open a terminal window and change directories to the temporary installation folder or directory.

5. Use the dpkg command to install the DEB file, e.g., dpkg -i <HDM RPM file name>.

Uninstall Procedure

To uninstall HDM:

1. Logon to the system with root privileges.

2. Open a terminal window or console.

3. Run dpkg -r hdm.

HGST Device Manager User Guide – Version 3.2

The user must install the HGST In-house Driver before using HDM to manage HGST devices under Windows.

Windows Installation

To install HDM under Windows:

1. Logon to the system with Administrator privileges.

2. Create a temporary installation folder or directory.

3. Download the HDM 3.2 msi file: HGST Device Manager-3.2.0-win64.msi to the temporary installation folder or directory.

4. Double-click the Installer Package (msi). Notes:

1. If a Microsoft SmartScreen filter message appears informing you that the package being installed cannot be verified, click More Information and then allow the package to be installed.

2. Enter any administrative credentials if so prompted.

5. The HGST Device Manager Setup Window appears.

6. Click Next to continue. The End-User License Agreement will appear.

7. Review the terms of the EULA and then place a check mark in the I accept the terms in the License Agreement check box.

8. Click Next to continue. You are prompted to choose the location of the working directory. The default path will appear in the text box, but you can use the Change… option to navigate to an alternate installation directory.

9. Click Next to continue. You are now prompted to install HGST Device Manager.

10. Click Install. The HDM CLI will be installed.

Uninstall Procedure

To uninstall HDM:

1. Open the Control Panel window.

1.1. Navigate to the Add/Remove Programs panel, or;

1.2. Navigate to the Programs and Features panel.

2. Click the application “HGST Device Manager” or “HDM” in the list to select it.

3. Click the Uninstall button.

4. Confirm the removal of HDM.

Installation Notes

The user will notice that after HDM is installed:

1. All the HDM-related files are contained in the installation path that was specified in the Setup Wizard.

2. The Add/Remove Programs panel or Programs and Features panel under the Control Panel will contain the application of “HGST Device Manager”.

3. All command execution for the CLI requires the use of a terminal / command window and administrator privileges.

HGST Device Manager User Guide – Version 3.2

Argument

Description

Example

--uid (–u)

The unique identifier (UID) of the device.

--uid 1C58STM0001A6758HUSPR3216AHP301

--path (–p)

The OS native path or device instance ID.

--path /dev/nvme0

--alias (-a)

The HDM internal alias.

--alias myssd01

Command Line Interface

Overview

This section explains the usage and capabilities of the Command Line Interface (CLI) and provides basic and advanced device management and diagnostic functions. The CLI can also be used in situations where automated tasks can be compiled as scripts or batch files.

Command Execution

The syntax for command execution is consistent across the various platforms. In this section, the commands are presented in the platform neutral form of hdm. The user should have a practical knowledge of navigating the command line interface for the specific system platform.

Command Syntax

The commands and options use the same syntax across the platforms. The spaces or delimiters are taken literally, while the brackets are ignored:

hdm <command> <command arguments> <device references>

Where hdm is a “meta” command that invokes the various management or administrative commands, while <command> is the actual operation.

Command Argume nts

The <command arguments> (command arguments) may consist of zero or multiple combinations of options or flags. An option is considered an input parameter that requires a user supplied value, while flags modify the command behavior.

Device References

A device-reference describes how a device is accessed when executing a command and may be expressed as shown in Table 8: Device References. See Linux Directory Trees vs. Windows Device

Instance IDs.

Table 8: Device References

Notes:

1. The unique identifier is device specific and HDM uses the following unique identifiers:

1.1. NVMe Controllers: A concatenation of the PCI Vendor ID, Serial Number, Model Number

(Identify Controller Structure).

1.2. NVMe Namespaces: IEEE Extended Unique Identifier (EUI64) (Identify Namespace

Structure).

1.3. SAS Drives: WWNN.

2. While the most intuitive method may be to reference a device using the OS native path, the enumeration of the devices, the controller paths, and namespaces may change after a reboot.

HGST Device Manager User Guide – Version 3.2

Device Reference Examples

For example, the user may want to obtain the properties of a device using the get-info command. The user must therefore specify the device-reference; the OS path, an alias or a device unique identifier.

OS Path Example

The <device-reference> argument is the OS path and follows the --path input option:

hdm get-info --path /dev/nvme0

Alias Example

The <device-reference> argument is the alias that was assigned to the device and follows the --alias input option:

hdm get-info --alias myssd01

Device Unique Identifier Example

The <device-reference> argument is the device unique identifier assigned to the device and follows the --uid input option:

hdm get-info --uid 1C58STM001A6758HUSPR3216AHP301

Linux Directory Tree s vs. Window s Device Instance IDs

It is important to understand that Linux and Windows manage devices using different methods. Linux implements the /dev/ directory tree scheme where the /dev/ directory tree contains all the “device”

files. Examples of device paths on Linux systems are: /dev/nvme0 and /dev/sda However, under Windows, HDM uses the device instance paths or device instance IDs assigned by the

system. A device instance ID is a unique identification string assigned by the Plug and Play (PnP) Manager to each device node in the device tree. The format of the string consists of an instance ID concatenated to a device ID, i.e., <device-ID>\<instance-specific-ID>. The device instance ID is persistent across system restarts. An example of a Windows device instance ID is:

\\?\pci#ven_1c58&dev_0003&subsys_00031c58&rev_05

#4&11cc8299&0&0009#{2accfe60-c130-11d2-b082-00a0c91efb8b}

These entities are shown in the output of most HDM commands using the Device Path property.

+ 56 hidden pages

HGST Device Manager User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual