SoftRAID Feature: Command Line Interface

Created on: April 22, 2022
Last updated: April 12, 2024

macOS

In macOS, “softraidtool” is automatically installed the first time you run the SoftRAID application and can be accessed from any terminal window by simply typing:

> softraidtool

Running softraidtool requires root access (e.g. sudo softraidtool…) for any function other than simply getting the current status of a disk or volume. This prevents an unauthorized user from erasing your SoftRAID volumes. If you want to remove SoftRAID, the softraidtool gets removed, along with the driver, the SoftRAID Monitor and all the SoftRAID-specific preferences when you select “Uninstall SoftRAID” from the “Utilities” menu.

The commands for softraid tool all take the form:

> softraidtool [disk|volume] identifier command parameters

For instance, if you want to get the status of the disk at disk3, you would type:

> softraidtool disk disk3 info

If you wanted to get the status of your boot volume, you would type:

> softraidtool volume / info

For a complete list of commands, simply type:

> softraidtool help

If you wish to use the command-line interface to remotely use softraidtool from another Mac or iPhone, you must enable Remote Login in the Sharing pane of System Preferences. In addition, you must make sure that your firewall can forward requests from the Internet to the Mac running SoftRAID. Please only do this if you have taken adequate security precautions (e.g. are using a strong password, etc.).

Windows

In Windows, you can access SoftRAID features from a Windows Terminal or a PowerShell window. SoftRAID for Windows includes the following PowerShell commands:

• Clear-SRDisk
• Get-SRRaidVolume
• Set-SRDiskLabel
• New-SRRaidVolume
• Remove-SRRaidVolume
• Set-SRSafeguard
• Sync-SRRaidVolume
• Test-SRDisk

You can get more information about each of these commands using the PowerShell Get-Help command. For example:
Get-Help New-SRRaidVolume