User Manual
fmcsadminはClaris FileMaker Server管理者向けのコマンドラインツールです。LinuxだけでなくmacOSやWindowsでもご利用いただけます。
当初はFileMaker Cloud for AWSでfmsadminコマンドを使用できない問題を解決するために開発しましたが、現在ではFileMaker Serverに付属する純正のfmsadminコマンドにはない機能としてリモート管理機能を備えている点が特色となっています。
バージョン19.6以降のClaris FileMaker Serverに対応しているfmcsadmin 2.2.0を配布しています。fmcsadmin 2.2.0のライセンスはApache License, Version 2.0です。
fmcsadminは、当初FileMaker Cloud for AWSでfmsadminコマンドを使用できない問題を解決するために開発された管理ツールです。Claris FileMaker Serverを管理することも可能で、標準のfmsadminコマンドにはない機能として、リモート管理機能も備えています（リモート管理機能を利用するにはサーバー側でSSLサーバー証明書が適切にインストールされている必要があります）。
バージョン2.1.0以降では、PKI（パブリックキーインフラストラクチャ）での認証をサポートするための-iオプションが新たに追加されています。
fmcsadminは、オープンソースソフトウェアであり、無料でご利用いただくことが可能です。Go言語で記述されており、ライセンスはApache License, Version 2.0です。コマンドラインインターフェース（CLI）でClaris FileMaker Admin APIを操作し、Claris FileMaker Serverに付属するfmsadminコマンドと同様の使い勝手を実現します。
マルチプラットフォームに対応しているfmcsadminは、LinuxだけでなくmacOSやWindowsでもご利用いただけます。Claris FileMaker Server for Linux上で利用できるLinux版を用意しているほか、macOSやWindows上でClaris FileMaker Serverをネットワーク経由で管理することもできます。
利用可能なコマンドおよびオプションの一覧とその使用方法について記載されたヘルプページを表示するには、コマンドラインインターフェースでhelpコマンドを使用します。コマンドラインインターフェースは、コマンドプロンプトやPowerShell (Windows) 、ターミナルアプリケーション (macOS) で使用できます。
fmcsadmin help
ホストしているファイルの一覧を表示する場合
fmcsadmin list files
リモートでデータベースファイルを開く場合
fmcsadmin --fqdn fms.example.jp open FMServer_Sample
| コマンド名 | 説明 |
|---|---|
| cancel | 進行中のバックアップ処理を中止する（FileMaker Server 19.5.1以降） |
| certificate | SSLサーバー証明書発行手続きに必要となるCSRファイルの作成、SSLサーバー証明書のインポートおよびSSLサーバー証明書の削除処理を実行する（FileMaker Server 19.2.1以降） |
| close | データベースファイルを閉じる |
| delete | スケジュールを削除する |
| disable | スケジュールを無効にする |
| disconnect | クライアントの接続を切る |
| enable | スケジュールを有効にする |
| get | サーバーおよびカスタムWeb公開の設定を取得・表示する（FileMaker Server 18以降） |
| help | ヘルプページを表示する |
| list | 接続クライアントやデータベースファイル、スケジュール、プラグインの一覧を表示する （プラグインの一覧表示にはFileMaker Server 19.2.1以降が必要） |
| open | データベースファイルを開く |
| pause | 一時的にデータベースファイルへの接続を停止する |
| remove | データベースファイルを取り除く（FileMaker Server 19.3.1以降） |
| restart | データベースサーバーを再起動する（FileMaker Server 18以降） |
| resume | 一時停止していたデータベースファイルへの接続を再開する |
| run | スケジュールを実行する |
| send | メッセージを送信する |
| set | サーバーおよびカスタムWeb公開の設定を変更する（FileMaker Server 18以降） |
| start | データベースサーバーを起動する（FileMaker Server 18以降） |
| status | 接続クライアントやデータベースファイルの状況を表示する |
| stop | データベースサーバーを停止する（FileMaker Server 18以降） |
fmcsadminは内部的にClaris FileMaker Admin APIを利用しており、リモートサーバーへのリクエストはClaris FileMaker Admin APIに準じてHTTPSで送信しています。fmcsadminのリモート管理機能は、利用するにあたってはサーバー側でSSLサーバー証明書が適切にインストールされている必要があり、証明書の検証を行った上でHTTPSにて接続するので、暗号化通信を利用する前提の設計となっております。
Linux上で動作しているFileMaker Serverに対してリモート管理機能を使用する場合には、macOS用のfmcsadminをインストールしてご使用ください。
macOSではfmcsadminは/usr/local/bin/fmcsadminにインストールされます。アンインストール機能は用意されていないため、当該ファイルを手動で削除していただく必要があります。
FMプランのサーバーに対してfmcsadminをご使用いただく場合、サーバーの設定変更や起動・停止処理、SSLサーバー証明書の設定・削除処理はサポート対象外となります。