Terminal Deployment Tool
Using Terminal Deployment Tool for installing FUJIFILM BI Cloud Terminal is possible only with MS Windows.
Preparation
For Windows, built-in JAVA is always used, therefore you can skip this step.
For macOS, it's recommended to have JAVA 11 installed.
If you want to use built-in JAVA, you must allow libraries
System Preferences > Security & Privacy > Allow Anyway
next to the library name.- To verify the version, use the
java -version
command in the cmd line/terminal. - To install Java (optional):
- on macOS, use Homebrew.
- on Linux, use
apt-get
.
Prerequisites
The device must be set up according to documentation before using this tool.
If you are installing Ricoh Cloud Terminal against a cloud solution that does not have a publicly trusted Certificate Authority, you need to run the "fetch-certificate" command in your Terminal Deployment Tool. See the Advanced commands section below for this function's description and examples.
Terminal Deployment Tool options
When installing Ricoh Cloud Terminal against an on-premise solution, you can use the deployment tool to push your Certificate Authority to the printer so it will trust your site server. This is only needed when you use a certificate that is not signed by a publicly trusted CA. For how to create and import this CA, see the CustomCA-README
file located in <your deployment tool location>\certificates
.
Using Terminal Deployment Tool
Terminal Deployment Tool is available on Y Soft Partner Portal.
- Download an archive according to your operating system.
- Extract the archive.
- Run cmd line/terminal from the root folder of the extracted Terminal Deployment Tool archive.
- Use commands and parameters from the following sections.
Basic commands
INSTALL
Installs Cloud Terminal to target MFD, configures it, and performs any necessary configuration on the device, such as SP options, or authentication settings.
Mandatory parameters
Short parameter | Long parameter | Description | Note |
---|---|---|---|
vendor | Vendor | Supported vendor values (case insensitive):
| |
-i | --ip | MFD IP address | |
-a | --apikey | API key | API key obtained from your SAFEQ Cloud account |
-m | --server-domain | Server Domain | The domain of the server to which the Cloud Terminal will connect. It can be either the domain of the cloud primary server or the domain of a local gateway. Example:
|
-u | --username | MFD admin username | |
-p | --password | MFD admin password |
Optional URL override parameters
Paths to all the needed services are resolved automatically from the --server-domain
parameter. In case of non-standard deployment, individual paths can be overridden using:
Short parameter | Long parameter | Description | Note |
---|---|---|---|
-s | --sqts | Cloud Terminal API URL | Example:
|
-d | --idm | Authorization Service URL | Example:
|
-w | --scan | Scan server URL for document delivery | FUJIFILM BI Terminal only Example:
|
Command examples
Ricoh
BASH.\terminaldeploymenttool INSTALL RICOH -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
FUJIFILM BI (Cloud print method will be used as a default)
BASH.\terminaldeploymenttool INSTALL FUJIFILMBI -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
UNINSTALL
Uninstalls an already installed Cloud Terminal.
Parameters
Short parameter | Long parameter | Description | Note |
---|---|---|---|
vendor | Vendor | Supported vendor values (case insensitive):
| |
-i | --ip | MFD IP address | |
-p | --password | MFD admin password | |
-u | --username | MFD admin username |
Command examples
Ricoh
BASH.\terminaldeploymenttool UNINSTALL RICOH -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
FUJIFILM BI
BASH.\terminaldeploymenttool UNINSTALL FUJIFILMBI -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
After uninstalling FUJIFILM BI Cloud Terminal from a device, "Authentication/Accounting Type" should be set to "Off".
Follow the process described in FUJIFILM BI devices, section Turn on custom service authentication on the device, where you change the custom method to "Off" value.
CONFIGURE
Configures or re-configures an already installed Cloud Terminal.
Mandatory parameters
Short parameter | Long parameter | Description | Note |
---|---|---|---|
vendor | Vendor | Supported vendor values (case insensitive):
| |
-i | --ip | MFD IP address | |
-a | --apikey | API key | API key obtained from your SAFEQ Cloud account. |
-m | --server-domain | Server Domain | The domain of the server to which the Cloud Terminal will connect. It can be either domain of a cloud primary server or the domain of a local gateway. Example:
|
-u | --username | MFD admin username | |
-p | --password | MFD admin password |
Optional URL override parameters
Paths to all the needed services are resolved automatically from the --server-domain
parameter. In case of non-standard deployment, individual paths can be overridden using the following parameters:
Short parameter | Long parameter | Description | Note |
---|---|---|---|
-s | --sqts | Cloud Terminal API URL | Example:
|
-d | --idm | Authorization Service URL | Example:
|
-w | --scan | Scan server URL for document delivery | FUJIFILM BI Terminal only Example:
|
Command examples
Ricoh
BASH.\terminaldeploymenttool CONFIGURE RICOH -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
FUJIFILM BI (Cloud print method will be used as a default)
BASH.\terminaldeploymenttool CONFIGURE FUJIFILMBI -i <MFD_IP_ADDRESS> -m <SERVER_DOMAIN> -a <API_KEY> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
HELP
Displays help information about the specified command.
Command example
.\terminaldeploymenttool HELP INSTALL
Advanced commands
These commands are meant for more experienced users and are not commonly used. For general issues, it is recommended to uninstall and install the Terminal again.
RESTART
Reboots the MFD.
Parameters
Short parameter | Long parameter | Description | Note |
---|---|---|---|
vendor | Vendor | Currently supported (case insensitive):
| |
-i | --ip | MFD IP address | |
-p | --password | MFD admin password | |
-u | --username | MFD admin username |
Command example
Ricoh
BASH.\terminaldeploymenttool RESTART RICOH -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
FUJIFILM BI
BASH.\terminaldeploymenttool RESTART FUJIFILMBI -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
Advanced commands for Ricoh
CONFIGURE-SP-OPTIONS
Set SP options of the device.
Parameters
Short parameter | Long parameter | Description | Note |
---|---|---|---|
vendor | Vendor | Currently supported (case insensitive): RICOH | |
-i | --ip | MFD IP address | |
-p | --password | MFD admin password | |
-u | --username | MFD admin username |
Example command
.\terminaldeploymenttool CONFIGURE-SP-OPTIONS RICOH -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
CONFIGURE-CARD-READER
Configures card reader on the device
Parameters
Short parameter | Long parameter | Description | Note |
---|---|---|---|
vendor | Vendor | Currently supported (case insensitive): RICOH | |
-i | --ip | MFD IP address | |
-p | --password | MFD admin password | |
-u | --username | MFD admin username |
Example command
.\terminaldeploymenttool CONFIGURE-CARD-READER RICOH -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>
FETCH-CERTIFICATE
Configures custom authentication.
Parameters
Short parameter | Long parameter | Description | Note |
---|---|---|---|
vendor | Vendor | Currently supported (case insensitive): RICOH | |
-s | --sqts | SQTS Terminal URL | Address of your SAFEQ Cloud installation with SQTS port |
--force-untrusted | enables download of untrusted certificate | Without this parameter, a certificate will not be downloaded unless it's being trusted by the local workstation. |
Example command
.\terminaldeploymenttool FETCH-CERTIFICATE -s https://<SERVER_ADDRESS>:8705/ --force-untrusted
Advanced commands for FUJIFILM BI
CONFIGURE-FUJIFILM
Configures custom authentication.
Parameters
Short parameter | Long parameter | Description | Note |
---|---|---|---|
vendor | Vendor | Currently supported (case insensitive): FUJIFILMBI | |
-i | --ip | MFD IP address | |
-p | --password | MFD admin password | |
-u | --username | MFD admin username |
Command example
.\terminaldeploymenttool CONFIGURE-FUJIFILM FUJIFILMBI -i <MFD_IP_ADDRESS> -u <MFD_ADMIN_USERNAME> -p <MFD_ADMIN_PASSWORD>