The scripts within this project are for useful operations across all supported operating systems which include various utilities.

• Warnings
• Getting Started
• Prerequisites
• Setup
• Scripts
  • BadBlocks
    • run_badblocks.sh
    • run_badblocks_operational.sh
    • run_badblocks_destructive.sh
  • CP
    • copy_all_files_to_dir.sh
  • Imaging
    • run_imaging.sh
    • run_imaging_read_write.sh
    • run_imaging_read.sh
    • run_imaging_write.sh
  • Processing
    • parallel_commands.sh
  • SCP
    • scp_from_remote.sh
    • scp_to_remote.sh
  • SMART
    • read_smart_test_results.sh
    • run_smart_test.sh
    • run_smart_test_with_polling.sh
    • run_smart_conveyance_test.sh
    • run_smart_short_test.sh
    • run_smart_long_test.sh
  • SSH
    • connect.sh
    • run_command.sh
    • run_script.sh
  • Status
    • list_drives.sh
    • list_all_drives.sh
    • list_all_drives_smartctl.sh
    • list_all_drives_sysctl.sh
    • list_smart_drives.sh
    • list_smart_drives_smartctl.sh
    • list_smart_drives_sysctl.sh
  • TMUX
    • start_tmux_session.sh
    • end_tmux_session.sh
    • attach_tmux_session.sh
    • detach_tmux_session.sh
    • select_session_pane.sh
    • send_tmux_pane_command.sh
    • send_tmux_shell_command.sh
    • set_layout.sh
    • set_layout_tiled.sh
    • split_window_horizontal.sh
    • split_window_vertical.sh
• Deployment
• Dependencies
• Notes
• Test Environments
  • Operating System Compatibility
  • Hardware Compatibility
• Contributing
• Support
• Versioning
• Authors
• Copyright
• License
• Acknowledgments

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

This project does not contain any prerequisites at this time.

This project does not contain any setup at this time. All you need to do is place the scripts onto your system and execute the desired functionality.

A script to run a BadBlocks test in destructive or operational (Non-Destructive) mode.

Usage

[bash] ./run_badblocks.sh [auto_skip] <drive> [blocksize] [destructive]

Options

Parameters

Commonly Used Block Sizes

Examples

• ./run_badblocks.sh "/dev/da1"
• ./run_badblocks.sh "/dev/da1" 4096
• ./run_badblocks.sh "/dev/da1" 4096 true
• ./run_badblocks.sh "auto_skip" "/dev/da1" 4096 true

Drives Tested

A script to run a BadBlocks test in operational (Non-Destructive) mode.

Usage

[bash] ./run_badblocks_operational.sh [auto_skip] <drive> [blocksize]

Options

Parameters

Commonly Used Block Sizes

Examples

• ./run_badblocks_operational.sh "/dev/da1"
• ./run_badblocks_operational.sh "/dev/da1" 4096
• ./run_badblocks_operational.sh "auto_skip" "/dev/da1" 4096

Drives Tested

A script to A script to run a BadBlocks test in destructive mode.

Usage

[bash] ./run_badblocks_destructive.sh [auto_skip] <drive> [blocksize]

Options

Parameters

Commonly Used Block Sizes

Examples

• ./run_badblocks_destructive.sh "/dev/da1"
• ./run_badblocks_destructive.sh "/dev/da1" 4096
• ./run_badblocks_destructive.sh "auto_skip" "/dev/da1" 4096

Drives Tested

A script to copy all files recursively into a single directory.

Usage

[bash] ./copy_all_files_to_dir.sh [auto_skip] <srcPath> <srcDir> <destDir> 
<filenameStructure> [keepStructure]

Options

Parameters

Examples

• ./copy_all_files_to_dir.sh "./path/to/dir" ./Source" "./Destination" "*.txt"
• ./copy_all_files_to_dir.sh "./path/to/dir" "./Source" "./Destination" "*.txt" false
• ./copy_all_files_to_dir.sh "auto_skip" "./path/to/dir" "./Source" "./Destination" "*.txt" false

A script to use the DD command to write data across every bit in a drive or read all data bits from a drive or read and write data across every bit in a drive in parallel.

Usage

