Use the UIM with command line

Top  Previous  Next
Solution Installation > TSS Installation > Install TSS on a standard server

Overview

This section describes how to use the UIM using command line arguments.

 

 

Argument list

This section lists the different arguments available for the command line.

 

new_install: specify that this is a new TSS installation.

/new_install

 

upgrade: for upgrading an existing TSS version.

/upgrade

 

uninstall: To uninstall an existing TSS version.

/unsintall

 

replicate: Add replication to an existing TSS version.

/replicate

 

unreplicate: remove replication from an existing TSS version.

/unreplicate

 

port: specify the port used to connect to the database.

/port:3306

 

id: specify the redundancy identity of the TSS. Values between 1 and 6.

/id:1

 

login: The login sued to connect to the database.

/login:mylogin

 

password: The password used to connect to the database.

/password:mypassword

 

path: The path to the file where the UIM logs will be written.

/path:C:\uim_install.txt

 

database_host: The database address.

/database_host:255.255.255.255

 

database_driver: Which type of database will be used. We support MySQL or SQLSERVER. The two values are MySQL or SQLSERVER.

/database_driver:SQLSERVER

 

external_database: Whether or not to use an already existing database. Default to false.

/external_database:true

 

database_name: The name of the database when using an external database.

/database_name:dbipt_10.1.1

 

version: The version of the TSS to upgrade/unsinstall/replicate/unreplicate.

/version:10.1.0

 

associate: For an upgrade, set to true to associate the device from the existing version to the new version. Default value is false.

/associate:true

 

remote: The address of the database of the replicated TSS.

/remote:255.255.255.255

 

remote_port: The port of the database of the replicated TSS.

/remote_port:3306

 

setasdefault: for replication, to specify if this is the default version. Default to false.

/setasdefault:true

 

service: the mysql service name (MYSQL8029 for MySQL 8.0.29 for example). Not used for SQL Server.

/service:MYSQL8030

 

UAMI: To connect to the database using Azure UAMI. Default to false.

/UAMI:true

 

no_master_access: For Azure database, prevent the UIM from accessing the master database. Needs to use an existing database.

/no_master_access:true

Mandatory arguments

For each use of the UIM in command line there is a list of mandatory argument for the UIM to work. Some might not be relevant (like remote, remote_port or service) and can be left blank:

 

new_install: port, id, remote, remote_port, service, login, path

upgrade: port, version, id, remote, remote_port, service, login, path, associate

uninstall: port, version, id, remote, remote_port, service, path

replicate: port, version, id, remote, remote_port, service, login, path

unreplicate: port, version, id, remote, remote_port, service, path

 

Examples

 

Here is a command line example for each use:

 

new_install:

UIM.exe /new_install /port:3306 /id:1 /remote: /remote_port:3306 /service: /database_host:10.221.7.65 /database_driver:SQLSERVER /login:root /password:"password" /path:"F:\LocalLogs\20210409_111817-UIMNewInstall.txt" /external_database:true

 

replicate:

UIM.exe /replicate /port:3307 /version:9.3.3.49126 /id:1 /remote:10.221.6.53 /remote_port:3307 /database_host:10.221.7.65 /database_driver:SQLSERVER /service: /login:root /password:"password" /path:"F:\LocalLogs\20190516_081319-UIMReplicate.txt" /setasdefault:true /external_database:true

 

uninstall:

UIM.exe /uninstall /port:3306 /version:9.7.2.55939 /id:1 /remote: /remote_port:3306 /database_host:10.221.7.65 /database_driver:SQLSERVER /service: /path:"F:\LocalLogs\20220817_112604-UIMRemoval.txt" /external_database:true

 

upgrade:

UIM.exe /upgrade /port:3308 /version:9.7.4.56087 /id:1 /remote: /remote_port:3308 /database_host:10.221.7.65 /database_driver:SQLSERVER /service: /login:root /password:"password" /path:"F:\LocalLogs\20220817_111810-UIMUpgrade.txt" /associate:true /external_database:true