Command lines
We are pleased to provide you with a comprehensive set of command-line tools designed to enhance the flexibility and efficiency of our software. These tools enable users to script and automate various functionalities, tailoring the software to meet their specific needs and workflows.
Explore the possibilities and optimize your experience with our command-line options.
You only have to run the following command lines as an elevated Administrator. As a reminder, AdminTool.exe and TwoFactor.Admin.exe (2FA addon) should be located here: C:\Program Files (x86)\TSplus\UserDesktop\files
Table of contents
- Backup data and settings
- Restore data and settings
- Webserver
- Update
- Apply Windows compatibility updates
- Install Universal Printer
- Remove Universal Printer
- Configure proxy server
- Open Web Credentials form
- Create Web Credentials
- Remove Web Credentials
- Open Session Manager
- Open Sessions monitor
- Open load-balancing manager
- Run system audit
- License activation
- License reset following cloning of a VM
- Volume license activation
- Enabling and disabling Volume license
- Volume license update
- Display remaining license credits for a Volume License key
- Display remaining support credits for a Volume License key
- 2FA - reset
- 2FA - add users
- 2FA - add groups
- 2FA - list users
- 2FA - delete user
Backup data and settings:
/backup
Syntax:
AdminTool.exe /backup [optionalPath] [parameters]
Description:
Command
/backup
is used to backup TSplus data and settings.
By default, the backup will be created in the archives directory (C:\Backupparam)
Parameters:
-
optionalPath: to backup in another directory than the default one. Relative and absolute paths are allowed. -
/silent: if this parameter is mentioned, the backup is done silently
Examples:
AdminTool.exe /backup AdminTool.exe /backup “c:/TSplus/CustomBackupFolder” /silent
For more information, please go to TSplus - Backup Settings
Restore data and settings:
/restore
Syntax:
AdminTool.exe /restore [backupPath] [parameters]
Description:
Command
/restore
is used to restore TSplus data and settings.
The specified backup directory must contain a data and a settings folder, as created by the /backup command.
Parameters:
-
backupPath: the path where is located the backup folder to restore. -
/silent: if this parameter is mentioned, the restore is done silently
Examples:
AdminTool.exe /restore “C:/Backupparam” /silent AdminTool.exe /restore “C:/TSplus/CustomBackupFolder” /silent
For more information, please go to TSplus - Backup Settings
Webserver:
/webstop
,
/webstart
and
/webrestart
Syntax:
AdminTool.exe /webstop
AdminTool.exe /webstart
AdminTool.exe /webrestart
Description:
Command
/webstop
is used to stop the Web server.
Command
/webstart
is used to start the Web server.
Command
/webrestart
is used to restart the Web server.
Parameters:
None
Update:
/update
Syntax:
AdminTool.exe /update [options]
Description:
Command
update
is used to update TSplus Remote Access and potentially Advanced Security.
Parameters:
-
[options]:-
/addons: if this option is used, Advanced Security is also updated, if a new version is available.
-
Example:
AdminTool.exe /update /addons
Apply Windows compatibility updates:
/updatekernel
Syntax:
svcac.exe /updatekernel [/silent]
svcac.exe should be located here: C:\Program Files (x86)\TSplus
Description:
Command
/updatekernel
is used to apply Windows compatibility updates.
These automatic updates ensure that TSplus Remote Access remains compatible with new Windows updates and avoid the need to download and reinstall a newer version of TSplus Remote Access.
Windows compatibility updates can occur daily. TSplus Remote Access allows forced updating. This is useful when compatibility seems broken, and you need to retrieve the latest TSplus Remote Access patch outside of the regular update schedule.
Please note that a valid license is required to retrieve compatibility updates. If your trial license has expired or if your license is invalid, an error message box will be displayed. Please contact our support team with a screenshot of this error message if the issue is unexpected.
Parameters:
-
[/silent]: Update silently by providing this parameter. No message box will be displayed.
Install Universal Printer:
/InstallUniversalPrinter
Syntax:
universalprintermanagement.exe /InstallUniversalPrinter
universalprintermanagement.exe is located here: C:\Program Files (x86)\TSplus\UserDesktop\files
Description:
Command
/InstallUniversalPrinter
is used to install Universal Printer.
This is a clean install as it removes existing Universal Printer if previously installed.
Parameters:
None
You can also perform this action manually, please look at Universal Printer
Remove UniversalPrinter:
/RemoveUniversalPrinter
Syntax:
universalprintermanagement.exe /RemoveUniversalPrinter
universalprintermanagement.exe is located here: C:\Program Files (x86)\TSplus\UserDesktop\files
Description:
Command
/RemoveUniversalPrinter
is used to uninstall Universal Printer.
Parameters:
None
You can also perform this action manually, please look at Universal Printer
Configure proxy server:
/proxy /set
Syntax:
AdminTool.exe /proxy /set [parameters]
Description:
Command
/proxy /set
is used to configure a proxy server for Internet access.
Parameters:
-
/host: the destination host can be a predefined value (“ie” or “none”) or a user-defined value (e.g: 127.0.0.1 or proxy.company.org). This parameter is mandatory -
/port: the port number used to connect to the proxy server. Required if the hostname value is a custom user-defined value. -
/username: the username to connect to the proxy server. This setting is optional -
/password: the user’s password must be supplied if a username has been defined. However, its value can be empty
Examples:
AdminTool.exe /proxy /set /host proxy.company.org /port 80 /username dummy /password pass@word1
AdminTool.exe /proxy /set /host ie
For more information, please go to How to configure a Proxy Server for Internet Access?
Open Web Credentials form:
/webcredentials
Syntax:
AdminTool.exe /webcredentials
Description:
Command
/webcredentials
launches in a single window the Web Credentials interface (as you would do in AdminTool > Web > Web Credentials).
Parameters:
None
Create Web Credentials:
/webcredentials-add
Syntax:
AdminTool.exe /webcredentials-add [webLogin] [webPassword] [windowsLogin] [windowsPassword] [maximumConcurrentSessions]
Description:
Command
/webcredentials-add
is used to create Web Credentials (as you would do in AdminTool > Web > Web Credentials).
Parameters:
-
webLogin: the web login you want to create. -
webPassword: the associated web password. It can be blank credential. For that, use double quotes "" to indicate a blank password -
windowsLogin: the Windows login of the corresponding user. -
windowsPassword: the Windows password. -
maximumConcurrentSessions(optional): the maximum number of concurrent sessions for this user.
Example:
AdminTool.exe /webcredentials-add johndoe passwordABCD johnWinuser johnWinpassword 4
For more information, please go to Web Credentials
Remove Web Credentials:
/webcredentials-remove
Syntax:
AdminTool.exe /webcredentials-remove [webLogin]
Description:
Command
/webcredentials-remove
is used to remove an existing Web Credential (as you would do in AdminTool > Web > Web Credentials).
Parameters:
-
webLogin: the web login you want to remove.
Example:
AdminTool.exe /webcredentials-remove johndoe
For more information, please go to Web Credentials
Open Session Manager:
/sessionmanager
Syntax:
AdminTool.exe /sessionmanager
Description:
Command
/sessionmanager
launches in a single sizable-window the session manager (as you would do in AdminTool > Home > Session Manager).
Parameters:
None
Open Sessions monitor:
/farm-sessions-monitor
Syntax:
AdminTool.exe /farm-sessions-monitor
Description:
Command
/farm-sessions-monitor
launches in a single sizable-window the session monitor of the farm manager (as you would do in AdminTool > Farm > Monitor Sessions).
Parameters:
None
Open Load balancing manager:
/farm-loadbalancing
Syntax:
AdminTool.exe /farm-loadbalancing
Description:
Command
/farm-loadbalancing
launches in a single sizable-window the load balancing manager of the farm manager (as you would do in AdminTool > Farm > Load Balancing).
Parameters:
None
Run system audit:
/systemaudit
Syntax:
AdminTool.exe /systemaudit
Description:
Command
/systemaudit
runs a system audit (as you would do manually in AdminTool > Home > System Audit > Run System Audit).
Parameters:
None
License activation:
/activate
Syntax:
AdminTool.exe /activate [licensePath]
Description:
Command
activate
is used to activate Remote Access license, using a license file.
Parameters:
-
[licensePath]: the path of the license file
Example:
AdminTool.exe /activate “C:\Program Files (x86)\TSplus\license.lic”
License reset following cloning of a virtual machine:
/reset
Syntax:
AdminTool.exe /license /reset
Description:
When cloning a server, the ‘License’ tab in AdminTool may not display a Computer ID or might show the error message: “Invalid hardware identifier.” The command
/reset
aims to initialize licensing on the clone server so that new licenses can be assigned for the installed TSplus products.
Important Notes:
- A new TSplus license must be activated using a new Activation Key.
- Do not use the /license /reset command on a non-cloned machine, as it permanently prevents license assignment. Always confirm the machine’s status before proceeding.
Steps to reset license on a cloned server:
-
Open an Administrator session on the cloned server.
-
Change the HDD Volume Serial Number.
-
Execute the
volcommand to display the current Volume Serial Number (VSN). The result should ressemble:74F8-9C08. -
Download and install the VolumeID utility, available here .
-
Execute the command:
volumeid C: 84F8-9C08as an administrator to change the drive VSN. In this example, we changed the VSN of disk C: and I have changed only one character (the first) of the old VSN to specify the new one. -
Note: this step is critical because certain Windows Server versions do not generate a new Volume Serial Number during cloning, even when using SysPrep.
-
Rename the cloned server and restart it.
-
Reset the License in AdminTool:
-
Open a Command Prompt with Administrator privileges.
-
Navigate to the directory containing the AdminTool executable using this command:
cd "C:\Program Files (x86)\TSplus\UserDesktop\files" -
Execute the following command:
AdminTool.exe /license /reset
- Verify the reset.
-
After running the command, the ‘License’ tab should display the following error:
"Failed to read license file (unexpected file format)."
- Activate the new license.
- In the ‘License’ tab, click ‘Activate your license’ and enter the new Activation Key to activate the required licenses and supports.
Example:
AdminTool.exe /license /reset TSplus-Security.exe /license /reset ServerMonitoring.exe /license /reset
Volume license activation:
/vl /activate
Syntax:
AdminTool.exe /vl /activate [licensekey] [parameters]
Description :
Command
vl /activate
is used to activate a volume license.
Parameters:
-
licensekey: license key to activate, in this format: AAAA-BBBB-CCCC-DDDD -
/users: any number from 1 to 50, or “unlimited” -
/edition: “Desktop”, “MobileWeb” or “Enterprise” -
/supportyears: Any number from 0 to 3. -
/comments: Specifies the comments to attach to the license on the License portal
Example:
AdminTool.exe /vl /activate VOLU-MELI-CENS-EKEY /users unlimited /edition Enterprise /supportyears 3 /comments “This is a comment”
For more information, please go to Volume license documentation
Enabling and disabling Volume license:
/vl /enable
and
/vl /disable
Syntax:
AdminTool.exe /vl /enable [licensekey]
AdminTool.exe /vl /disable [licensekey]
Description:
Command
vl /enable
is used to enable a volume license.
Command
vl /disable
is used to disable a volume license.
Parameters:
-
licensekey: license key to enable/disable, in this format: AAAA-BBBB-CCCC-DDDD
Examples:
AdminTool.exe /vl /enable VOLU-MELI-CENS-EKEY
AdminTool.exe /vl /disable VOLU-MELI-CENS-EKEY
For more information, please go to How to enable/disable a License from the Server?
Volume license update:
/vl /update
Syntax:
AdminTool.exe /vl /update [licensekey] [parameters]
Description:
Command
vl /update
is used to update the users of a volume license.
Parameters:
-
licensekey: license key to update, in this format: AAAA-BBBB-CCCC-DDDD -
/users: any number from 1 to 50, or “unlimited”
Examples:
AdminTool.exe /vl /update /users 2 AdminTool.exe /vl /update /users unlimited
For more information, please go to How to Update the Users of a Volume License from the Server?
Display remaining license credits for a Volume License key:
/vl /credits-license
Syntax:
AdminTool.exe /vl /credits-license [licensekey] [parameters]
Description:
Command
vl /credits-license
is used to display the remaining license credits associated with a Volume License key.
Parameters:
-
licensekey: Volume License key, in this format: AAAA-BBBB-CCCC-DDDD -
/login: provide the login of the partner associated with the Volume License key -
/edition: provide the optional edition parameter for Advanced Security and Server Monitoring products -
/silent: executes the command silently
The output will be stored in the user-level environment variable named
VOLUME_LICENSE_CREDITS
. It may be required to read the value of
VOLUME_LICENSE_CREDITS
from a different process, using the command
echo %VOLUME_LICENSE_CREDITS%
.
Examples:
AdminTool.exe /vl /credits-license VOLU-MELI-CENS-EKEY /login JOHNDOE TSplus-Security.exe /vl /credits-license VOLU-MELI-CENS-EKEY /login JOHNDOE /edition Essentials /silent
For more information, please go to How to display the remaining license credits for a Volume License key?
Display remaining support credits for a Volume License key:
/vl /credits-support
Syntax:
AdminTool.exe /vl /credits-support [licensekey] [parameters]
Description:
Command
vl /credits-support
is used to display the remaining support credits associated with a Volume License key.
Parameters:
-
licensekey: Volume License key, in this format: AAAA-BBBB-CCCC-DDDD -
/login: provide the login of the partner associated with the Volume License key -
/edition: provide the optional edition parameter for Advanced Security and Server Monitoring products -
/silent: executes the command silently
The output will be stored in the user-level environment variable named
VOLUME_LICENSE_CREDITS
. It may be required to read the value of
VOLUME_LICENSE_CREDITS
from a different process, using the command
echo %VOLUME_LICENSE_CREDITS%
.
Examples:
AdminTool.exe /vl /credits-support VOLU-MELI-CENS-EKEY /login JOHNDOE TSplus-Security.exe /vl /credits-support VOLU-MELI-CENS-EKEY /login JOHNDOE /edition Essentials
For more information, please go to How to display the remaining support credits for a Volume License key?
2FA - reset:
/resetuser
Syntax:
TwoFactor..Admin.exe /resetuser [user1] [user2] … [userN]
Description:
Command
/resetuser
is used to reset 2FA users, instead of doing it through the user interface (this can be done here in the interface: TwoFactor.Admin > Manage Users > Reset)
Parameters:
-
user1 user2 ... userN: the domain names of the users you want to reset (separated by simple space)
Examples:
TwoFactor.Admin.exe /resetuser johndoe jackrussell chuckbartowski
For more information, please go to Reset Configuration for Users
2FA - add users:
/addusers
Syntax:
TwoFactor.Admin.exe /addusers [userInfos1] [userInfos2] … [userInfosN]
Description:
Command
/addusers
is used to add several 2FA users, instead of doing it through the user interface, user by user (this can be done here in the interface: TwoFactor.Admin > Manage Users > Add User)
Parameters:
-
userInfos1 userInfos2 ... userInfosN: the user infos of the users you want to add. These infos consist of the following fields, separated by a semi-colon:-
domainName(mandatory): the domain Name of the user to add -
receivedMethod(optional): the method to receive confirmation codes. Has to be one of these values: SMS, App, Email or LetTheUserChoose. App is the default value. -
mobilePhone(optional): the phone of the user to add -
email(optional): the email of the user to add
-
Examples:
TwoFactor.Admin.exe /addusers johndoe jackrussell;LetTheUserChoose chuckbartowski;Phone;+33101010101; [email protected] samanthacarter;Email;;
For more information, please go to Add Users and Groups
2FA - add groups:
/addgroups
Syntax:
TwoFactor.Admin.exe /addgroups [group1] [group2] … [groupN]
Description:
Command
/addgroups
is used to add several 2FA groups, instead of doing it through the user interface, group by group (this can be done here in the interface: TwoFactor.Admin > Manage Users > Add Group)
Parameters:
-
group1 group2 ... groupN: the names of the groups you want to add.
Examples:
TwoFactor.Admin.exe /addgroups group1 group2 group3
For more information, please go to Add Users and Groups
2FA - list users:
/getusers
Syntax:
TwoFactor.Admin.exe /getusers
Description:
Command
/getusers
is used to get a list of all users/groups configured into 2FA administration console. A json representation of this list of users/groups is returned, and can be used for example in a Powershell script.
This list can be seen here in the interface: TwoFactor.Admin > Manage Users.
Parameters:
None
2FA - add groups:
/deleteuser
Syntax:
TwoFactor.Admin.exe /deleteuser [domainName] [userType]
Description:
Command
/deleteuser
is used to remove a user from 2FA configuration (this can be done here in the interface: TwoFactor.Admin > Manage Users > Remove)
Parameters:
-
domainName: the name of the user or the group to remove. -
userType: the type of object to delete. Its value must be “user” or “group”
Examples:
TwoFactor.Admin.exe /deleteuser “This is a group name” group TwoFactor.Admin.exe /deleteuser administrator user
For more information, please go to Remove Users and Groups
