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
/backupAdminTool.exe /backup [optionalPath] [parameters]
Command /backup is used to backup TSplus data and settings.
By default, the backup will be created in the archives directory (C:\Backupparam)
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 silentlyAdminTool.exe /backup
AdminTool.exe /backup "c:/TSplus/CustomBackupFolder" /silent
For more information, please go to TSplus - Backup Settings
/restoreAdminTool.exe /restore [backupPath] [parameters]
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.
backupPath: the path where is located the backup folder to restore./silent: if this parameter is mentioned, the restore is done silentlyAdminTool.exe /restore "C:/Backupparam" /silent
AdminTool.exe /restore "C:/TSplus/CustomBackupFolder" /silent
For more information, please go to TSplus - Backup Settings
/webstop, /webstart and /webrestartAdminTool.exe /webstop
AdminTool.exe /webstart
AdminTool.exe /webrestart
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.
None
/updateAdminTool.exe /update [options]
Command update is used to update TSplus Remote Access and potentially Advanced Security.
[options]:
/addons: if this option is used, Advanced Security is also updated, if a new version is available.AdminTool.exe /update /addons
/updatekernelsvcac.exe /updatekernel [/silent]
svcac.exe should be located here: C:\Program Files (x86)\TSplus
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.
[/silent]: Update silently by providing this parameter. No message box will be displayed./proxy /setAdminTool.exe /proxy /set [parameters]
Command /proxy /set is used to configure a proxy server for Internet access.
/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 emptyAdminTool.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?
/webcredentials-addAdminTool.exe /webcredentials-add [webLogin] [webPassword] [windowsLogin] [windowsPassword] [maximumConcurrentSessions]
Command /webcredentials-add is used to create Web Credentials (as you would do in AdminTool > Web > Web Credentials).
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 passwordwindowsLogin: the Windows login of the corresponding user.windowsPassword: the Windows password.maximumConcurrentSessions (optional): the maximum number of concurrent sessions for this user.AdminTool.exe /webcredentials-add johndoe passwordABCD johnWinuser johnWinpassword 4
For more information, please go to Web Credentials
/webcredentials-removeAdminTool.exe /webcredentials-remove [webLogin]
Command /webcredentials-remove is used to remove an existing Web Credential (as you would do in AdminTool > Web > Web Credentials).
webLogin: the web login you want to remove.AdminTool.exe /webcredentials-remove johndoe
For more information, please go to Web Credentials
/sessionmanagerAdminTool.exe /sessionmanager
Command /sessionmanager launches in a single sizable-window the session manager (as you would do in AdminTool > Home > Session Manager).
None
/farm-sessions-monitorAdminTool.exe /farm-sessions-monitor
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).
None
/systemauditAdminTool.exe /systemaudit
Command /systemaudit runs a system audit (as you would do manually in AdminTool > Home > System Audit > Run System Audit).
None
/activateAdminTool.exe /activate [licensePath]
Command activate is used to activate Remote Access license, using a license file.
[licensePath]: the path of the license fileAdminTool.exe /activate "C:\Program Files (x86)\TSplus\license.lic"
/vl /activateAdminTool.exe /vl /activate [licensekey] [parameters]
Command vl /activate is used to activate a volume license.
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 portalAdminTool.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
/vl /enable and /vl /disableAdminTool.exe /vl /enable [licensekey]
AdminTool.exe /vl /disable [licensekey]
Command vl /enable is used to enable a volume license.
Command vl /disable is used to disable a volume license.
licensekey: license key to enable/disable, in this format: AAAA-BBBB-CCCC-DDDDAdminTool.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?
/vl /updateAdminTool.exe /vl /update [licensekey] [parameters]
Command vl /update is used to update the users of a volume license.
licensekey: license key to update, in this format: AAAA-BBBB-CCCC-DDDD/users: any number from 1 to 50, or "unlimited"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?
/resetuserTwoFactor..Admin.exe /resetuser [user1] [user2] .... [userN]
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)
user1 user2 ... userN: the domain names of the users you want to reset (separated by simple space)TwoFactor.Admin.exe /resetuser johndoe jackrussell chuckbartowski
For more information, please go to Reset Configuration for Users