CLI(コマンドラインインタフェース)ツールのご利用方法について説明します。
ActiveDirectory環境などの組織管理下で効率よくYubiOn FIDO Logonを導入して頂くため、クライアントソフトウェア内にCLIコマンドをご用意しています。
インストール後、「C:\Program Files\YubiOn\Fls\FlsCliTool」ディレクトリ内に配置される「FlsCliTool.exe」がコマンドの実行ファイルとなります。
CLIツールをご利用になるには、クライアントソフトウェアのバージョンが1.1.0.1以降である必要があります。
コマンドプロンプトでCLIツールを利用する際の基本的な形式は以下のような形になります。
引数の渡し方はWindowsコマンドプロンプト(またはPowerShellなど)の一般的なコマンド引数の渡し方に準じます。
FlsCliTool.exe [command] [options...]
command(コマンド)
CLIツールで実行する処理を記述します。
options(オプション)
コマンド別に必要なオプションを記述します。
| コマンド | クライアントソフトウェアバージョン | 実行内容 |
|---|---|---|
| register | 1.1.0.1~ | 登録コードを設定し、YubiOn FIDO Logonを使用可能な状態にする。 |
| set_cp_title_alternative_text | 3.0.0.1~ | CredentialProvider上の製品名表記部分をカスタマイズする。 |
| help | - | コマンドの利用方法を表示する。 |
合致するコマンドが無い場合、helpコマンドが実行されます。
コマンド実行時に返される終了コードは以下の通りです。
| 終了コード | 内容 |
|---|---|
| 0 | 正常終了 |
| 1 | パラメータ異常 |
| 2 | 管理者権限が必要 |
| 3 | サービスが起動していない |
| 4 | ライセンス期限切れ |
| 5 | ライセンス数超過 |
| 6 | 登録コード誤り |
| 7 | 端末情報が削除済み |
| 8 | サーバー通信異常 |
| 10 | 登録済み |
| 129 | ADに接続されていない |
| 130 | ADサーバーとの通信異常 |
終了コードの取得方法は実行する環境(コマンドプロンプト/PowerShell)によって異なります。