Complex Command Line Arguments

 

Each command line option is related to a specific event in ISL Light program. ISL Light supports the following events:

  • load (triggered when ISL Light is loaded into memory and started),
  • join (triggered when ISL Light requests and obtains a session code, i.e. joined a session),
  • connect (triggered when a connection is established between ISL Light and ISL Light Client),
  • disconnect (triggered when a session is finished).


You can connect certain actions with certain events - the syntax of complex command line arguments is:

--on-<event> <action>

 

Action part must be in URL query format and is defined like this:

[destination_module]<name1>=<value1>[&<name2>=<value2...]

 

destination_module can be one of the following (please click on the module name for more information):

  • main (general ISL Light program settings)
  • desktop (commands for the desktop sharing plugin)
  • file_transfer (commands for the file transfer plugin)
  • audio (commands for the audio plugin)
  • video (commands for the video plugin)
  • recording (commands for the recording plugin)
  • customization (customization commands)
  • previews (enable various preview functionalities)

Note: If you omit the destination module, a default value main is used.

 

Main module

disable_dashboard=true
This command will disable the dashboard button () when in a remote session (ISL Light 4.0.4+)
disable_signup=true

This command will disable the signup option on the login screen (ISL Light 4.0.4+)
disable_forgot_password=true
 This command will disable the forgot password option on the login screen (ISL Light 4.0.4+)
disable_grid_selector=true
This command will disable the server selector at the bottom of the login screen (ISL Light 4.0.4+)
headless=(true|false)
Connect to the remote computer in "headless" mode. When this mode is enabled the process is started in background and no user interface is shown to user. This type of connection only supports port forwarding and system information functionality. This mode is automatically enabled when using RDP/SSH tunneling as described here: Remote Desktop Connection (RDP/SSH).

lock=(true|false)
Use this command in combination with --on-disconnect event to lock the unattended computer after you disconnect from it.
Example:
--on-disconnect "main?lock=true"



 

Desktop sharing module

show
When you use this command on connect event, it will start desktop streaming.
view
This command instructs the ISL Light not to ask the user if he wants to view the remote desktop.
control=(grant|grantF12|disable)
When you use this command on connect event, it grants desktop control. The grantF12 parameter is used for granting control in the compatibility (F12) mode. If you omit grant or grantF12 parameter, the default value (grant) is used.
If you specify control=disable, it is not possible to control the remote computer, only view.
topbarpos=(left|top|right|bottom)
This command is used to specify the location of the desktop streaming bar - it can be on the left, top, right or bottom side of the desktop.
Note: Desktop streaming bar can not be at the same location as the Windows task bar (usually it is at the bottom) - if you specify the same location, ISL Light will choose an alternative location. On Windows 95, Windows 98 and Windows Me you cannot set the position of the desktop streaming bar to left or right.
hidetopbar=(true|false)
If set to true, the desktop streaming bar is not shown.
black=(true|false)
This command (when set to true) instructs the ISL Light to enable black screen when desktop is being shared.
disablelocal=(true|false)
If set to true, the local user cannot take control.
leavebackground=(true|false)
If set to true, desktop background is not removed when streaming desktop.
color=64k
Use this option to switch to high quality mode (this means 64k colors, ISSC triple @60%).
monitor=(primary|secondary|N)

Select which monitor should be streamed when session is started.
Example:
--on-connect "desktop?show&monitor=2"
Note: ISL Light does not support the primary and secondary selectors, only a numerical value: 0,1,2,etc.

events=stream_stop_close
Stops the ISL Light session automatically when desktop sharing is closed.
leave_aero=(true|false)
Windows only. By default we disable AERO composition on Windows machines in order to get better performance. Default value: false
 Example:
 --on-connect "desktop?leave_aero=true"
leave_effects=(true|false)
Windows only. By default we disable effects on Windows to increase performance.
 Default value: true
 Example:
 --on-connect "desktop?leave_effects=true"
leave_font_smoothing=(true|false)
Windows only. By default we enable font smoothing to increase performance.
 Default value: true
 Example:
 --on-connect "desktop?leave_font_smoothing=true"
norestart=(all|true)

Disable Restart and Resume functionality in ISL Light or AlwaysOn session. If you enter the all parameter, then Restart and Resume functionality is disabled and you will not be able to enable it during the session. If you enter the parameter true then Restart and Resume functionality is disabled, however you can make a request during session to enable it. 

Example:
--on-connect "desktop?norestart=all"

 

File transfer module

location=<path_on_local_computer>
Use this command to change the location where the transferred files should be saved.
transfer=[<file_name1>[;<file_name2>...]]
When you use this command on connect event, the file transfer plugin will start transferring the specified file(s) - separate multiple filenames with semicolons.

 

Audio module

stream
When you use this command on connect event, it will start streaming the local audio recording.

 

Video module

stream
When you use this command on connect event, it will start streaming the local video recording.

 

Recording module

