Support Knowledgebase
NAV

Remote Access Installer Preconfiguration

Please Note Version 5 and above of SimpleHelp now supports Mass Deployment which will in many cases be a more appropriate route for mass installation of Remote Access Services and preconfigured installers. Read more about Mass Deployment.

There are two ways to preconfigure Remote Access services settings to simplify installation by skipping manual setup:

  1. Preconfiguration of the installer itself so that its settings apply when the installer is run. This lets a machine's user just run the installer as they would any privileged application.
  2. Passing parameters to an installer by elevated command line. This is helpful for making installations completely silent, deploying via an existing RMM application or by script with variable arguments.

Installing a Remote Access service always requires elevated privileges.

Downloading a Preconfigured Installer

All installers are created by a download from your site. The URL used to download the installer can include several preconfiguration arguments. This means you can send download URLs to remote machines' users to run themselves in an email, pull preconfigured installers by script using curl for example. and so on.

For a friendly UI where you can save and manage several preconfiguration profiles that use this mechanism; in the Technician Console's Access tab find the Preconfigured Machines utility to set up an installer (see this section of the Technician guide).

When editing the parameters to be passed in the download URL directly, they should be of the form:

http://your server/access?name=value&name=value&name=value ...

The parameter names and values you can use are:

  • name - the machine name to use. If omitted the service with autodetect the remote machine name.
  • group - the group to place the machine in. A hierarchy of groups is delimited with a forward slash character (/), such as "USA/Texas/Dallas".
  • password - the machine password to set.
  • servers - a comma-separated list of server URLs to use. If omitted the service will automatically register with the server from where it was downloaded.
  • monitor - choose whether to allow monitoring. Values of 'yes' will enable monitoring, and 'no' will disable it.
  • script - choose whether to allow scripting. Values of 'yes' will enable scripting, and 'no' will disable it.
  • confirm - choose whether incoming sessions must request approval. Values of 'yes' will force approval, and 'no' will not require approval.
  • proxy - the proxy settings to use, in the form username:password@server:port. If no credentials are required then server:port can be used.
  • silent - choose whether the Remote Access Service should install without showing the Remote Access configuration UI. Set to 'yes' to enable. This does not skip the server verification prompt that a user must interact with for the installation to start. For a completely silent unattended installation with no user interaction required, see the command line installation method below.
  • shortcuts - choose whether the Remote Access Service should install shortcuts. Set to 'no' to prevent shortcuts being created.

Command Line Installation

To silently install the service use the /S switch which will have the service install and start silently. Note: On SimpleHelp version 5.5.12 you must also pass /ForceVerification to skip the server verification dialog. On 5.5.13 and later this is not required.

The following parameters can be passed to a Remote Access Service installer:

  • NAME - the name that this Remote Access Service should use. This name will be shown to technicians in the Access tab when the machine registers. If the value AUTODETECT is used then the service will create a suitable name based on the hostname and architecture of the remote machine. The name is set the first time the service is run, and will not subsequently be updated should the hostname or architecture change. You can place a machine in a group by specifying the group in the machine name, for example:
Group One/Group Two/Machine
  • HOST - the SimpleHelp Server hostname that the Remote Access service should use to connect. Remember to prefix the hostname with either udp://, http:// or https://. Use only one address per SimpleHelp instance: Multiple addresses and protocols pointing to the same SimpleHelp server will just cause the service to use the most restricted and least performant option. Different protocols can however be used to register with different SimpleHelp servers.
  • PASSWORD - the password for this Remote Access Service
  • PROXYHOST - the proxy hostname to be used for HTTP connections
  • PROXYPORT - the proxy port to be used for HTTP connections
  • PROXYUSERNAME - a proxy username if the proxy requires authentication
  • PROXYPASSWORD - the corresponding proxy user’s password
  • CONFIRM - set the value to yes to require new sessions to be accepted by the end user
  • CONFIRM_TIMEOUT - set the timeout duration in milliseconds. A value of 0 is no timeout.
  • NOSHORTCUTS - prevent the remote access client from setting up menu shortcuts

For example for an installation on 64-bit Windows:

Remote Access-win64-online.exe /S "/NAME=My Computer" /HOST=http://simplehelp.example.com

Microsoft Windows GPO installation

Although our installer does not currently include an MSI for mass deployment via group policy on Microsoft Windows systems however using the above information it is possible to share the Remote Access Service installer on a shared volume (network drive or similar) and then schedule a batch file to run via GPO or any other mechanism which will silently launch the Remote Access Service installer and then configure it. This allows you to orchestrate Remote Access Service installations on large Microsoft Windows deployments. Similar steps can be used to orchestrate installation on other platforms.

Machine name macros

You can use the following macros as part of the machine name. These macros will be picked up and the machine information will be substituted in when the service starts:

  • ${OSName} - the operating system name
  • ${OSArchitecture} - the operating system architecture
  • ${ProcessorCount} - the number of processors / cores available
  • ${Hostname} - the hostname of the machine
  • ${IP} - the IP address of the machine

MacOS .dmg pathing

On macOS, the Remote Access installer comes as a .dmg disk image. To pass command line arguments to it, mount the image first, then run the installer's binary directly from the mounted volume. Double-clicking the app won't pass any arguments.

Step 1: Mount the .dmg. Double-click the .dmg in Finder, or mount it from Terminal:

hdiutil attach ~/Downloads/<installer-name>.dmg -nobrowse

The image mounts at /Volumes/Access.

Step 2: Run the installer binary with your arguments:

/Volumes/Access/Remote\ Access.app/Contents/MacOS/osxwrapper [ARGUMENTS]

Note: On macOS 27 and later, hdiutil shows a deprecation warning but still works. The newer equivalent is:

diskutil image attach --mountOptions nobrowse <dmg>