CLIツールご利用方法

CLI(コマンドラインインタフェース)ツールのご利用方法について説明します。

CLIツール概要

ActiveDirectory環境などの組織管理下で効率よくYubiOn FIDO Logonを導入して頂くため、クライアントソフトウェア内にCLIコマンドをご用意しています。

Windows
インストール後、「C:\Program Files\YubiOn\Fls\FlsCliTool」ディレクトリ内に配置される「FlsCliTool.exe」がコマンドの実行ファイルとなります。

macOS
インストール後、「/usr/local/bin/」ディレクトリ内に配置される「FlsCliTool」がコマンドの実行ファイルとなります。
デフォルトでPATHが設定されているディレクトリですので、実行時にフルパスを指定する必要はありません。

基本構文

CLIツールを利用する際の基本的な形式は以下のような形になります。
引数の渡し方は各OSの一般的なコマンド引数の渡し方に準じます。

Windows 
FlsCliTool.exe [command] [options...]
macOS 
FlsCliTool [command] [options...]

  • command（コマンド）
    CLIツールで実行する処理を記述します。

  • options（オプション）
    コマンド別に必要なオプションを記述します。

コマンド一覧

コマンド Windows macOS 実行内容
register 1.1.0.1～ 0.9.1～ 登録コードを設定し、YubiOn FIDO Logonを使用可能な状態にする。
set_cp_title_alternative_text 3.0.0.1～ － CredentialProvider上の製品名表記部分をカスタマイズする。
output_survey_log － 0.9.1～ 診断用の調査ログ、設定ファイル、ハードウェア情報をZIPファイルに出力する。
uninstall － 0.9.1～ このMacからYubiOn FIDO Logonをアンインストールする。
help 全バージョン 全バージョン コマンドの利用方法を表示する。

終了コード一覧

コマンド実行時に返される終了コードは以下の通りです。

終了コード 内容
0 正常終了
1 パラメータ異常
2 管理者権限が必要
3 サービスが起動していない（macOS: デーモンが起動していない）
4 ライセンス期限切れ
5 ライセンス数超過
6 登録コード誤り
7 端末情報が削除済み
8 サーバー通信異常
9 プロキシ認証が必要
10 登録済み
11 ポリシーにより制限されている
12 システムの再起動が必要
129 ADに接続されていない / AD参加が必要
130 ADサーバーとの通信異常
131 有効なプロファイルが存在しない
255 予期せぬエラー