record[=silent,true]
When you use this command on connect event, it will load the recording plugin, start it and ask the remote user if he or she allows recording.
If silent or true is specified, the session will be recorded without user consent.
If silent is specified, the user will not be offered to view the recorded session after the session has finished.
Recording starts even if silent or true are not defined.
location=<path_on_local_computer>
Specify the default location where the recording files will be saved. Environment variables can also be used. Please use the following syntax for environment variables - for variable name variable_name use $[variable_name]
Example for default path with computer name used in the path:
location=x:\\recordings\\$[COMPUTERNAME]
allow_stop=false
This option will disable the user's ability to stop session recording.
name=$[HOST]-$[TIME]
You can define the file name for the recording. The default is set to Host and Time. This can be changed around depending on what criteria you wish to include in the file name. You can use any of the parameters listed below.
Parameters:
$[ISLUSER]
$[GRID]
$[SESSION]
$[CODE]
$[REMOTE_HOST]
These parameters can be used within the recording commands.
  • $[ISLUSER] - contains the username of the operator from the recorded session. (Available in ISL Light 4.0.3+)
  • $[GRID] - contains the ID of grid (Available in ISL Light 4.0.3+)
  • $[SESSION] - contains the session id of the recorded session. (Available in ISL Light 4.0.3+)
  • $[CODE] - contains the session code of the recorded session. (Available in ISL Light 4.0.3+)
  • $[REMOTE_HOST] - contains the name of the remote computer. (Available in ISL Light 4.0.3+)

 


Customization module

disable_sessions=(true|false)
Allows you to disable Sessions tab in ISL Light application. If this option is enabled users are only able to connect to ISL AlwaysOn computers. They are NOT able to generate a session code for remote support. (Available in ISL Light 4.3.0+)

Example:
ISL_Light.exe --on-load "customization?disable_sessions=true"

disable_computers=(true|false)
Allows you to disable Computers tab in ISL Light application. If this option is enabled users are NOT able to connect to ISL AlwaysOn computers. They are only able to generate a session code for remote support. (Available in ISL Light 4.3.0+)

Example:
ISL_Light.exe --on-load "customization?disable_computers=true"

Note: To display an empty dashboard you need to disable both Sessions and Computers tab. In this case you can apply the following customization:
ISL_Light.exe --on-load "customization?disable_computers=true&disable_sessions=true"

disable_invite_operator=(true|false)
Allows you to hide the Invite Operator menu while you are in session. (Available in ISL Light 4.3.0+)
Example: 
ISL_Light.exe --on-load "customization?disable_invite_operator=true"
disable_copy_session_invite_link_to_clipboard=(true|false)
Allows you to disable Copy URL option when clicking on a generated session code in ISL Light.
Example:
ISL_Light.exe --on-load "customization?disable_copy_session_invite_link_to_clipboard=true"

disable_remember_me_in_login=(true|false)
Allows you to disable the Remember me checkbox when logging into ISL Light.
disable_join=(true|false)

Allows you to remove the "Join a Session" option in the Dashboard.

disable_session_edit_dialog=(true|false)
Remove the session Edit dialog option from ISL Light Sessions tab, where user can edit the Session Name, Client's Email and Notes about the session.
Example:
ISL_Light.exe --on-load "customization?disable_session_edit_dialog=true"

disable_session_invitations_via_email=(true|false)
Disable the Invite option, to invite a client into a session via email from ISL Light.
Example:
ISL_Light.exe --on-load "customization?disable_session_invitations_via_email=true"

disable_session_transfer=(true|false)
Disable the Transfer Session option in ISL Light.
Example:
ISL_Light.exe --on-load "customization?disable_session_transfer=true"

disable_save_computer_access_password=(true|false)
Disable the prompt allowing the user to save the access password for the unattended computer.
Example:
ISL_Light.exe --on-load "customization?disable_save_computer_access_password=true"

use_support_session_flow=(true|false)
Disable the Session flow windows which displays the session code and additional possibilities to invite the client into the session.
Example:
ISL_Light.exe --on-load "customization?use_support_session_flow=false"

disable_reboot_options=(true|false)

Hide the options available in the Administrative Mode during session (e.g. Reboot, Reboot into Safe Mode...)
Example:
ISL_Light.exe --on-load "customization?disable_reboot_options=true"

show_chat_in_readonly_mode=(true|false)
Set the chat to read-only mode. The supporter will still still see all the event notifications and messages from the client but will be unable to enter and send any text via the chat dialog.
Example:
ISL_Light.exe --on-load "customization?show_chat_in_readonly_mode=true"

disable_set_unattended_access=(true|false)
Disable "Set Unattended Access" feature. This will remove "Set Unattended Access" menu entry from the Session toolbar -> Tools menu.
Example:
ISL_Light.exe --on-load "customization?disable_set_unattended_access=true"
disable_port_forward=(true|false)
Disable Remote Desktop Tunneling plugin. This will also remove "Connect via..." menu entry from the "Session toolbar -> Monitor" menu.
Example:
ISL_Light.exe --on-load "customization?disable_port_forward=true"

 

Previews module

unsupported_preview_enable_auth_2fa=(true|false)
Allows you to enable support for two-factor authentication (2FA) login. (Available in ISL Light 4.3.0+)

Example:
ISL_Light.exe --on-load "previews?unsupported_preview_enable_auth_2fa=true"

Was this article helpful?