Simple Command Line Arguments

 

Let us begin with a simple example:

ISLLight.exe --username demo --password demo --get-code

 

Save the ISL Light executable to a certain directory on your disk, open the Command Prompt (cmd) and type in the above line. It will start ISL Light executable in the current directory and automatically obtain a session code using the username demo and password demo. The "Run Once" option will automatically be selected since username and password are provided.

 

Please refer to the following list for a detailed description of simple command line arguments:

--setup
 This option will install ISL Light. It will start the same way as by clicking the "Install" button. 
--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. 
--setup-silent-and-open
 ISL Light will install without confirming dialogs and will open when setup is done (ISL Light 4.0.4+) 
--setup-and-exit
 ISL Light will start in setup mode and after installation it will not open ISL Light application (ISL Light 4.0.4+) 
/VERYSILENT
 This option functions in the same way as --setup-silent (available for ISL Light 4.0.3+) 
--run-once
 Skip the initial dialog when starting ISL Light (Install or 'Run Once'). 'Run Once' is automatically selected.
 
--connect-search <search string>
 This option allows you to search for a computer by description, name, or tag. It will search for the particular computer and then connect to it if there is one result returned. If there is more than one computer returned then it will show the list of results (available for ISL Light 4.0.3+). 
--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.
 
--hide-gui
 This option hides the ISL Network Start GUI, for the purpose of deployment.
 
--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.:
--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>
 
--username <username>
 This option is used to specify the username that should be used to log in ISL Light. 
--password <password>
 This option is used to specify the password that should be used to log in ISL Light. 
--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. 
--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. 
--connect <computer_id>
--connect <session_code>
 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".
 
--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].

 
--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. 
--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. 
--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:
0x00 - unconnected
0x01 - connecting with session code used in LPARAM
0x02 - connected
0x04 - streaming
0x40 - streaming with remote side having control
0x08 - receiving stream
0x10 - value of server ID in LPARAM
0x20 - value of session ID in LPARAM
0x8000 - error bit (lower portion of the code defines error code)
 
--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. 
--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. 
--force-transport <transport type>
 Use this option to force a desired type of transport. The following values are available for <transport type>:
direct
wininet-http
wininet-https
wininet-html
httpt-direct
https-direct
httpt-proxy
https-proxy
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.		 
--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.
Important: Please note that this is an advanced option and should be used for troubleshooting purposes only. The default connection address takes advantage of our load balancing with many parameters and automatically redirects you to the optimal server (based on your location, our server load, our optimizations, etc.). 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.		 
--proxy-address-hint <server ip>
 Use this option in combination with --proxy-address option. If you specify the proxy address as a DNS name, then you can use --proxy-address-hint to specify the server's IP address to skip DNS resolving step. If the hint fails, then it is discarded and DNS resolving is used to find the server address from --proxy-address parameter. 
--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:
--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.		 
--stream-options <options> (ISL Light 4.0.4+)
 Disable or enable specific stream options when connecting to an ISL AlwaysOn computer using command line arguments. Users can specify the following options:
select remote session (prompt the user to select a remote session to connect to. Users can select between Console or RDP session. (RDP session has to be active on the remote computer.) Use in combination with --user-session parameter
_download_client=false (disable/enable downloading of ISL Light Client, ISL Light fast will be used - false/true)
small_foot=false (disable/enable small footprint GUI on a remote computer - false/true)
total_control=false (disable/enable total control option - option to disable/enable the user to use keyboard and mouse - false/true)
black_screen=false (disable/enable black screen once connected to a remote computer - false/true)
leave_background=false (disable/enable remote desktop background when connected - false/true)
stream_high_color=false (disable/enable the remote computer to stream in high color - false/true)
minimized_client=false (disable/enable minimizing of ISL Light client on the remote side once connected to the computer - false/true)
User-defined stream options can also be disabled here.
Example:
ISLLigth.exe --username demo --password demo --connect-search tom --stream-options "_download_client=true&black_screen=true" 

 
--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:
--user-session "id:1" (select session based on session id. 1 - console session, 2 - RDP session)
--user-session "user:<username>" (select session based on remote user name)
--user-session "user:\\<domain>\<username>" (select session based on user name with domain)
--user-session "console" (connect directly to console session)

Example (ID):
 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. (added in ISL Light 3.5.2 and module 3.5.3)


Tags: customization, advanced customization, command line arguments, simple command line arguments, simple, cmd

Was this article helpful?

Cookie Consent

We use cookies to deliver and maintain ISL Online services, as well as to ensure the best browsing experience for our users. Three types of cookies are used:

Detailed information about the Cookies, their purpose, lifetime, expiration date and more can be found in our Cookie Policy and Privacy Policy. You can update your cookie preferences at any time.