This section explains how to use the CLI (Command Line Interface) tool.
In order to efficiently install YubiOn FIDO Logon under organizational management such as Active Directory environment, we provide CLI commands in the client software.
Windows
After installation, “FlsCliTool.exe” located in the directory “C:\Program Files\YubiOn\Fls\FlsCliTool” is the executable file of the command.
macOS
After installation, “FlsCliTool” located in the directory “/usr/local/bin/” is the executable file of the command.
Since this directory is included in PATH by default, you do not need to specify the full path when executing it.
To use the CLI tool, the client software must be the following version or later.
The basic format for using the CLI tool is as follows.
The argument passing follows the general command argument passing method of each OS.
FlsCliTool.exe [command] [options...]
FlsCliTool [command] [options...]
command
Describe the process to be executed by the CLI tool.
options
Describe the options required for each command.
| Command | Windows | macOS | Execution details |
|---|---|---|---|
| register | 1.1.0.1 or later | 0.9.1 or later | Set the registration code and make YubiOn FIDO Logon ready for use. |
| set_cp_title_alternative_text | 3.0.0.1 or later | － | Customize the product name description section on the CredentialProvider. |
| output_survey_log | － | 0.9.1 or later | Export diagnostic survey logs, configuration files, and hardware info to a ZIP file. |
| uninstall | － | 0.9.1 or later | Uninstall YubiOn FIDO Logon from this Mac. |
| help | All versions | All versions | Displays how to use the command. |
If there is no matching command, the help command is executed.
The exit code returned when the command is executed is as follows:
| Exit code | Content |
|---|---|
| 0 | Success |
| 1 | Parameter error |
| 2 | Administrative privileges required |
| 3 | Service is not running (macOS: daemon is not running) |
| 4 | License expiration |
| 5 | Number of licenses exceeded |
| 6 | Registration code error |
| 7 | Device information has been deleted |
| 8 | Server communication error |
| 9 | Proxy authentication required |
| 10 | Already registered |
| 11 | Prohibited by policy |
| 12 | System restart is required |
| 129 | Not connected to AD / AD join required |
| 130 | AD server communication error |
| 131 | No valid profile exists |
| 255 | Unexpected error |
The method of obtaining the exit code depends on the environment (Command Prompt/PowerShell, macOS Terminal, etc.) in which it is executed.