Command Line Arguments

 

Introduction

ISL AlwaysOn is controlled through command line parameters. When installing ISL AlwaysOn through product pages, the same parameters are used as a whole command line in the CGI parameter cmdline.

Important: These command line arguments are discarded when passed to push upgrade of ISL AlwaysOn from ISL Conference Proxy, so you cannot use them when doing a push upgrade. They are also not used when ISL AlwaysOn management dialog or setup is started from a non-admin or non-system account. In order to allow the ISL AlwaysOn management dialog (and use command line arguments) under system account please add the command line option ignore_system_account.

An example of a valid URL is the "Add this computer" button on the remote access tab after you login to your ISL Online account.

If you right-click on that button (marked with red in the screenshot below) and copy the link, then paste it into a text editor, you will be able to inspect it and use it as a starting point for constructing a custom link for the desired customized installer.

That link looks like this:

https://islv61-alwayson.islonline.net/start/ISLAlwaysOn?cmdline=grant+%22GRANTBLOB%22&custom=uc-USERCODE

Where:

  • GRANTBLOB is your unique grant blob - this is the part of the link that tells the program which user to add this computer to. Wherever you see a reference to a blob or grant blob in examples below, replace it with the appropriate value for your case.
  • USERCODE is a customization identifier, basically it tells the program to check if there are any default customizations set for your user and use it.

We can now proceed to the list of available parameters and their syntax.


Syntax

[/SILENT] [/VERYSILENT] [grant|grant_silent <grant blob>] [password <default password>] [description <computer description>] [push_upgrade (true|false)] [record <path to recordings>] [shutdown|shutdown_silent] [grant_password <connection_password>] [ignore_system_account] [skip_check_start] [record <path>] [grant_password <path>] [share <path>] [shutdown|shutdown_silent]

Command line option /SILENT instructs the installer not to display the wizard and the background window. If you use /VERYSILENT, the installation progress window will not be displayed either. The setup will not be started when ISL AlwaysOn is already installed on that computer.

Adding option push_upgrade will enable or disable automatic software updates initiated from the ISL Conference Proxy server - this options is useful for corporate environments where administrator wants to update multiple computers at the same time.

Option record is used to set the session recordings folder. When an ISL Light session is started and session recording folder is set, the session will be recorded to the specified folder.

Option share is used to add a shared folder - during installation, a dialog for adding a new file share will pop up, with the provided location already entered, allowing you to set the authentication and access parameters, then confirm it by clicking OK.

Example: share "C:\myshare"

Link that is used by the default ISL AlwaysOn web page used command line option grant that is followed by grant blob. If silent install is needed (no user confirmation), grant_silent can be used instead.

Option password will set access password if the password hasn't already been set.

Command line option description is followed by the description text that will be shown in the ISL AlwaysOn page. Description text can also specify environment variables that are available to ISL AlwaysOn process and some additional variables:

  • diskid (disk serial ID)
  • mac (MAC addresses of network cards that are present on system delimited with '_'. Single MAC address has the following syntax xx::xx::..., where xx is a hexadecial number in lowercase)
  • nifs (all (but localhost) IPs that are present on system, delimited with ',')
  • cpuid ... (processor cpuid - normally 0)
  • name (computer name as it would be seen in ISL AlwaysOn web page without "description" command line option)

Environment and additional variables must be prefixed with $[ and must end with ]. An example of a valid description text:

"$[name] - $[nifs]"

Option shutdown stops all ISL AlwaysOn services on local computer. If no user confirmation is needed, use shutdown_silent.

Option grant_password defines a new granted connection password. This option is used together with the option grant_silent.

Option skip_check_start will always upgrade the ISL AlwaysOn program first and then perform actions that are specified with parameters.


Steps for preparing a custom executable

These are general steps that need to be done:

  1. Get the default link for granting access to your user as described in the introduction section above, this will be your starting point.
  2. Make a list of the desired command line arguments that you wish to use (check the syntax section).
  3. URL-encode your command line arguments from the previous step. You can use any URL-encoding page, but we also have a page for this purpose: Link for URL encoding
  4. Insert the command line arguments to the appropriate position and replace grant with grant_silent if needed.


Example

The following example will show you how to create a silent installer which could be used for deployment:

  1. Following the instructions we have obtained a link that looks like this:
  2. https://islv61-alwayson.islonline.net/start/ISLAlwaysOn?cmdline=grant+%22GRANTBLOB%22&custom=uc-USERCODE
  3. Let us say we want to use the following command line parameters: /VERYSILENT password "topsecret" description "test $[name] - $[nifs] - $[mac]"
  4. We encode them  using our URL encoder and get the following result: %2FVERYSILENT+password+%22topsecret%22+description+%22test+%24%5Bname%5D+-+%24%5Bnifs%5D+-+%24%5Bmac%5D%22
  5. Now we need to add these encoded arguments to our link. The easiest  way to do it is to insert them at the beginning of the cmdline part and add a trailing + (encoded space), so we get this: https://islv61-alwayson.islonline.net/start/ISLAlwaysOn?cmdline=%2FVERYSILENT+password+%22topsecret%22+description+%22test+%24%5Bname%5D+-+%24%5Bnifs%5D+-+%24%5Bmac%5D%22+grant+%22GRANTBLOB%22&custom=uc-USERCODE
  6. Since we want to make a completely silent installer for deployment purposes, we will replace grant with grant_silent., this is the end result: https://islv61-alwayson.islonline.net/start/ISLAlwaysOn?cmdline=%2FVERYSILENT+password+%22topsecret%22+description+%22test+%24%5Bname%5D+-+%24%5Bnifs%5D+-+%24%5Bmac%5D%22+grant_silent+%22GRANTBLOB%22&custom=uc-USERCODE


Connect to computer using command line arguments

It is possible to connect to remote computer with specific options to be passed to ISL Light 4.0.4+.

Please see the command line argument page in the ISL Light manual for more information on what can be used with ISL Light.

The command to be used for connecting to an unattended remote computer is --stream-options. Below table shows the parameters that can be passed.

--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
Tags: isl alwayson, customization, command line arguments, url, syntax, custom executable

Was this article helpful?