Provided by: openseachest_24.08.1-1_amd64 
NAME
openSeaChest_Logs - manual page for openSeaChest_Logs
==========================================================================================
DESCRIPTION
==========================================================================================
openSeaChest_Logs - openSeaChest drive utilities - NVMe Enabled Copyright (c) 2014-2024 Seagate
Technology LLC and/or its Affiliates, All Rights Reserved openSeaChest_Logs Version: 2.5.0-8_0_1
X86_64 Build Date: Sep 19 2024 Today: 20240925T133706 User: current user
========================================================================================== Usage =====
openSeaChest_Logs [-d <sg_device>] {arguments} {options}
Examples ========
openSeaChest_Logs --scan openSeaChest_Logs -d /dev/sg<#> -i openSeaChest_Logs -d /dev/sg<#>
--SATInfo openSeaChest_Logs -d /dev/sg<#> --llInfo openSeaChest_Logs -d /dev/sg<#> --farm
--outputPath logs --logMode pipe openSeaChest_Logs -d /dev/sg<#> --farmCombined
--logTransferLength 64KiB --logMode bin openSeaChest_Logs -d /dev/sg<#> --deviceStatistics
openSeaChest_Logs -d /dev/sg<#> --listSupportedLogs openSeaChest_Logs -d /dev/sg<#> --pullLog C6h
openSeaChest_Logs -d /dev/sg<#> --pullLog 0Dh --pullSubpage 01h --logMode bin openSeaChest_Logs -d
/dev/sg<#> --listErrorHistoryIDs openSeaChest_Logs -d /dev/sg<#> --pullErrorHistoryID 30 --logMode
bin
Return codes ============
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
Utility Options ===============
--csmiIgnorePort (Obsolete)
This option is obsolete and will be removed in future versions.
--csmiUsePort (Obsolete)
This option is obsolete and will be removed in future versions.
--csmiVerbose (Obsolete)
This option is obsolete and will be removed in future versions.
--echoCommandLine
Echo the command line entered into the utility on the screen.
--enableLegacyUSBPassthrough
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.
--forceATA
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.
--forceATADMA
(SATA Only)
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 --forceATA
--forceATAPIO
(SATA Only)
Using this option will force the tool to issue PIO commands to ATA device when possible. This
option can be combined with --forceATA
--forceATAUDMA
(SATA Only)
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 --forceATA
--forceSCSI
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.
-h, --help
Show utility options and example usage (this output you see now) Please report bugs/suggestions to
seaboard@seagate.com. Include the output of --version information in the email.
--license
Display the Seagate End User License Agreement (EULA).
--modelMatch [model Number]
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
--noBanner
Use this option to suppress the text banner that displays each time openSeaChest is run.
--onlyFW [firmware revision]
Use this option to run on all drives matching the provided firmware revision. This option will
only do an exact match.
--onlySeagate
Use this option to match only Seagate drives for the options provided
--outputPath [folder]
To set a path to the directory/folder where all logs should be created. The directory/folder must
already exist with write permissions If this option is not used, logs are created in the current
working folder
-q, --quiet
Run openSeaChest_Logs in quiet mode. This is the same as -v 0 or --verbose 0
-v [0-4], --verbose [0 | 1 | 2 | 3 | 4]
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: -v 3
or --verbose 3
-V, --version
Show openSeaChest_Logs version and copyright information & exit
Utility Arguments =================
-d, --device [deviceHandle | all]
Use this option with most commands to specify the device handle on which to perform an operation.
Example: /dev/sg<#> CSMI device handles can be specified as <error<#><#><#>> To run across all
devices detected in the system, use the "all" argument instead of a device handle. Example: -d
all NOTE: The "all" argument is handled by running the
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.
-F, --scanFlags [option list]
Use this option to control the output from scan with the options listed below. Multiple options
can be combined.
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 ignoreCSMI
- do not scan for any CSMI devices allowDuplicates - allow drives with both CSMI and PD handles
to show up multiple times in the list
-i, --deviceInfo
Show information and features for the storage device
--llInfo
Dump low-level information about the device to assist with debugging.
-s, --scan
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.
-S, --Scan
This option is the same as --scan or -s, 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.
--SATInfo
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.
--testUnitReady
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.
--fastDiscovery
Use this option
to issue a fast scan on the specified drive.
--deviceStatisticsLog
This option will pull the Device Statistics Log from a device.
--farm
Pull the Seagate Field Accessible Reliability Metrics (FARM) Log from the specified drive. Saves
the binary logs to the current directory as <serialnumber>FARM<date and time>.bin (as default)
--farmCombined
Pull the Seagate Combined Field Accessible Reliability Metrics (FARM) Log from the specified
drive. This log contains a combination of all FARM Sub Log Pages in a single Log File.Saves the
binary logs to the current directory as <serialnumber>FARMC<date and time>.FRMC
--listSupportedLogs
Displays a list of all supported logs by this device type.
--logLength [length in bytes]
(NVMe Only)
Use this option to specify the total length of a log to retrieve from a device. This is required
for NVMe logs not part of the standards or not currently known by this utility in order to
retrieve all the data. The following post fixes are allowed for specifying a transfer length:
BLOCKS or SECTORS - used to specify a transfer length
in device in 512Byte blocks/sectors
KB - length in kilobytes (val * 1000)
KiB - length in kibibytes (val * 1024) MB - length in megabytes (val * 1000000) MiB - length in
mebibytes (val * 1048576)
--logMode [mode]
Sets the mode to pull the log. Use this option with --pullLog to set the desired mode
raw - Pulls log & prints it to the
screen as stdout.
bin - Pulls log & saves it to
a timestamped binary file. (default)
pipe - Pulls log, prints it to the
screen as stdout & send the result to openSeaChest_LogParser. (available for FARM only)
--logTransferLength [length in bytes]
Use this option to specify the data transfer length for a log transfer. Larger transfer sizes may
speed up log retrieval at the loss of compatibility. The following post fixes are allowed for
specifying a transfer length:
BLOCKS or SECTORS - used to specify a transfer length
in device in 512Byte blocks/sectors
KB - length in kilobytes (val * 1000)
KiB - length in kibibytes (val * 1024) MB - length in megabytes (val * 1000000) MiB - length in
mebibytes (val * 1048576)
ATA drives must be given a value in 512B increments. Warning: Specifying a large size may result
in failures due to OS, driver, or HBA/bridge specific limitations.
--pullLog [Log Number]
Pulls specific log number from the device [Log Number] is required argument & can be passed as an
decimal or hex value. WARNING: Vendor Unique Logs pulled using this option
may not be valid due to unknown vendor unique
bits in ATA/SCSI/NVMe etc. command fields.
--selfTestLog
This option will pull the self test results log from a device. On ATA drives, this will pull the
extended SMART self tests result log when it is supported by the device.
SATA Only:
--identifyDataLog
(SATA only)
This option will pull the Identify Device data log from an ATA drive.
--SATAFarmCopyType [ disc | flash ]
(SATA Only)
Use this option to provide copy type while extracting FARM copy type with --farmCombined option.
The default mode is "disc"
disc - Pull Disc copy of SATA Farm logs.
flash - Pull Flash copy of SATA Farm logs.
--SATAPhyCntLog
(SATA only)
This option will pull the SATA Phy Event Counters log from a SATA drive.
SAS Only:
--listErrorHistoryIDs
(SAS Only)
Displays a list of all supported error history buffer IDs supported by the device.
--pullErrorHistoryID [Buffer ID]
(SAS Only)
Pulls specific error history buffer ID from the device [Buffer ID] is required argument & can be
passed as an decimal or hex value. WARNING: Vendor Unique Logs pulled using this option
may not be valid due to unknown vendor unique
bits in ATA/SCSI/NVMe etc. command fields.
--infoExceptionsLog
(SAS only)
This option will pull the SCSI Informational Exceptions log page from a SCSI device.
--pullSubpage [Subpage Number]
(SAS Only)
Use this option with the --pullLog option to specify a log subpage to pull. Use this for SCSI
Logs. [Subpage Number] can be passed as an decimal or hex value. WARNING: Vendor Unique Logs
pulled using this option
may not be valid due to unknown vendor unique
bits in ATA/SCSI/NVMe etc. command fields.
openSeaChest_Logs - openSeaChest drive utilities - NVMe Enabled Copyright (c) 2014-2024 Seagate
Technology LLC and/or its Affiliates, All Rights Reserved openSeaChest_Logs Version: 2.5.0-8_0_1
X86_64 Build Date: Sep 19 2024 Today: 20240925T133706 User: current user
========================================================================================== Version Info
for openSeaChest_Logs:
Utility Version: 2.5.0 opensea-common Version: 4.1.0 opensea-transport Version: 8.0.1
opensea-operations Version: 8.0.2 Build Date: Sep 19 2024 Compiled Architecture: X86_64 Detected
Endianness: Little Endian Compiler Used: GCC Compiler Version: 11.4.0 Operating System Type: Linux
Operating System Version: 5.15.153-1 Operating System Name: Ubuntu 22.04.4 LTS
SEE ALSO
The full documentation for openSeaChest_Logs is maintained as a Texinfo manual. If the info and
openSeaChest_Logs programs are properly installed at your site, the command
info openSeaChest_Logs
should give you access to the complete manual.
openSeaChest_Logs ===========================... September 2024 OPENSEACHEST_LOGS(1)