Configuration Options

Overview

This page describes the key files that secure a configuration and the configuration files that control which options and functions are available. It also explains how to manage them.

The page is split into several sections:

Master Keys

A configuration has two key files these are created and saved by the configuration assistant:

⚠️ The root key (root CA) is not recoverable. If it is lost you will need to create a new configuration and re-enrol every device, so store it safely and keep a backup.

At present both keys can only be saved as files.

Control Configuration

The control.ini holds the control's settings, the operator profiles and the operators.

⚠️ The sections of control.ini are signed to ensure that no unauthorised changes can be made - only the Name values are not. After editing the file it must be re-signed - see Sign Files.

Name

Control Settings

Stored in the [Customer] section.

The section also holds values Remote Tools sets when the configuration is created - its version, ID, connection timers, gateway, relay and download addresses, key storage and signature. Do not edit them; changing them can stop the control from connecting.

Operator Profiles

A profile is a set of permissions that control the functionality that is available locally at the control and remotely when connected to an agent. Each operator is assigned a profile.

Each profile is saved in the control.ini as a section with its name and .profile - for example [Profile_1.profile].

The tables below show the editable settings, grouped by function.

Control Settings

Applied at the control when the operator signs in.

📌 An operator needs at least one of Direct Connections or Relay Connections, or they will not be able to reach any agent.

Agent Information

File Manager

Port Forwards

Terminal

Tasks

Batch Tasks

Log Viewer

Remote Desktop

Privilege Elevation

Each profile section also holds its version and signature, set by Remote Tools - do not edit them.

Operators

An operator is someone who signs in to the control. Each operator is assigned a profile, which sets their permissions.

Each operator is saved in control.ini as a section with their name and .user - for example [admin.user].

Operators can't be edited by hand - use Operator Management to add, remove or change them.

📌 The operator password is separate from the configuration password. The configuration password unlocks the configuration; the operator name and password identify who is using it.

Agent Configuration

agent.ini holds the agent's settings, these control the connections and functionality it allows.

⚠️ agent.ini settings take precedence over operator profiles. For example, switching on Must be logged in here means functions can only be opened when a user is logged in at the device, whatever the operator's profile says.

Name

The name of the agent configuration, at the top of the file.

The [Policy] section holds the agent's settings, the editable items are listed below.

The section also holds other internal values - its version, keep-alive timer, gateway address and timing, and signature. Do not edit them; changing them can stop the agent from connecting.

⚠️ This section is signed to ensure that no unauthorised changes can be made.
After editing the file it must be re-signed - see Sign Files.

Connectivity

Behaviour

Worker Mode

The user account used when opening functions or running tasks.

Agent Functions

unique.ini

unique.ini is an optional file that adds custom details to one agent. Unlike agent.ini it applies only to the agent it is placed on, and it is not signed, so it can be changed without the KEK. The file has two parts:

Example

ShortName = Office Server 2
[User_Defined]
Site = London
Role = Web Server

User Defined values

ProfessionalThe key/value pairs are added to the information the agent tells the control about itself, and are used in the following places:

• Shown in the User Defined section of Agent Info
• Offered as filters for global tasks, so a task can be targeted to devices matching the custom details - see Tasks
• Offered as filters when choosing the targets of a batch - see Batch Tasks

The User Defined section is limited to 150 bytes:

• Names and values may only contain letters, numbers, spaces, underscores, dots and hyphens
• The User Defined section must be small - a handful of short entries.
• An error when reading the entry will cause an error to be displayed in the agent information table or for the shortname for it not to display

The unique.ini should be placed in the same folder as the agent.ini file:

When installing the agent, if unique.ini is in the same folder as the installer, it is copied into place automatically.

unique.ini is read when the agent starts, so restart the agent after adding or editing the file.

Multiple Configurations

When enrolling an agent or an additional control, you choose which configuration file is deployed to it. You can create several versions of each configuration file, each with different settings.

The files are kept in the configuration folder - open it with Open on the Configuration tab of Settings:

Configuration names

Each file has a configuration name at the top - AgentConfigurationName or ControlConfigurationName. These names are the choices offered in the enrolment dialog, so each one must be unique. If two files share a name, only one of them is offered.

To add a configuration file, copy an existing one, give it a new file name and configuration name, edit it as required and Re-sign it.

An existing agent can be switched to a different configuration with the Update Configuration function.

⚠️ Test every new or edited configuration file before deploying it - a mistake can stop the devices working.