OTG Installation Parameters
A detailed description, with examples, of the required and optional parameters needed when creating a command line script to install WebTitan OTG.
When creating your command line script for OTG installation, as well as the required parameters there are also several optional parameters that you can use.
Required Parameter | Description | Example |
|---|---|---|
RPC_URL | Your WebTitan OTG URL and (optional) port number. See WebTitan OTG URLs to determine your OTG URL. The RPC port is always port 7771 and is automatically added if not included in the RPC_URL parameter. The example(s) show the accepted formats. | your-otg-url.webtitancloud.com your-otg-url.webtitancloud.com:7771 https://your-otg-url.webtitancloud.com https://your-otg-url.webtitancloud.com:7771 https://your-otg-url.webtitancloud.com:7771/ |
INSTALL_KEY | This is the OTG install key used to register an OTG device on WebTitan. You can get this in WebTitan from Settings > Device Configuration and noting the OTG Install Key. | 00000z0z-0zz0-0000-zz0z-0zz000z0zz0z |
PREFER_MASTER_CONFIG | This parameter ensures that your device count is accurate and duplicates are not created. PREFER_MASTER_CONFIG looks for an existing config file on the device OTG is being installed to. If found, that configuration is used. Otherwise, a new device is created with the parameters provided. |
WarningValue is case sensitive, so true is valid, but True is invalid. |
Optional Parameter | Description | Example |
|---|---|---|
DEVICE_NAME_PREFIX | This is an optional prefix that can be used to help with device identification in WebTitan. For example, if DEVICE_NAME_PREFIX is specified as 'sales' for a group installation, all devices are given the prefix 'sales', e.g. sales-example1.comp, sales-example2.comp. |
|
DEVICE_NAME | If a DEVICE_NAME is not provided, the installer uses the machine name, e.g. example_laptop.comp. If a DEVICE_NAME is provided, this is the name used when registering a device on WebTitan during installation, e.g. training_laptop. If a device name is specified, but already in use in WebTitan, a randomized number is appended to make the device name unique, e.g. example.comp#12345123451234. |
|
LOCATION_NAME | When OTG 2 is installed, a virtual location is automatically created for a device on WebTitan and given a default name. However, you can specify a location name to use with the LOCATION_NAME parameter on install. A virtual location can either be created on WebTitan before installation and then the name can be used in this parameter, or, if not already created, the virtual location is created and assigned the name given in this parameter on install. |
|
DEVICE_KEY | To locate an individual device key WebTitan, go to Environment > Devices and select a device. The device key is listed under Device Details. The DEVICE_KEY is used to identify a single device and is typically used during re-installation. It can be added manually, or from the RPC call with the INSTALL_KEY parameter. DEVICE_KEY is not used in multiple-user rollouts. DEVICE_KEY and INSTALL_KEY are mutually exclusive, so can not be used together. |
|
HIDE_TRAY_ICON | NoteHIDE_TRAY_ICON works with WebTitan OTG 2 for Windows version 2.0.3 or later. Use this parameter on installation to hide the OTG 2 |
|
FULL_CLEAN | This parameter removes configuration and log files from previous installations and can be used if you want a clean install. A new virtual location and device is created on install. The following folders are removed:
|
|
