------- HUGO README --------
Copyright (c) HGST, a Western Digital Company 2016

Description:
HUGO is a CL tool used to perform maintenance functions on HGST devices.  Any of the HUGO commands may be executed as a one time command from the terminal or from within the interactive session.  Root authority is required to execute the HUGO CL tool.

Linux Install Instructions:
     RPM
	rpm -ivh <hugo_package_name>.rpm
     Debian
	sudo dpkg -i <hugo_package_name>.deb

     Local install option (no files written outside of the install directory)
	tar xzvf <hugo_package_name>.tar.gz

Windows Install Instructions:
    Run the HUGO-6.x.x-win32.exe installer
    From the installed directory(C:\Program Files (x86)\HUGO 6.1.1\bin) run hugo.exe with Administrator privileges. 

Usage:  
With root authority, start the application by running one of the following:

    hugo                             <--- launch interactive session

    hugo <command> [command options] <--- run command

  Commands:

    a, abort
        Abort a running self test.

    e, erase
        Erase all or part of the device.

    do-not-operate
       Add a device to the list of do not operate devices.

    f, format
        Format a device.

    eula
        Show the End User License Agreement.

    h, help
        Show the command help output.

    l, logdump
        Dump logs from devices.

    q, quit
        Exit the CLI.

    s, show
        Show a list of connected devices. Also refreshes device list.

    sanitize
        Sanitize a device.

    t, test
        Run a drive self test.

    u, update
        Update device Firmware.

    v, version
        Show the version information.

    HGST CLI


Abort Command Usage:
    abort  {-s <serial number>|-m <model number>|-a} [-h]

        -s, --serial - abort running DST on drive with the given serial number
        -m, --model  - abort running DST on all connected drives with the given model string
        -a, --all    - abort running DST on all connected (not locked) devices
        -h, --help   - display command help text

Show Command Usage:	
    show  [--hgst-firmware] [-l] [-m] [-w] [-h]

        --hgst-firmware     - show the HGST firmware revision for each device
        -l, --locked        - show locked devices
        -m, --message       - display messages returned from the latest drive self test 
        -b, --block-size    - Show the block size of each device
        -w, --wwn           - show the world wide name of each device
        -h, --help          - display command help text

    Columns displayed on the show command
     
        Manuf.    - Manufacturer of the device
        Model     - Model number of the device
        Serial    - Serial number of the device
        Interface - Communication protocol used by the device
        Capacity  - Size of the device in GB
        Type      - HDD or SSD
        Firmware  - Current firmware level on the device
        Status    - Current device status.  Except in the case of a failed DST, then status would show a "Failed" test state, however the device is still ready to receive commands. 

    Additional information displayed if specified by a flag

        WWN               - World wide name of the device
        HGST Firmware     - The HGST firmware of the device, it may be different from the customer's firmware revision
        Self test message - A description of why the device failed its self-test

Logdump Command Usage:
    logdump  {-s <serial number>|-m <model number>|-a} -p <output file path> [-h]

        -s, --serial        - dump logs on drive with the given serial number
        -m, --model         - dump logs of all connected drives with the given model string
        -a, --all           - dump logs of all connected (not locked) devices
        -p, --path          - Directory where logs will be written to
        -h, --help          - display command help text
        --all-modes         - Collects all available logs
        --partial-context   - Collects device partial context data
        --fly-height        - Collects device Fly-height data
        --p-list            - Collects device P-List data
        --ati               - Collects device Adjacent Track Interference (ATI) data
        --south-dump        - Collects debug information for SSDs only
        --short             - A small log for data-collection purposes
        --force-rra         - Option for CCB SATA drives that can be used on hardware that does not allow vendor unique commands.

Format Command Usage:
    format  {-m <model number>|-s <serial number>} [--fastformat] [--merge] [-n <number of blocks>] [-b <block size>] [-h]

        -m <model number>,  --model <model number> (OR required)  Format all devices of specified model number
        -s <serial number>,  --serial <serial number> (OR required)  Format device specified by serial number
        --fastformat Set Fast Format flag
        --merge Set Merge G-List and P-List flag
        -n <number of blocks>,  --numblocks <number of blocks>
          Specify number of blocks to Format. Default: Current size. Specifying 'max' will format to maximum number of blocks supported by the device.
        -b <block size>,  --blocksize <block size> Format the device to a specified Block size (512, 4096).
        -h,  --help Displays usage information and exits.

Test Command Usage:
    test  {-q|-l} {-s <serial number>|-m <model number>|-a} [-f] [-h]

        -q, --quick      - Run a quick self test
        -l, --long       - Run a long self test
        -s, --serial     - Execute DST on drive with the given serial number
        -m, --model      - Execute DST on all connected drives with the given model string
        -a, --all        - Execute DST on all connected (not locked) devices
        -f, --foreground - Execute DST in the forground, job progress will be displayed in the terminal window.  All other commands will be blocked until all running tests are completed or aborted.
        -h, --help       - display command help text

Update Command Usage:
    update  {-s <serial number>|-m <model number>} -f <fw file path> [-h]

        -s, --serial   - update firmware for drive with the given serial number
        -m, --model    - update firmware of all connected drives with the given model string
        -f, --firmware - Firmware update file
        -h, --help     - display command help text
        --skip-status  - Allow updates when drive status is "Unknown"

