Command-line configuration

SFTPPlus MFT includes the admin-shell command-line tool for configuring and operating the application from a terminal. It is available on Linux, Windows, and macOS, and provides a text-based alternative to the Web Manager.

Run the admin-shell tool ​

Start an interactive session by providing the Web Manager URL and the name of an administrator:

shell
bin/admin-shell.sh \
    --url https://mft.example.com:10020 \
    --name administrator

When --password is omitted, admin-shell asks for it securely at runtime. Use --cacert PATH when the server certificate is issued by a private certificate authority. Administrators using two-factor authentication can also provide the current code with --totp TOTP.

To execute a single command without starting an interactive session, append it to the command line:

shell
bin/admin-shell.sh \
    --url https://mft.example.com:10020 \
    --name administrator \
    show failures

The full list of options is available using:

shell
bin/admin-shell.sh --help

Manage SFTPPlus from a terminal ​

The admin-shell tool provides access to the same configuration model used by Web Manager and the .INI configuration file. Administrators can add, update, and remove configuration items without editing the file by hand.

The command-line interface is suitable for:

  • Managing SFTPPlus on servers without a desktop environment
  • Working over a remote terminal connection
  • Applying repeatable configuration changes
  • Integrating administrative operations into scripts and deployment workflows

Scriptable and repeatable administration ​

Command-line administration is useful when a change needs to be repeated across environments or included in an operational script. It can be run from deployment pipelines, scheduled jobs, or standard operational procedures.

Using the CLI also makes it possible to keep administrative work in the same reviewable workflow as other infrastructure changes.

Use role-based administrative access ​

Administrators authenticate before using the command-line interface. Their assigned role controls which configuration and management operations they can perform, using the same access rules as Web Manager. The admin-shell tool communicates with SFTPPlus through its JSON-RPC management interface. It uses the same secure login process as Web Manager, including administrator credentials, TLS certificate verification, assigned roles, and two-factor authentication when enabled.

Automate repeatable operations ​

Command-line operations can be scripted, making them useful for routine administration and consistent deployments. Teams can use the tool with their existing automation while keeping SFTPPlus access subject to administrative authentication and authorisation.

Use your preferred management method ​

Use the CLI when you need a text-based interface, automation, or repeatable operations. The Web Manager is suited to interactive administration and monitoring, while the INI configuration file is useful for direct editing, version control, and infrastructure-as-code deployments.