Command Line Interface (CLI)
SEF-CLI is a versatile command line tool provided as a means of performing both SEF Unit configuration and administration and as a debugging tool. SEF-CLI requires superuser permissions to interact with and configure SEF Units.
The SEF-CLI uses a target-and-action paradigm. In other words, an action is applied to the given
target. When using the command line interface, the first input is an action, and the second input is
the target the action is applied to. For example, list sef applies the list action to the sef
target and will list the available SEF Units.
The shortest unique prefix may be used to invoke an action on a target. For example, l se may be
used to list SEF Units, since l and se each correspond to a unique action and target.
A list of all actions and targets can be printed using the --help or -h flag. The help functionality
may be viewed in greater detail using the --verbose or -V flag. The detailed help function prints
targets, actions, and options for each target. It also prints the default value for each option. All
targets support the help action.
The SEF CLI Targets and Actions Table enumerates the built-in targets and their corresponding actions.
SEF CLI Targets and Actions
| Target | Action | Action Description |
|---|---|---|
| sef-unit | list | Print list of available SEF Units. Additional info is printed in verbose mode |
| info | Prints SEF Unit's information | |
| help | Print verbose help for the target | |
| virtual-device | list | Print list of created Virtual Devices. Commands to recreate same configuration is printed in verbose |
| draw | Print a map of created Virtual Devices | |
| info | Print a Virtual Device's information; Prints usage data in verbose mode | |
| create | Create a new Virtual Device | |
| delete | Delete Virtual Device. Virtual Device can only be deleted if it is empty | |
| set-pslc | Sets the number of pSLC Super Blocks for a Virtual Device | |
| set-suspend-config | Sets the suspend configuration for a Virtual Device | |
| help | Print verbose help for the target | |
| qos-domain | list | Print list of available QoS Domains. Commands to recreate same configuration is printed in verbose |
| info | Prints QoS Domain's information | |
| create | Create a new QoS Domain | |
| delete | Delete QoS Domain. All storage allocated to the QoS Domain is returned to the Virtual Device | |
| format | Format QoS Domain. All storage allocated to the QoS Domain is returned to the Virtual Device, but the QoS Domain will not be removed | |
| resize | Change size of existing QoS Domain | |
| label | Set the label for an existing QoS Domain | |
| backup | Backup QoS Domain's stored data to a set of files | |
| restore | Restore a set of backed up files to the QoS Domain | |
| help | Print verbose help for the target | |
| ftl | info | Prints the SEF Block Module's information/configuration |
| configure | Configure the SEF Block Module | |
| check | Check the SEF Block Module's health, and repair if broken | |
| help | Print verbose help for the target | |
| shell | interactive | An Interactive shell to interact with the device in real time |
| execute | Execute a Python script to interact with the device | |
| help | Print verbose help for the target |