[bash] ./run_imaging.sh [auto_skip] <drive> [blocksize] [type] [write_random_pattern]

Options

Parameters

Commonly Used Block Sizes

Types

Examples

• ./run_imaging.sh "/dev/da4"
• ./run_imaging.sh "/dev/da4" 1048576
• ./run_imaging.sh "/dev/da4" 1048576 "read-write"
• ./run_imaging.sh "/dev/da4" 1048576 "read-write" true
• ./run_imaging.sh "auto_skip" "/dev/da4" 1048576 "read-write" true

Drives Tested

A script to use the DD command to read and write data across every bit in a drive in parallel.

Usage

[bash] ./run_imaging_read_write.sh [auto_skip] <drive> [blocksize] [write_random_pattern]

Options

Parameters

Commonly Used Block Sizes

Examples

• ./run_imaging_read_write.sh "/dev/da3"
• ./run_imaging_read_write.sh "/dev/da3" 1048576
• ./run_imaging_read_write.sh "/dev/da3" 1048576 true
• ./run_imaging_read_write.sh "auto_skip" "/dev/da3" 1048576 true

Drives Tested

A script to use the DD command to read all data bits from a drive.

Usage

[bash] ./run_imaging_read.sh [auto_skip] <drive> [blocksize]

Options

Parameters

Commonly Used Block Sizes

Examples

• ./run_imaging_read.sh "/dev/da1"
• ./run_imaging_read.sh "/dev/da1" 1048576
• ./run_imaging_read.sh "auto_skip" "/dev/da1" 1048576

Drives Tested

A script to use the DD command to write data across every bit in a drive.

Usage

[bash] ./run_imaging_write.sh [auto_skip] <drive> [blocksize] [random]

Options

Parameters

Commonly Used Block Sizes

Examples

• ./run_imaging_write.sh "/dev/da0"
• ./run_imaging_write.sh "/dev/da0" 1048576
• ./run_imaging_write.sh "/dev/da0" 1048576 true
• ./run_imaging_write.sh "auto_skip" "/dev/da0" 1048576 true

Drives Tested

A script to execute any number of commands in parallel.

Usage

[bash] ./parallel_commands.sh [auto_skip] <cmds>

Options

Parameters

Examples

• ./parallel_commands.sh "echo Hello World"
• ./parallel_commands.sh "echo Hello" "echo World"
• ./parallel_commands.sh "echo Hello World" "echo Hello" "echo World"
• ./parallel_commands.sh "auto_skip" "echo Hello World" "echo Hello" "echo World"

A script to securely copy files from a remote server.

Usage

[bash] ./scp_from_remote.sh [auto_skip] <host> <port> <user> <remotePath> 
<localPath>

Options

Parameters

Examples

• ./scp_from_remote.sh 192.168.1.1 22 "root" "/" "/Documents"
• ./scp_from_remote.sh "auto_skip" 192.168.1.1 22 "root" "/" "/Documents"

A script to securely copy files to a remote server.

Usage

[bash] ./scp_to_remote.sh [auto_skip] <host> <port> <user> <localPath> 
<remotePath>

Options

Parameters

Examples

• ./scp_to_remote.sh 192.168.1.1 22 "root" "/Documents" "/"
• ./scp_to_remote.sh "auto_skip" 192.168.1.1 22 "root" "/Documents" "/"

A script to run a query for the SMART summary.

Usage

[bash] ./read_smart_test_results.sh [auto_skip] <drive>

Options

Parameters

Examples

• ./read_smart_test_results.sh "/dev/da0"
• ./read_smart_test_results.sh "auto_skip" "/dev/da0"

Drives Tested

A script to run a SMART conveyance, short or long test.

Usage

[bash] ./run_smart_test.sh [auto_skip] <drive> <type> [captive]

Options

Parameters

Types

Examples

• ./run_smart_test.sh "/dev/da5" "long"
• ./run_smart_test.sh "/dev/da5" "conveyance" true
• ./run_smart_test.sh "auto_skip" "/dev/da5" "conveyance" true

Drives Tested

A script to run a SMART conveyance, short or long test and continuusly poll for status.

Usage

[bash] ./run_smart_test_with_polling.sh [auto_skip] <drive> <type>