Erase Command Usage:
    erase  {-t|-f} {-m <model number>|-s <serial number>} [--force] [-h]

        -t, --table  - erase the partition table
        -f, --full   - write 0's to the entire device, if it fails or is cancelled a manual restart of the command is required and it will start back at the beginning of the drive. This command will go into foreground mode and prevent any other Hugo command from executing.
        -m, --model  - erase drives that have the specified model number
        -s, --serial - erase the drive with the specified serial number
        --force      - used to bypass any user prompted questions, this is useful for scripting mode
        -h, --help   - display command help text

Sanitize Command Usage: 
   sanitize  {-b|-c} {-m <model number>|-s <serial number>} [-a] [-h]

        -b,  --block (OR required)  Perform Sanitize block erase operation
         -- OR --
        -c,  --crypto (OR required)  Perform Sanitize cryptographic erase operation
        -m <model number>,  --model <model number> (OR required)  Sanitize all devices of specified model number
         -- OR --
        -s <serial number>,  --serial <serial number> (OR required)  Sanitize device specified by serial number
        -a,  --ause  Set AUSE bit. (see Sanitize SCSI Spec.)
        -h,  --help  Displays usage information and exits.

do-not-operate Command Usage:
   do-not-operate  {-d|-s <serial number>|-c} [-h]

        -d,  --display (OR required)  Print a list of all devices from Do Not Operate list.
         -- OR --
        -s <serial number>, --serial <serial number> (OR required)  Add this device to the Do Not Operate list.
         -- OR --
        -c,  --clear (OR required)  Clear all devices from Do Not Operate list.
        -h,  --help  Displays usage information and exits.

Command examples:

    Print command help
        Interactive:
            help
        Command line:
            hugo help
    
    Print or refresh the list of attached devices and device status:
        Interactive:
            show
        Command line:
            hugo show

    Print a list of devices that are locked:
        Interactive:
            show -l
        Command line:
            hugo show -l

    Print a list of devices and display messages from the previous drive self test:
        Interactive:
            show -m
        Command line:
            hugo show -m

    Format a device to max size:
        Interactive:
            format --serial <serial_number> -n max

        Command line:
            hugo format --serial <serial_number> -n max

    Format a device to max size, setting block size to 4k:
        Interactive:
            format --serial <serial_number> -n max -b 4096

        Command line:
            hugo format --serial <serial_number> -n max -b 4096

    Dump device logs of all devices to a give directory:
        Interactive:
            logdump -a -p /path/to/logs/
        Command line:
            hugo logdump -a -p /path/to/logs/

    Dump device logs of a single device specified by serial number: (run the show command to find a serial number)
        Interactive:
            logdump -s 2HV001AB -p /path/to/logs/
        Command line:
            hugo logdump -s 2HV001AB -p /path/to/logs/

    Dump device logs of all devices of the same model number: (run the show command to find a model number)
        Interactive:
            logdump -m HUS001001ABCD400 -p /path/to/logs/
        Command line:
            hugo logdump -m HUS001001ABCD400 -p /path/to/logs/

    Run a long DST on all devices in the foreground
        Interactive:
            test -l -a -f
        Command line:
            hugo test -l -a -f

    Run a quick DST on all devices of the same model number in the background: (run the show command to find a model number)
        Interactive:
            test -q -m HUS001001ABCD400
        Command line:
            hugo test -q -m HUS001001ABCD400

    Abort running tests on all devices
        Interactive:
            abort -a
        Command line:
            hugo abort -a

    Abort a running test on a single device specified by serial number: (run the show command to find a serial number)
        Interactive:
            abort -s 2HV001AB
        Command line:
            hugo abort -s 2HV001AB

    Load new Firmware on a single device specified by serial number: (run the show command to find a serial number)
        Interactive:
            update -f /path/to/file/<firmware_file_name> -s 2HV001AB
        Command line:
            hugo update -f /path/to/file/<firmware_file_name> -s 2HV001AB

    Load new Firmware on all devices of the same model number: (run the show command to find a model number)
        Interactive:
            update -f /path/to/file/<firmware_file_name> -m HUS001001ABCD400
        Command line:
            hugo update -f /path/to/file/<firmware_file_name> -m HUS001001ABCD400

    Erase the partition table from a device:
        Interactive:
            erase -t -s 2HV001AB
        Command line (needs --force if you don't want the script to be prompted):
            hugo erase -t -s 2HV001AB --force

    Do a full drive erase, write zeros to the entire drive:
        Interactive:
            erase -f -s 2HV001AB
        Command line (needs --force if you don't want the script to be prompted):
            hugo erase -f -s 2HV001AB --force

    Do a cryptographic sanitize erase operation on a single device specified by serial number: (run the show command to find a serial number)
        Interactive:
            sanitize -c -s 2HV001AB
        Command line (needs --force if you don't want the script to be prompted):
            hugo sanitize -c -s 2HV001AB --force

    Do a block sanitize erase operation on all drives of the same model number: (run the show command to find a model number)
        Interactive:
            sanitize -b -m HUS001001ABCD400
        Command line (needs --force if you don't want the script to be prompted):
            hugo sanitize -b -m HUS001001ABCD400 --force

    Check the drives currently on the do-not-operate list:
        Interactive:
            do-not-operate -d

    Clear the do-not-operate list to return all of the hidden drives to the show command:
        Interactive:
            do-not-operate -c

    Add a drive to the do-not-operate list:
        Interactive:
            do-not-operate -s 2HV001AB

    Exit the application:
        q
        quit
        exit