This guide provides instructions on using command-line arguments options, allowing users to customize ISL Light behavior for specific requirements. Command-line arguments can be divided on two parts.
- Command-Line Arguments (current page)
- Command-Line Arguments with Events (next article)
Example:
Let's dive in with a simple example:
ISLLight.exe --username "demo" --password "demo" --get-code
By executing this command, ISL Light will start with the provided username ("demo") and password ("demo"), and automatically obtaining a session code.
Command-line Arguments
Installation Commands
These command lines are used when installing or running once ISL Light.
Command | Description |
---|---|
--run-once |
Skip the initial dialog when starting ISL Light (Install or Run Once). 'Run Once' is automatically selected. Example: ISLLight.exe --run-once |
--setup |
This option will install ISL Light. It will start the same way as by clicking the "Install" button. Example: ISLLight.exe --setup |
--setup-silent |
This option will install ISL Light. It will start the same way as by clicking the install button and also suppress any dialogs that might show during installation. Example: ISLLight.exe --setup-silent |
--setup-silent-and-open |
ISL Light will install without confirming dialogs and will open when setup is done. Example: ISLLight.exe --setup-silent-and-open |
--setup-and-exit |
ISL Light will start in setup mode and after installation it will not open ISL Light application. Example: ISLLight.exe --setup-and-exit |
/VERYSILENT |
This option functions in the same way as --setup-silent. Example: ISLLight.exe /VERYSILENT |
--hide-gui |
This option hides the ISL Network Start GUI, for the purpose of deployment. Example: ISLLight.exe --hide-gui |
Login Commands
These command lines are used when logging into ISL Light.
Command | Description |
---|---|
--username <username> |
This option is used to specify the username that should be used to log in ISL Light. Example: ISLLight.exe --username "Sam" |
--password <password> |
This option is used to specify the password that should be used to log in ISL Light. Example: ISLLight.exe --password "Top_Secret_Password" |
--web-login |
This option is used to specify the webtoken that should be used for obtaining a session code. Session code can be obtained through webapi2 call (utils/login/1) to the ISL Conference proxy server. Example: ISLLight.exe --web-login "3_ppaRMxQqUFS85pLJQdRExAdHO33zmndhfmd34awthHSTNTSETNLcRFo81pXEmlkOzPgyXV34kSVE_mWUjOuJXAqF4RScw18p35mYEAgEBrruXEmlkOzPgjOuJXAqjdrDSR--" |
Remote Support Commands
These command lines are used when creating a session with session code.
Command | Description |
---|---|
--get-code |
This option instructs ISL Light to automatically request a session code upon program startup. The obtained session code is then stored in the file code_file.isl. You can specify this file's location with the option --output-file. Example: ISLLight.exe --get-code |
--output-file |
This option specifies the name and location of the file containing the session code and information of the ISL Light session. e.g.: Example: ISLLight.exe --output-file "C:\tim\ISLLight\session-code.txt" The file has the following content: <session code> <internal isl light session id> <unique ID of the server> <local id of the Server> <dbid string - encoded internal isl light session id> |
--connect <session_code> |
This option allows you to connect to a session (by using a session code), --gui-type isl_alwayson_connect will also have to be defined). Example: ISLLight.exe --connect "12345678" |
Remote Access Commands
These command lines are used when connecting to a unattended computer.
Command | Description |
---|---|
--connect <computer_id> |
This option allows you to either connect to a session (by using a session code) or specify to which ISL AlwaysOn computer from your list you want to connect to (when using ISL Light 4.0.2 or lower, --gui-type isl_alwayson_connect will also have to be defined). <computer_id> can be retrieved using "islalwayson/computer/search/2" webapi method, look for returned value field "co_id". Example: ISLLight.exe --connect "d615f305f36383308016e0dffda8e0b8dffa1776179736f6e5f573315f30a8e0b8dff656374696f6e6e731701b8dffa1b8dffa" |
--connect-uid <computer_uid> |
This option allows you to specify to which ISL AlwaysOn computer from your list you want to connect using a unique identifier. <computer_uid> can be retrieved from the registry file of a remote computer [Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\ISL Online\ISL AlwaysOn\uid]. Example: ISLLight.exe --connect-uid "1666e95bbf8ec34e932bb-d8d222cc74337-1473-171343497473241666bb-d2" |
--connect-search <parameter> |
This option allows you to specify to which ISL AlwaysOn computer from your list you want to connect using search function based on either:
Example: ISLLight.exe --connect-search "Work PC" |
--computer-password <access password> |
Access password of the remote computer. Use this in combination with --connect-search / --connect / --connect-uid parameters to automatically log into a remote computer. Example: ISLLight.exe --connect-search "Work PC" --computer-password "Top_Secret_Password" |
--computer-password-MD5 <md5 hash of access password> |
The option works in the same way as --computer-password, except the md5 hash value of the access password for the chosen computer is provided, to avoid having the access password written in plain text. Example: ISLLight.exe --computer-password-MD5 "363f713755691e339ae48021d6189fab" |
--stream-options <options> |
Disable or enable specific stream options when connecting to an ISL AlwaysOn computer using command line arguments. Users can specify the following options:
Example: ISLLigth.exe --username Sam --password "Top_Secret_Password" --connect-search tom --stream-options “_download_client=true&black_screen=true” |
Network Commands
These command lines are used for networking, and advanced features.
Command | Description |
---|---|
--grid-conf |
This option is used to specify which grid to use. You can have several different connections so if you want to perform a login using cmdline parameters then you also need to specify a connection to use. Example: ISLLight.exe --grid-conf "ISL Online Network" |
--notification-thread <thrd_ID> [--notification-message <msg>] |
Users that embed ISL Light Desk and ISL Light Client in their application (product) should use this option. To specify the Windows message loop thread that will handle ISL Light notifications and the message sent to that thread use the option. In case when no notification message is specified, WM_USER is used. Notification messages are sent from ISL Light with a PostThreadMessage Window API call. Parameter wParam is a bit-field that defines the following ISL states:
|
--session-message <user_defined_message> |
Custom message can be stored in ISL Conference Proxy logs by using this option. This message can be used for matching an ISL Light session ID with an external user-defined session ID. Example: ISLLight.exe --session-message <user_defined_message> |
--mtu [0,1,2] |
Set communication MTU (maximum transmission unit) in ISL Light Desk that will fix problems in some environments that don't have the correct value of MTU in their network configuration. Value 0 means normal MTU while value 2 will set the smallest value - 100 bytes in one IP packet. Example: ISLLight.exe --mtu "0" |
--force-transport <transport type> |
Use this option to force a desired type of transport. The following values are available for <transport type>:
Important: Please note that this is an advanced option and should only be used in specific situations. If you experience any problems with your connection, please come to our live chat or write an e-mail to support@islonline.com - we will check the situation and provide further instructions. Example: ISLLight.exe --force-transport "direct" |
--proxy-address <server address> |
Use this option to specify the desired server address that should be used for connecting, e.g. server13.islonline.net for our Japanese server.
Example: ISLLight.exe --proxy-address <server address> |
--httpt-port <port> | Use this option to specify the port that should be used for connection (default is 7615 and should not be changed unless instructed to do so by our technical support team). |
--conn-options <options> |
Use this to pass special connect options such as HTTP proxy address, username, password, and transport boost. Example: ISLLight.exe --conn-options "http_proxy=1.2.3.4&http_proxy_user=myuser&http_proxy_password=mypassword&boost=wsstun-direct" Important: Please note that this is an advanced option and should only be used in specific situations. If you experience any problems with your connection, please come to our live chat or write an e-mail to support@islonline.com - we will check the situation and provide further instructions. |
--user-session <options> |
Users can now specify to which remote session they would like to connect to (existing RDP session). The following syntax is supported:
Example: ISLLight.exe --connect [aon_iod] --stream-options "select remote session" --user-session "id:2" Example (Domain+Username): (the session is listed as "BLUEROOM:Dusan (RDP-TCP)" in the remote session dropdown menu): ISLLight.exe --grid-conf "target-grid" --web-login "web-token" --connect "co-id" --computer-password-MD5 "nice-try" --user-session "user:\\BLUEROOM\Dusan" |
--proxy-notification external_id=XXX | Sets external Id field in session to be retrieved or searched later on through API. |
Next Article:
Command Line Arguments with Events