Options

Parameters

Types

Examples

• ./run_smart_test_with_polling.sh "/dev/da5" "long"
• ./run_smart_test_with_polling.sh "/dev/da5" "conveyance"
• ./run_smart_test_with_polling.sh "auto_skip" "/dev/da5" "conveyance"

Drives Tested

A script to run a SMART conveyance test.

Usage

[bash] ./run_smart_conveyance_test.sh [auto_skip] <drive> [captive]

Options

Parameters

Examples

• ./run_smart_conveyance_test.sh "/dev/da2"
• ./run_smart_conveyance_test.sh "/dev/da2" true
• ./run_smart_conveyance_test.sh "auto_skip" "/dev/da2" true

Drives Tested

A script to run a SMART short test.

Usage

[bash] ./run_smart_short_test.sh [auto_skip] <drive> [captive]

Options

Parameters

Examples

• ./run_smart_short_test.sh "/dev/da2"
• ./run_smart_short_test.sh "/dev/da2" true
• ./run_smart_short_test.sh "auto_skip" "/dev/da2" true

Drives Tested

A script to run a SMART long test.

Usage

[bash] ./run_smart_long_test.sh [auto_skip] <drive> [captive]

Options

Parameters

Examples

• ./run_smart_long_test.sh "/dev/da2"
• ./run_smart_long_test.sh "/dev/da2" true
• ./run_smart_long_test.sh "auto_skip" "/dev/da2" true

Drives Tested

A script to connect to a server using an SSH connection.

Usage

[bash] ./connect.sh [auto_skip] <host> <port> <user>

Options

Parameters

Examples

• ./connect.sh 192.168.1.1 22 "root"
• ./connect.sh "auto_skip" 192.168.1.1 22 "root"

A script to execute a command over an SSH connection.

Usage

[bash] ./run_command.sh [auto_skip] <host> <port> <user> <cmd>

Options

Parameters

Examples

• ./run_command.sh 192.168.1.1 22 "root" "pwd"
• ./run_command.sh "auto_skip" 192.168.1.1 22 "root" "pwd"

A script to execute a script over an SSH connection.

Usage

[bash] ./run_script.sh [auto_skip] <host> <port> <user> <script> <params>

Options

Parameters

Examples

• ./run_script.sh 192.168.1.1 22 "root" "./Utility-Scripts/tmux/start_tmux_session" "session-name"
• ./run_script.sh "auto_skip" 192.168.1.1 22 "root" "./Utility-Scripts/tmux/start_tmux_session" "session-name"

A script to use the SYS or SMART commands to list either all available drives or just those that are SMART-capable drives.

Usage

[bash] ./list_drives.sh [auto_skip] [all_drives] [use_sysctl]

Options

Parameters

Examples

• ./list_drives.sh
• ./list_drives.sh true
• ./list_drives.sh true true
• ./list_drives.sh "auto_skip" true true

A script to use the SYS or SMART commands to list all available drives.

Usage

[bash] ./list_all_drives.sh [auto_skip] [use_sysctl]

Options

Parameters

Examples

• ./list_all_drives.sh
• ./list_all_drives.sh true
• ./list_all_drives.sh "auto_skip" true

A script to use the SMART commands to list all available drives.

Usage

[bash] ./list_all_drives_smartctl.sh [auto_skip]

Options

Parameters

Examples

• ./list_all_drives_smartctl.sh
• ./list_all_drives_smartctl.sh "auto_skip"

A script to use the SYS CONTROL commands to list all available drives.

Usage

[bash] ./list_all_drives_sysctl.sh [auto_skip]

Options

Parameters

Examples

• ./list_all_drives_sysctl.sh
• ./list_all_drives_sysctl.sh "auto_skip"

A script to use the SYS or SMART commands to list available SMART-capable drives.

Usage

[bash] ./list_smart_drives.sh [auto_skip] <use_sysctl>

Options

Parameters

Examples

• ./list_smart_drives.sh
• ./list_smart_drives.sh true
• ./list_smart_drives.sh "auto_skip" true

A script to use the SMART commands to list available SMART-capable drives.

Usage

