Simple command line arguments

 

Let us begin with a simple example:

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

 

Save ISL Light Desk executable to a certain directory on your disk, open the Command Prompt (cmd) and type in the above line. It will start ISL Light Desk executable in the current directory and automatically obtain a session code using the username demo and password demo.

 

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

--auto-close
 This option instructs ISL Light Desk to close the program after the ISL Light session has ended.
 
--get-code
 This option instructs ISL Light Desk to automatically request a session code upon program startup. Obtained session code is then stored in the file code_file.isl. You can specify this file's location with the option --output-file.
 
--output-file
 This option specifies the name and location of the file containing the session code and information of ISL Light session. e.g.:
--output-file C:\tim\ISLLightDesk\session-code.txt
File has the following content:
<session code> <session id> <ISL CP Grid Server ID> <Server ID> <>
 
--username <username>
 This option is used to specify the username that should be used for obtaining a session code.
 
--password <password>
 This option is used to specify the password that should be used for obtaining a session code.
 
--web-login
 This option is used to specify the webtoken that should be used for obtaining a session code.
 
--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 / --connect-uid
 This option is used to specify a computer to connect to remotely (if using version 4.0.2 or lower, --gui-type isl_alwayson_connect will also have to be defined)
 
--notification-thread <thrd_ID> [--notification-message <msg>]
 Users that embed ISL Light Desk in their application (product) should use this option. To specify windows message loop thread that will handle ISL Light Desk notifications and the message send to that thread use option.
In case when no notification message is specified, WM_USER is used. Notification messages are sent from ISL Light with 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.
 
--silent
 When you specify this option, ISL Light will not ask for confirmation when terminating a connection.
 
--open-at-end <URL>
 This option instructs ISL Light Desk to open the specified URL at the end of a session.
 
--log-on-desktop
 Saves log file to desktop instead of application folder.
 
--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 correct value of MTU in their network configuration. Value 0 means normal MTU while value 2 will set smallest value - 100 bytes in one IP packet.
 
--add-title <title>
 Using this option you can add a string to ISL Light's title bar - it will be "ISL Light Desk <title>" (in case of ISL Light Desk) or "ISL Light Client <title>" (in case of ISL Light Client).
 
--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. 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 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. Example:
--conn-options "http_proxy=1.2.3.4&http_proxy_user=myuser&http_proxy_password=
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.
 
--customizations "<options>"
 Use this to pass special connect options such as http proxy address, username, password. Example:
--conn-options "http_proxy=1.2.3.4&http_proxy_user=myuser&http_proxy_password=
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:
_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 remote computer - false/true)
total_control=false (disable/enable total control option - option to disable/enable user to use keyboard and mouse - false/true)
black_screen=false (disable/enable black screen once connected to remote computer - false/true)
leave_background=false (disable/enable remote desktop background when connected - false/true)
stream_high_color=false (disable/enable remote computer to stream in high color - false/true)
minimized_client=false (disable/enable minimising of ISL Light client on remote side once connected to computer - false/true)
User defined stream options can also be disabled here
 
--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)


Was this article helpful?

Cookie Consent

We use cookies to ensure the proper functioning of our website (essential cookies) and, with your consent, for other purposes (functional and other cookies) as outlined in our Cookie Policy and Privacy Policy. You can update your cookie preferences at any time.