-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Adding openSeaChest_Reservations man page
Signed-off-by: Tyler Erickson <tyler.erickson@seagate.com>
- Loading branch information
1 parent
c8bc4e6
commit 2604817
Showing
1 changed file
with
386 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,386 @@ | ||
| .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. | ||
| .TH VERSION "8" "December 2023" "Version Info for openSeaChest_Reservations:" "System Administration Utilities" | ||
| .SH NAME | ||
| Version \- =drive utilities | ||
| .SH DESCRIPTION | ||
| ========================================================================================== | ||
| .IP | ||
| openSeaChest_Reservations \- openSeaChest drive utilities \- NVMe Enabled | ||
| Copyright (c) 2014\-2023 Seagate Technology LLC and/or its Affiliates, All Rights Reserved | ||
| openSeaChest_Reservations Version: 0.2.1\-6_2_0 X86_64 | ||
| Build Date: Dec 1 2023 | ||
| Today: Fri Dec 1 15:18:14 2023 User: current user | ||
| .PP | ||
| ========================================================================================== | ||
| Usage | ||
| ===== | ||
| .IP | ||
| openSeaChest_Reservations [\-d <sg_device>] {arguments} {options} | ||
| .PP | ||
| NOTE: This utility only supports persistent reservations. | ||
| .IP | ||
| SCSI 2 reservations are not supported. | ||
| .PP | ||
| Examples | ||
| ======== | ||
| .IP | ||
| openSeaChest_Reservations \fB\-\-scan\fR | ||
| openSeaChest_Reservations \fB\-d\fR /dev/sg<#> \fB\-i\fR | ||
| openSeaChest_Reservations \fB\-d\fR /dev/sg<#> \fB\-\-SATInfo\fR | ||
| openSeaChest_Reservations \fB\-d\fR /dev/sg<#> \fB\-\-llInfo\fR | ||
| openSeaChest_Reservations \fB\-d\fR /dev/sg<#> \fB\-\-showPReservationCapabilties\fR | ||
| openSeaChest_Reservations \fB\-d\fR /dev/sg<#> \fB\-\-showFullPReservationInfo\fR | ||
| openSeaChest_Reservations \fB\-d\fR /dev/sg<#> \fB\-\-showPRegistrationKeys\fR | ||
| openSeaChest_Reservations \fB\-d\fR /dev/sg<#> \fB\-\-showPReservations\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\-\-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\-\-noBanner\fR | ||
| .IP | ||
| Use this option to suppress the text banner that displays each time | ||
| openSeaChest is 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\-\-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_Reservations in quiet mode. This is the same as | ||
| \fB\-v\fR 0 or \fB\-\-verbose\fR 0 | ||
| .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_Reservations version and copyright information & exit | ||
| .PP | ||
| Utility Arguments | ||
| ================= | ||
| .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\-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\-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\-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\-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\-\-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. | ||
| .TP | ||
| \fB\-\-prAllTargetPorts\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option when registering a new key to specify | ||
| that it applies to all target ports. | ||
| NOTE: Not all devices will support this option | ||
| .TP | ||
| \fB\-\-prClear\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option to clear all reservations using a key that is specified by | ||
| the \fB\-\-prKey\fR option. | ||
| The specified key must already be registered with the device. | ||
| .TP | ||
| \fB\-\-prKey\fR [key] | ||
| (NVMe & SAS Only) | ||
| .IP | ||
| Use this option to specify the key to use for persistent | ||
| reservation options. When registering a key, this provides | ||
| the value expected for your use. It should continue to be used | ||
| through all persistent reseve operations until unregistered or | ||
| cleared. | ||
| .TP | ||
| \fB\-\-prPersistThroughPowerLoss\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option when registering a new key to activate | ||
| the persist through power loss capability. | ||
| NOTE: Not all devices will support this option | ||
| .TP | ||
| \fB\-\-prPreempt\fR [reservation key to preempt] | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option to preempt another reservation using a registration key | ||
| .IP | ||
| that is specified by the \fB\-\-prKey\fR option. | ||
| .IP | ||
| The specified key must already be registered with the device. | ||
| This is used to remove a reservation from another initiator and start | ||
| a new one using the specified registration key. \fB\-\-prType\fR must also | ||
| be provided to specify the type of reservation that should be active | ||
| once the preempt has completed. | ||
| Use with the \fB\-\-prPreemptAbort\fR option to cause the preempt to abort all | ||
| outstanding commands to the previous reservation holder. | ||
| .TP | ||
| \fB\-\-prPreemptAbort\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option to cause a preempt to abort commands to the previous | ||
| reservation holder. This must be used in combination with the | ||
| \fB\-\-prPreempt\fR option in order to specify the key to preempt. | ||
| .TP | ||
| \fB\-\-prRegister\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option to register a new key as specified by | ||
| the \fB\-\-prKey\fR option. | ||
| Combine this with the following options as needed: | ||
| \fB\-\-prAllTargetPorts\fR | ||
| \fB\-\-prPersistThroughPowerLoss\fR | ||
| \fB\-\-prRegisterIgnore\fR | ||
| .TP | ||
| \fB\-\-prRegisterIgnore\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option when registering a new key to instruct | ||
| the device to ignore any previous registration key | ||
| that has already been registered from the same initiator | ||
| NOTE: Not all devices will support this option | ||
| .TP | ||
| \fB\-\-prRelease\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option to release reservation using a key that is specified by | ||
| the \fB\-\-prKey\fR option. | ||
| The specified key must already be registered with the device and must | ||
| have an active reservation that can be released. | ||
| Use the \fB\-\-prType\fR option to specifiy the reservation type | ||
| to release. | ||
| .TP | ||
| \fB\-\-prReserve\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option to acquire a reservation using a key that is specified by | ||
| the \fB\-\-prKey\fR option. | ||
| The specified key must already be registered with the device. | ||
| Use the \fB\-\-prType\fR option to specifiy the reservation type | ||
| to acquire. | ||
| .TP | ||
| \fB\-\-prType\fR [wrex | ex | wrexro | exro | wrexar | exar] | ||
| (NVMe and SAS only) | ||
| .IP | ||
| This option specifies the type of reservation to hold. | ||
| This is required for acquiring, preempting, and releasing | ||
| reservations. | ||
| Available reservation types: | ||
| .TP | ||
| wrex | ||
| \- write exclusive | ||
| .TP | ||
| ex | ||
| \- exclusive access | ||
| .TP | ||
| wrexro \- write exclusive, registrants only | ||
| exro \- exclusive access, registrants only | ||
| wrexar \- write exclusive, all registrants | ||
| exar \- exclusive access, all registrants | ||
| .TP | ||
| \fB\-\-prUnregister\fR | ||
| (NVMe & SAS only) | ||
| .IP | ||
| Use this option to unregister a key that is specified by | ||
| the \fB\-\-prKey\fR option. | ||
| .TP | ||
| \fB\-\-showFullPReservationInfo\fR | ||
| (NVMe & SAS Only) | ||
| .IP | ||
| This options reads the persistent reservation full | ||
| information (registrations and reservations) and | ||
| prints it to the screen. | ||
| .HP | ||
| \fB\-\-showPRegistrationKeys\fR (NVMe & SAS Only) | ||
| .IP | ||
| This options reads the persistent reservation | ||
| registration keys and prints it to the screen. | ||
| .TP | ||
| \fB\-\-showPReservations\fR | ||
| (NVMe & SAS Only) | ||
| .IP | ||
| This options reads the persistent reservation | ||
| reservations and prints it to the screen. | ||
| .TP | ||
| \fB\-\-showPReservationCapabilties\fR | ||
| (NVMe & SAS Only) | ||
| .IP | ||
| This options shows the persistent reservation | ||
| capabilities for a device. | ||
| NOTE: Older device supporting SPC or SPC2 may not support | ||
| showing capabilities, but do support persistent reservations. | ||
| .IP | ||
| Utility Version: 0.2.1 | ||
| 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 |