.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH VERSION "8" "December 2023" "Version Info for openSeaChest_Basics:" "System Administration Utilities"
.SH NAME
Version \- =drive utilities
.SH DESCRIPTION
==========================================================================================
.IP
openSeaChest_Basics \- openSeaChest drive utilities \- NVMe Enabled
Copyright (c) 2014\-2023 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Basics Version: 3.5.4\-6_2_0 X86_64
Build Date: Dec  1 2023
Today: Fri Dec  1 15:18:13 2023        User: current user
.PP
==========================================================================================
Usage
=====
.IP
openSeaChest_Basics [\-d <sg_device>] {arguments} {options}
.PP
Examples
========
.IP
openSeaChest_Basics \fB\-\-scan\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-i\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-SATInfo\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-llInfo\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-smartCheck\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-shortDST\fR \fB\-\-poll\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-abortDST\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-checkPowerMode\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-spinDown\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-testUnitReady\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-smartAttributes\fR hybrid
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-showConcurrentRanges\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-readyLED\fR info
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-readyLED\fR on
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-phySpeed\fR 2
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-phySpeed\fR 3 \fB\-\-sasPhy\fR 1
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-readLookAhead\fR info
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-readLookAhead\fR enable
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-writeCache\fR info
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-writeCache\fR disable
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-downloadFW\fR firmwareFile.bin
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-downloadFW\fR firmwareFile.bin \fB\-\-downloadMode\fR deferred \fB\-\-activateFW\fR
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-displayLBA\fR 1000
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-overwrite\fR 0
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-overwrite\fR 1000 \fB\-\-overwriteRange\fR 2000
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-overwrite\fR 0 \fB\-\-hours\fR 1
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-trim\fR 0
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-trim\fR 1000 \fB\-\-trimRange\fR 2000
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-provision\fR 134217728
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-setMaxLBA\fR 134217728
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-restoreMaxLBA\fR
.PP
Return codes
============
.IP
Generic/Common exit codes
0 = No Error Found
1 = Error in command line options
2 = Invalid Device Handle or Missing Device Handle
3 = Operation Failure
4 = Operation not supported
5 = Operation Aborted
6 = File Path Not Found
7 = Cannot Open File
8 = File Already Exists
9 = Need Elevated Privileges
Anything else = unknown error
.PP
Utility Options
===============
.HP
\fB\-\-echoCommandLine\fR
.IP
Echo the command line entered into the utility on the screen.
.HP
\fB\-\-enableLegacyUSBPassthrough\fR
.IP
Only use this option on old USB or IEEE1394 (Firewire)
products that do not otherwise work with the tool.
This option will enable a trial and error method that
attempts sending various ATA Identify commands through
vendor specific means. Because of this, certain products
that may respond in unintended ways since they may interpret
these commands differently than the bridge chip the command
was designed for.
.HP
\fB\-\-forceATA\fR
.IP
Using this option will force the current drive to
be treated as a ATA drive. Only ATA commands will
be used to talk to the drive.
.TP
\fB\-\-forceATADMA\fR
(SATA Only)
.IP
Using this option will force the tool to issue SAT
commands to ATA device using the protocol set to DMA
whenever possible (on DMA commands).
This option can be combined with \fB\-\-forceATA\fR
.TP
\fB\-\-forceATAPIO\fR
(SATA Only)
.IP
Using this option will force the tool to issue PIO
commands to ATA device when possible. This option can
be combined with \fB\-\-forceATA\fR
.TP
\fB\-\-forceATAUDMA\fR
(SATA Only)
.IP
Using this option will force the tool to issue SAT
commands to ATA device using the protocol set to UDMA
whenever possible (on DMA commands).
This option can be combined with \fB\-\-forceATA\fR
.HP
\fB\-\-forceSCSI\fR
.IP
Using this option will force the current drive to
be treated as a SCSI drive. Only SCSI commands will
be used to talk to the drive.
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Show utility options and example usage (this output you see now)
Please report bugs/suggestions to seaboard@seagate.com.
Include the output of \fB\-\-version\fR information in the email.
.HP
\fB\-\-hideLBACounter\fR
.IP
Use this option to suppress the output from
options that show LBA counters without turning
off all output to the screen.
.HP
\fB\-\-hours\fR [hours]
.IP
Use this option to specify a time in hours
for a timed operation to run.
.HP
\fB\-\-license\fR
.IP
Display the Seagate End User License Agreement (EULA).
.HP
\fB\-\-modelMatch\fR [model Number]
.IP
Use this option to run on all drives matching the provided
model number. This option will provide a closest match although
an exact match is preferred. Ex: ST500 will match ST500LM0001
.HP
\fB\-\-minutes\fR [minutes]
.IP
Use this option to specify a time in minutes
for a timed operation to run.
.HP
\fB\-\-onlyFW\fR [firmware revision]
.IP
Use this option to run on all drives matching the provided
firmware revision. This option will only do an exact match.
.HP
\fB\-\-noTimeLimit\fR
.IP
Use with utility command arguments which have a built in timeout
value. For example, \fB\-\-shortDST\fR has a 10 minute default
timeout. In some cases a good drive may need more time to
complete the test due to other legitimate system activity.
.HP
\fB\-\-noBanner\fR
.IP
Use this option to suppress the text banner that displays each time
openSeaChest is run.
.HP
\fB\-\-onlySeagate\fR
.IP
Use this option to match only Seagate drives for the options
provided
.HP
\fB\-q\fR, \fB\-\-quiet\fR
.IP
Run openSeaChest_Basics in quiet mode. This is the same as
\fB\-v\fR 0 or \fB\-\-verbose\fR 0
.HP
\fB\-\-seconds\fR [seconds]
.IP
Use this option to specify a time in seconds
for a timed operation to run.
.HP
\fB\-v\fR [0\-4], \fB\-\-verbose\fR [0 | 1 | 2 | 3 | 4]
.IP
Show verbose information. Verbosity levels are:
0 \- quiet
1 \- default
2 \- command descriptions
3 \- command descriptions and values
4 \- command descriptions, values, and data buffers
Example: \fB\-v\fR 3 or \fB\-\-verbose\fR 3
.HP
\fB\-V\fR, \fB\-\-version\fR
.IP
Show openSeaChest_Basics version and copyright information & exit
.PP
Utility Arguments
=================
.HP
\fB\-s\fR, \fB\-\-scan\fR
.IP
Scan the system and list all storage devices with logical
/dev/sg<#> assignments. Shows model, serial and firmware
numbers.  If your device is not listed on a scan  immediately
after booting, then wait 10 seconds and run it again.
.HP
\fB\-F\fR, \fB\-\-scanFlags\fR [option list]
.IP
Use this option to control the output from scan with the
options listed below. Multiple options can be combined.
.TP
ata \- show only ATA (SATA) devices
usb \- show only USB devices
scsi \- show only SCSI (SAS) devices
nvme \- show only NVMe devices
interfaceATA \- show devices on an ATA interface
interfaceUSB \- show devices on a USB interface
interfaceSCSI \- show devices on a SCSI or SAS interface
interfaceNVME = show devices on an NVMe interface
sd \- show sd device handles
sgtosd \- show the sd and sg device handle mapping
.HP
\fB\-S\fR, \fB\-\-Scan\fR
.IP
This option is the same as \fB\-\-scan\fR or \fB\-s\fR,
however it will also perform a low level rescan to pick up
other devices. This low level rescan may wake devices from low
power states and may cause the OS to re\-enumerate them.
Use this option when a device is plugged in and not discovered in
a normal scan.
NOTE: A low\-level rescan may not be available on all interfaces or
all OSs. The low\-level rescan is not guaranteed to find additional
devices in the system when the device is unable to come to a ready state.
.HP
\fB\-d\fR, \fB\-\-device\fR [deviceHandle | all]
.IP
Use this option with most commands to specify the device
handle on which to perform an operation. Example: /dev/sg<#>
To run across all devices detected in the system, use the
"all" argument instead of a device handle.
Example: \fB\-d\fR all
NOTE: The "all" argument is handled by running the
.TP
specified options on each drive detected in the
OS sequentially. For parallel operations, please
use a script opening a separate instance for each
device handle.
.HP
\fB\-i\fR, \fB\-\-deviceInfo\fR
.IP
Show information and features for the storage device
.HP
\fB\-\-llInfo\fR
.IP
Dump low\-level information about the device to assist with debugging.
.HP
\fB\-\-SATInfo\fR
.IP
Displays SATA device information on any interface
using both SCSI Inquiry / VPD / Log reported data
(translated according to SAT) and the ATA Identify / Log
reported data.
.HP
\fB\-\-testUnitReady\fR
.IP
Issues a SCSI Test Unit Ready command and displays the
status. If the drive is not ready, the sense key, asc,
ascq, and fru will be displayed and a human readable
translation from the SPC spec will be displayed if one
is available.
.HP
\fB\-\-fastDiscovery\fR
.TP
Use this option
to issue a fast scan on the specified drive.
.HP
\fB\-\-checkPowerMode\fR
.IP
Get the current power mode of a drive.
On SCSI devices, this will only work if the drive has
transitioned from active state to another state.
.HP
\fB\-\-displayLBA\fR [LBA]
.IP
This option will read and display the contents of
the specified LBA to the screen. The display format
is hexadecimal with an ASCII translation on the side
(when available).
.HP
\fB\-\-activateFW\fR
.IP
Use this option to issue the command to activate code that was
sent to the drive using a deferred download command. This will
immediately activate the new code on the drive.
You can use this along with a \fB\-\-downloadFW\fR & \fB\-\-downloadMode\fR to
automatically issue the activate command after the download has
completed.
.TP
WARNING: Firmware activation may affect all LUNs/namespaces for devices
with multiple logical units or namespaces.
.HP
\fB\-\-downloadFW\fR [firmware_filename]
.IP
Download firmware to a Seagate storage product. Use only
device manufacturer authorized firmware data files which are designated
for the specific model drive. Improper use of this option may
harm a device and or its data. You may specify the path (without
spaces) if the firmware data file is in a different location.
This option will use segmented download by default. Use the
\fB\-\-downloadMode\fR option to specify a different download mode.
.TP
WARNING: Firmware updates may affect all LUNs/namespaces
for devices with multiple logical units or namespaces.
.HP
\fB\-\-downloadMode\fR [ auto | full | segmented | deferred | deferred+activate ]
.IP
Use this option along with the \fB\-\-downloadFW\fR option
to set the firmware download mode.
Supported Modes:
.TP
auto \- automatically determines the best mode to use to
perform the firmware update.
.TP
full \- performs a download in one large
transfer to the device.
.TP
segmented \- downloads the firmware in multiple
segments to the device. (Most compatible)
.TP
deferred \- performs a segmented download to the
device, but does not activate the new
firmware until a powercycle or activate
command is sent.
.TP
deferred+activate \- performs a deferred download and
automatically acitvates it for you.
Similar to how a segmented download works
but uses a separate activate command. This
is the recommended mode that "auto" will
select when possible for maximum compatibility
with Windows 10 and later operating systems.
.TP
WARNING: Firmware Updates may affect all LUNs/namespaces for devices
with multiple logical units or namespaces.
.HP
\fB\-\-showLockedRegions\fR
.IP
This option should only be used when performing firmware
updates on legacy products. What this does is it ignores
a failing error code from the OS on the final segment of a
firmware update, but this update is actually successful.
This is needed to workaround hardware or firmware limitations
that were present in some old products.
.HP
\fB\-\-shortDST\fR
.IP
Execute a short diagnostic drive self test. This test can take
up to 2 minutes to complete. Use the \fB\-\-poll\fR argument to make
this operation poll for progress until complete. Use the
\fB\-\-progress\fR dst command to check on the completion percentage
(%) and test result.
NOTE: Short DST may take longer if there is other disk usage
while the DST is running. If the DST takes longer than 10 minutes
it will automatically be aborted while polling for progress.
To override this behavior, use the \fB\-\-noTimeLimit\fR option.
.HP
\fB\-\-poll\fR
.IP
Use this option to cause another operation to poll for progress
until it has completed.  This argument does not return to the
command prompt and prints ongoing completion percentages (%)
.TP
the final test result.
Full drive procedures will take a
.TP
very long time.
Used with \fB\-\-sanitize\fR, or \fB\-\-writeSame\fR (SATA).
.HP
\fB\-\-progress\fR [dst]
.IP
Get the progress for a test that was started quietly without
the polling option (default). You must specify a test you wish to
get progress from. Ex: "\-\-progress dst" or "\-\-progress sanitize"
The progress counts up from 0% to 100%.
.HP
\fB\-\-abortDST\fR
.IP
Abort a diagnostic Drive Self Test that is in progress.
.HP
\fB\-\-phySpeed\fR [0 | 1 | 2 | 3 | 4 | 5]
.IP
Use this option to change the PHY speed to a
new maximum value. On SAS, this option will
set all phys to the specified speed unless the
\fB\-\-sasPhy\fR option is given to select a specific phy.
0 \- allow full negotiation (default drive behavior)
1 \- allow negotiation up to 1.5Gb/s
2 \- allow negotiation up to 3.0Gb/s
3 \- allow negotiation up to 6.0Gb/s
4 \- allow negotiation up to 12.0Gb/s (SAS Only)
5 \- allow negotiation up to 22.5Gb/s (SAS Only)
.IP
NOTE: SATA phy speed changes are only available on Seagate drives.
.TP
WARNING: Check the minimum phy speed supported by your adapter before
using this option. A phy speed below the adapter's capability
will result in the drive not being seen by the adapter or the OS.
.TP
WARNING: Changing Phy speed may affect all LUNs/namespaces for devices
with multiple logical units or namespaces.
.HP
\fB\-\-readLookAhead\fR [info | enable | disable]
.IP
Use this option to enable or disable read look\-ahead
support on a drive. Use the "info" argument to get
the current status of the read look ahead feature.
.TP
WARNING: Changing Read look\-ahead may affect all LUNs/namespaces for devices
with multiple logical units or namespaces.
.HP
\fB\-\-restoreMaxLBA\fR
.IP
Restore the max accessible address of your drive to its native
size. A power cycle is required after this command before
setting a new max LBA.
.HP
\fB\-\-setMaxLBA\fR newMaxLBA
.IP
Set the max accessible address of your drive to any value less
than the device's default native size. A power cycle is
required after this command before resetting or setting a new
max LBA.
.HP
\fB\-\-showConcurrentRanges\fR
.IP
Use this option to display the concurrent positioning ranges
supported by a device. Concurrent positioning ranges are used
to inform which actuator is used for a given range in LBA space.
.HP
\fB\-\-smartCheck\fR
.IP
Perform a SMART check on a device to see if any internal
thresholds have been tripped or if the drive is still operating
within specification.
.HP
\fB\-\-spinDown\fR
.IP
Removes power to the disk drive motor with the Standby Immediate
command. Use this before moving a hard disk drive. The drive
will spin back up if the operating system selects the drive.
This means that an active drive will not stay spun down.
.TP
WARNING: Spindown may affect all LUNs/namespaces for devices
with multiple logical units or namespaces.
.HP
\fB\-\-writeCache\fR [info | enable | disable]
.IP
Use this option to enable or disable write cache
support on a drive. Use the "info" argument to get
the current status of the write cache feature.
.TP
WARNING: Changing Write Cache may affect all LUNs/namespaces for devices
with multiple logical units or namespaces.
.IP
SATA Only:
=========
\fB\-\-smartAttributes\fR [raw | hybrid | analyzed]     (SATA Only)
.IP
The drive will display its list of supported SMART attributes.
Some attributes names are commonly standard and most others are
vendor unique. In either case, the attribute thresholds are
always vendor unique. Most attributes are informational and not
used to determine a warranty return. Use the \fB\-\-smartCheck\fR
command to determine if one of the warranty attributes has been
tripped. Seagate Support does not help to analyze SMART
attributes.
Output modes:
.IP
raw \- All hex output for those that need every single bit.
hybrid \- classic table view with some interpretation of some
.TP
fields. Partial raw interpretation, but not all drive
and firmware combinations are supported.
.TP
analyzed \- a full breakdown of all parts of each individual
attribute's data. Full raw data interpretation only
available on select devices.
.IP
NOTE: Migration to device statistics is recommended.
.IP
SAS Only:
=========
\fB\-\-readyLED\fR [info | on | off | default] (SAS Only)
.IP
Use this option to get the current state or change the
behavior of the ready LED.
See the SPL spec for full details on how this changes LED
.TP
info \- gets the current state of the ready LED.
on \- sets the ready LED to usually off unless
.TP
processing a command.
off \- sets the ready LED to usually on unless
.TP
processing a command
default \- sets the ready LED to the drive's default value
.TP
WARNING: The EPC settings may affect all LUNs/namespaces for devices
with multiple logical units or namespaces.
.HP
\fB\-\-sasPhy\fR [phy number] (SAS Only)
.IP
Use this option to specify a specific phy to use
with another option that uses a phy identifier value.
Some tool options will assume all SAS Phys when this
option is not present. Others will produce an error when
a specific phy is needed for an operation.
Use the \fB\-i\fR option to learn more about the supported phys.
.PP
Data Destructive Commands
=========================
.TP
\fB\-\-overwrite\fR [starting LBA]
(Clear)
.IP
Use this option to start an overwrite erase at
the specified starting LBA. Combine this option
with overwriteRange or time options (hours, minutes
seconds) to erase a portion of the drive.
.TP
\fB\-\-overwriteRange\fR [range in # of LBAs]
(Clear)
.IP
Use with the overwrite option (\fB\-\-overwrite\fR) to
erase a range of LBAs on the selected drive.
.HP
\fB\-\-provision\fR newMaxLBA
.IP
Provision your drive to a new max LBA to any value less
than the device's current max LBA. A power cycle is required
after this command before resetting the max LBA or changing
the provisioning again. This command erases all data between
the new maxLBA specified and the current maxLBA of the device.
using a TRIM/UNMAP command.
.HP
\fB\-\-trim\fR or \fB\-\-unmap\fR [starting LBA]
.IP
Use one of these options to start a trim or
unmap operation on a drive at the provided LBA.
A range must also be provided with the range option.
.HP
\fB\-\-trimRange\fR or \fB\-\-unmapRange\fR [range in # of LBAs]
.IP
Use one of these options to specify a range to trim
or unmap on a drive. A starting point must be specified
with the \fB\-\-trim\fR/\-\-unmapRange option.
.IP
Utility Version: 3.5.4
opensea\-common Version: 2.0.0
opensea\-transport Version: 6.2.0
opensea\-operations Version: 5.1.1
Build Date: Dec  1 2023
Compiled Architecture: X86_64
Detected Endianness: Little Endian
Compiler Used: GCC
Compiler Version: 7.5.0
Operating System Type: Linux
Operating System Version: 4.15.0\-211
Operating System Name: Ubuntu 18.04.6 LTS