The FileMaker Server Command-Line Interface, generally called the CLI, is a tool for administering FileMaker Server by entering commands instead of using the graphical Admin Console.
The command-line program itself is named fmsadmin. It is installed with FileMaker Server on Windows, macOS, and Linux.
The CLI gives server administrators direct access to many FileMaker Server operations and settings. It can be used interactively from a terminal or incorporated into scripts to automate recurring administrative tasks.
What Can the FileMaker Server CLI Do?
The CLI can perform many of the operations available through FileMaker Server Admin Console, including:
- listing hosted databases;
- opening, closing, pausing, and resuming files;
- listing and disconnecting clients;
- sending messages to connected users;
- running, enabling, and disabling schedules;
- creating backups;
- verifying databases;
- starting, stopping, and restarting FileMaker Server components;
- enabling or configuring server services;
- retrieving server information;
- changing administrative settings.
Some advanced FileMaker Server settings are available only through the CLI or are easier to configure with it.
What Is fmsadmin?
fmsadmin is the executable used to send CLI commands to FileMaker Server.
A command follows a structure such as:
fmsadmin command [options]
For example, an administrator can request a list of hosted databases with:
fmsadmin list files
The CLI also includes its own help system:
fmsadmin help
Because the objective of this article is to explain the technology rather than provide a command reference, developers should consult the official Claris documentation for the complete list of commands and options.
Why Use a Command-Line Interface?
For an occasional administrative operation, the graphical Admin Console is often more convenient. It displays server information visually and does not require command-line knowledge.
The CLI becomes particularly useful when an operation must be:
- repeated regularly;
- included in a deployment process;
- performed on several databases;
- executed by a system script;
- run without opening a web browser;
- combined with other server-management commands;
- logged as part of an automated workflow.
A script can, for example, notify users, close a database, perform an administrative operation, reopen the file, and record the result.
This makes the CLI an important tool for professional server administration and DevOps workflows.
CLI vs. Admin Console
FileMaker Server Admin Console and the CLI administer the same server, but they provide different interfaces.
Admin Console is a web application designed for interactive administration. It is generally the easiest way to inspect databases, connected clients, schedules, backups, and server configuration.
The CLI is text-based and runs on the FileMaker Server machine. It is more suitable for automation, scripting, diagnostics, and access to certain advanced settings.
The two interfaces complement each other. Using the CLI does not prevent an administrator from continuing to use Admin Console.
CLI vs. FileMaker Admin API
The FileMaker Server Admin API also allows software to perform administrative operations, but it works differently.
The CLI runs locally on the FileMaker Server computer. The Admin API accepts authenticated HTTPS requests and can therefore be called remotely by another application or service.
In simplified terms:
- use Admin Console for graphical, interactive administration;
- use the CLI for local command-line administration and system scripts;
- use the Admin API when another application must administer FileMaker Server remotely.
The best interface depends on where the operation is initiated and how it must be integrated into the wider system.
CLI vs. Developer Tool
The CLI should not be confused with the FileMaker Developer Tool.
The FileMaker Server CLI administers the running server and its services. It works with hosted databases, clients, schedules, backups, and server configuration.
The Developer Tool performs operations on the FileMaker database files themselves. It can create clones, encrypt files, save an application as XML, check consistency, analyse storage, recover files, and upload databases.
Similarly, the FileMaker Data Migration Tool transfers production records and accounts into a newer version of a FileMaker custom app.
These tools are complementary:
fmsadminmanages FileMaker Server;FMDeveloperToolprocesses FileMaker files;FMDataMigrationmigrates data between FileMaker files.
A professional deployment process may use all three.
Automating Administrative Tasks
CLI commands can be included in shell scripts on macOS or Linux and in batch or PowerShell scripts on Windows.
This makes it possible to create controlled workflows for tasks such as:
- deploying a new application version;
- closing files before maintenance;
- creating an on-demand backup;
- checking whether a service is running;
- restarting a failed component;
- collecting information for monitoring;
- enabling or disabling a server feature;
- performing scheduled maintenance.
Automation reduces repetitive manual work and ensures that an operation is performed consistently.
However, server-management scripts should include error handling, logging, secure credential management, and validation of every important operation.
Local Access Is Required
Unlike the Admin API, the CLI is intended to run on the FileMaker Server computer. The administrator must have local, terminal, SSH, or remote-desktop access to the server’s operating system.
Providing this level of access also provides considerable control over the server. It should therefore be restricted to trusted administrators.
With a managed hosting platform such as fmcloud.fm, customers do not normally need operating-system or CLI access. fmcloud.fm manages the underlying FileMaker Server infrastructure, while customers can perform the appropriate operations through Admin Console, the Admin API, OttoFMS, and the my.fmcloud.fm customer console.
This provides access to useful administrative capabilities without exposing the operating system or other components of the managed server environment.
Credentials and Security
Many CLI operations require FileMaker Server administrator credentials.
Credentials should not be written directly into scripts that can be read by unauthorized users. If a password must be used by an automated process, the script, configuration, and execution environment must be protected appropriately.
Commands that close databases, disconnect users, stop services, or change security settings can have an immediate effect on production. Before running them, administrators should verify the target server, database, and requested operation.
A good automated process should also preserve a current backup and provide a way to recover if an operation does not complete as expected.
The FileMaker Server CLI and fmcloud.fm
fmcloud.fm uses automation extensively to operate and maintain FileMaker Server instances across multiple data centres.
Command-line administration allows our infrastructure to perform repeatable server operations, monitor services, manage deployments, and apply configuration consistently.
Customers benefit from this automation without needing direct access to the operating system. They retain access to the administrative tools appropriate to a managed hosting environment, while fmcloud.fm takes responsibility for the underlying FileMaker Server infrastructure.
Developers who require more advanced deployment capabilities can also use OttoFMS, which is free, compatible with fmcloud.fm, and can be activated from the my.fmcloud.fm console.
Conclusion
The FileMaker Server Command-Line Interface is the local administration interface provided through the fmsadmin command.
It allows administrators and automated scripts to manage databases, clients, schedules, backups, services, and server configuration without using the graphical Admin Console.
Its main benefits are:
- automation of recurring administration;
- repeatable deployment and maintenance processes;
- access to advanced FileMaker Server settings;
- integration with operating-system scripts;
- efficient diagnostics and service management.
The CLI is a powerful server-administration tool, but it requires local access and should be reserved for trusted administrators. In managed environments such as fmcloud.fm, the same operational expertise can be delivered through secure automation and customer-facing management tools without exposing the server’s operating system.