[bash] ./list_smart_drives_smartctl.sh [auto_skip]

Options

Parameters

Examples

• ./list_smart_drives_smartctl.sh
• ./list_smart_drives_smartctl.sh "auto_skip"

A script to use the SYS CONTROL commands to list available SMART-capable drives.

Usage

[bash] ./list_smart_drives_sysctl.sh [auto_skip]

Options

Parameters

Examples

• ./list_smart_drives_sysctl.sh
• ./list_smart_drives_sysctl.sh "auto_skip"

A script to start a new TMUX session.

Usage

[bash] ./start_tmux_session.sh [auto_skip] <name>

Options

Parameters

Examples

• ./start_tmux_session.sh "Session Name"
• ./start_tmux_session.sh "auto_skip" "Session Name"

A script to end an existing TMUX session.

Usage

[bash] ./end_tmux_session.sh [auto_skip] <name>

Options

Parameters

Examples

• ./end_tmux_session.sh "Session Name"
• ./end_tmux_session.sh "auto_skip" "Session Name"

A script to attach to an active TMUX session.

Usage

[bash] ./attach_tmux_session.sh [auto_skip] <name>

Options

Parameters

Examples

• ./attach_tmux_session.sh "Session Name"
• ./attach_tmux_session.sh "auto_skip" "Session Name"

A script to detach from an active TMUX session.

Usage

[bash] ./detach_tmux_session.sh [auto_skip]

Options

Parameters

Examples

• ./detach_tmux_session.sh
• ./detach_tmux_session.sh "auto_skip"

A script to select/activate a specific TMUX window pane.

Usage

[bash] ./select_session_pane.sh [auto_skip] <pane>

Options

Parameters

Examples

• ./select_session_pane.sh 1
• ./select_session_pane.sh "auto_skip" 1

A script to send and execute a command in a specific TMUX window pane.

Usage

[bash] ./send_tmux_pane_command.sh [auto_skip] <pane> <cmd>

Options

Parameters

Examples

• ./send_tmux_pane_command.sh 1 "pwd"
• ./send_tmux_pane_command.sh "auto_skip" 1 "pwd"

A script to send and execute a shell command in a specific TMUX window.

Usage

[bash] ./send_tmux_shell_command.sh [auto_skip] <name> <cmd>

Options

Parameters

Examples

• ./send_tmux_shell_command.sh "Session Name" "pwd"
• ./send_tmux_shell_command.sh "auto_skip" "Session Name" "pwd"

A script to set a specific layout for an active TMUX window.

Usage

[bash] ./set_layout.sh [auto_skip] <layout>

Options

Parameters

Layouts

Examples

• ./set_layout.sh tiled
• ./set_layout.sh "auto_skip" tiled

A script to set a tiled layout for an active TMUX window.

Usage

[bash] ./set_layout_tiled.sh [auto_skip]

Options

Parameters

Examples

• ./set_layout_tiled.sh
• ./set_layout_tiled.sh "auto_skip"

A script to split an active TMUX window horizontally.

Usage

[bash] ./split_window_horizontal.sh [auto_skip]

Options

Parameters

Examples

• ./split_window_horizontal.sh
• ./split_window_horizontal.sh "auto_skip"

A script to split an active TMUX window vertically.

Usage

[bash] ./split_window_vertical.sh [auto_skip]

Options

Parameters

Examples

• ./split_window_vertical.sh
• ./split_window_vertical.sh "auto_skip"

This section provides additional notes about how to deploy this on a live system.

This project does not contain any dependencies at this time.

This project does not contain any additional notes at this time.

Please read CODE_OF_CONDUCT for details on our Code of Conduct and CONTRIBUTING for details on the process for submitting pull requests.

Please read SUPPORT for details on how to request support from the team. For any security concerns, please read SECURITY for our related process.

We use Semantic Versioning for versioning. For available releases, please see the available tags or look through our Release Notes. For extensive documentation of changes between releases, please see the Changelog.

• Jack Thorp - Initial work - jhthorp

See also the list of contributors who participated in this project.

Copyright © 2020 - 2021, Jack Thorp and associated contributors.

This project is licensed under the GNU General Public License - see the LICENSE for details.

• N/A