6. Core Binaries and Utilities (with Full CLI Options)
Binary | Description | Usage/Options |
NxCore | Main archive engine | NxCore 2.4.4 b250401 (c)2021-25 SFS Media ./NxCore [-Q -T] Usage: -Q<queue key> -T<trace level> |
NxQueue | Job queue manager | systemctl stop/start NxQueue |
NxScsi | SCSI device scan and update | NxScsi (c) 2022-25 SFS Media v1.5.0 build 250220 ./NxScsi [-d a -I -b -u -U -P] Usage: -d <devname> -a -I -b -u -U -P where -d <devname> scan the specific changer device for volumes -b Scan all SCSI busses and display attached (useful type 1 & 8) devices -u Perform a scan and update the database with the volumes found across all changers -I indicates that the robot is an IBM series and requires special treatment -P Update the volume inventory also while doing a scan -U Inventory, Update, and describe the attached devices for this node -a Filter Aggregate Connections
|
NxChanger | Robotic changer management | systemctl stop/start NxChanger |
NxCLI | Command-line interface for admin tasks | NxCLI v3.1.3 (c)2021-23 SFS Media ./NxCLI [-a -n -o -g -Q -R -F -M -p -T -e] Usage: (archive objects) -a <asset id> -n <displayName> -o <object> -g <groupName> -Q <queue display> (archive an entire directory) -R <directory> -a <asset id> -n <displayName> -g <groupName> -Q <queue display> (archive a collection of objects specified in a file) -F <collection> -a <asset id> -n <displayName> -g <groupName> -Q <queue display> (restore an object to a target directory) -r <object> -o <uuid> -d <target dir> (migrate an entire volume content to path) -M <volume> -p <path> (Partial Restore by Frame Count an object) -P <uuid> <start frame> <end Frame> <frame type> <filepath> -T<level> adds debug tracing at <level> into home directory e.g. -T3 (Eject volume from drive) -e <devname> |
NxREST | REST API service | NxREST (c) 2021-23 SFS Media v1.5.5 build 231019 systemctl stop/start NxREST
|
NxSocket | XML socket API (FlashNet compatible) | NxSocket Service v1.4.6 (c) 2022-23 SFS Media systemctl stop/start NxSocket
|
NxStorageScan | Storage device inventory | NxStorageScan v1.0.5 (c) 2021-23 SFS Media Usage: ./NxStorageScan -S <Storage URI> -t <type> -G <GroupName> -C <cacheArea> -R <poll time> -S - Storage URI. (types: S3 - <Bucket Name>, GD - <Disk Path>, FT - <server:/path>) -t - Storage Types. (S3 - Amazon S3, AZ - Azure, GD - Generic Disk, FT - FTP Service) -G - Archive Group Name -C - Cache Area for media processing -R - Run as a service, continual processing with poll time <poll time> seconds |
NxUI | Web based user interface. Server IP and port 8186 (default) | systemctl stop/start NxUI |
NxServerWatchDog | Stop/Start services | WatchDog Service v1.0.0 WatchDog b250507 (c) SFS Media 2021-25 |
NxUtils | Utility functions | NxUtils v1.0.6 ./NxUtils <util> <cmd> <properties> <mm> - Move Media in changer load <volume> - Load a volume into a drive unload <volume> - Unload a volume from a drive move <locA> <locB> - Move a volume from <locationA> to <locationB> <lock> - Lock a volume in a drive with software lock and prevent its use. <scan> - Scan All SCSI busses for connected devices and report serial Numbers <format> - Format a volume back to blank single partition in a drive <locate> <device> <p> <N> - Locate to block position <pppp> in partition <N> <bread> <device> <N> - Read <N> BLOCKS of <size> bytes from the current position (writes to a temporary file) <vread> <device> <N> - read <N> BYTES (variable read) of data from the current location Example Unload: /usr/share/SFS/bin/NxUtils/NxUtils mm unload ZF0006L5 |
NxWorkflow | Workflow management and execution | NxWorkflowService v1.1.3 (c) 2023-24 SFS Media Usage: ./NxWorkflowService -B B - Starts application as a service |
NxWorkflowEngine |
| NxWorkflowEngine v1.2.7 b250309 (c) 2023-25 SFS Media Usage: ./NxWorkflowEngine -Q<ID> -D Q - Specifies the NxMirror table entry to work on D - Delete any media scanned that is already within the target media |
FNConvert | FlashNet MSSQL to SFS MySQL migration. Converts the FlashNet MSSQL server tables which it uses into SFA MySQL tables. | FlashNet Conversion Utility v1.6.5 - Async (c) 2021-24 SFS Media Usage <-cu> <group_name> -S <changer> Where: -c <group_name> - Target and read a FlashNet group of volumes into SFA archive by reading all metadata -v <volume name> - Updates the records of a single volume -u <group_name> - Update a set of Flashnet volumes with correct Object ID's after SFA volumes have been cached -S <changer no> specify which changer the group data should be inserted into |
KLConvert | Kumulate (Oracle/Postgres) to SFS migration. Converts Kumulate either Oracle or Postgres database entries from a highly complex structure of interlinked tables (some 400+) to the standard 19 tables of SFA. |
|
SDConvert | StorageDNA XML to SFS MySQL migration. Converts storage DNA indexes in the form of file-based XML indices into standard MySQL entries in the MySQL database. | dnaConvert v1.2.0 b171223 (c) 2023-24 SFS Media -I <basedir> - Scan basedir for all sDNA entities -C <basedir> - Clear the SFA database of all entries found in this <basedir> -v Produces a more verbose output Use the -F force parse option to continue without the archive.xml data file |
DVConvert | Diva (Oracle) to SFS migration. Converts Diva archive data stored in Oracle into the corresponding SFA entries. Diva archives are written in AXF and are also self-describing, so it is entirely possible to read the content of the database directly from the media itself. (This is also true of FlashNet media). |
|
SMConvert | Oracle Stornext ( StorageManager ) is a proprietary format which presents media as an online filesystem. This conversion is still in progress. |
|
Tips: After running a binary manually for troubleshooting, always restart the service with systemctl to ensure background operation.