# Agent configuration

## Activation (license assignment)

{% stepper %}
{% step %}
Login to your **Xopero ONE Management Service** (**XMS**) console.
{% endstep %}

{% step %}
Click the **Activate agent** icon in the top menu.
{% endstep %}

{% step %}
A sidebar will appear, showing a list of available agents — you can view basic details like device type, name, IP address, and operating system.

<figure><img src="/files/fPXw6V3NlFGGuHJwkrfk" alt="Agent activation"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Select the device you want to activate (you can select multiple devices if you assign them the same license type) and press the **Activate** button to proceed.
{% endstep %}

{% step %}
Next, select the license type you want to assign to the chosen device(s) and click **Assign license** to confirm your selection.
{% endstep %}

{% step %}
Once the license is correctly assigned, your device(s) will be visible in the **Devices** tab.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
In the **Xopero ONE** system, the local worker, cloud worker, and feature worker licenses are <mark style="color:$success;">**free**</mark>. These licenses allow specific operations, except for backing up the device itself — thus, devices with these licenses appear under **Settings** > **Advanced** > **Workers** tab.
{% endhint %}

***

## Configuration

{% hint style="danger" %}
To modify the `config.json` file, <mark style="color:red;">**you must stop**</mark> the **Xopero ONE Backup\&Recovery Agent** service. After making your changes, restart the service (you might also need to refresh the changes in the **Management Service** panel).
{% endhint %}

The `config.json` file, by default, is located in the following locations:

1. For **Windows**: `C:\Program Files\Xopero ONE Backup&Recovery Agent`
2. For **Linux**: `/opt/XoperoONEBackupAgent/`

💡You can edit `config.json` with a simple text editor (i.e., **Notepad++**).

### <mark style="background-color:blue;">Management Service address</mark> <a href="#management_service_address" id="management_service_address"></a>

The **Xopero ONE** **Management Service** (**XMS**) address to which your agent connects is crucial during both installation and configuration. If the IP address or protocol (http/https) of the **Management Service** changes, the agent's status will switch to offline. To re-establish the connection, update the `ServiceUrl` value in the configuration file with the updated address.

<figure><img src="/files/MSWfdmvzGA0cn5buvbcR" alt="notepad  json configuration1"><figcaption></figcaption></figure>

***

### <mark style="background-color:blue;">Log level</mark> <a href="#log_level" id="log_level"></a>

By default, the `LogLevel` value is set to `Information`. You can change it to:&#x20;

1. `Trace`
2. `Debug`
3. `Information`
4. `Warning`
5. `Error`
6. `Critical`
7. `None`

<figure><img src="/files/HH2ZY8JHC2cQHzClETds" alt="notepad  json configuration2"><figcaption></figcaption></figure>

***

### <mark style="background-color:blue;">Default log path</mark> <a href="#default_log_path" id="default_log_path"></a>

By default, application logs are stored in the following directory: `C:\ProgramData\Xopero ONE\Xopero ONE Backup&Recovery Agent\Logs`. To change the location, modify the `AppDataFolder` parameter.

{% hint style="warning" %}
Please note that the correct `AppDataFolder` value format includes <mark style="color:red;">**double slash**</mark> after the drive letter (i.e., `D:\\`).
{% endhint %}

<figure><img src="/files/NzM3Wiy9psAjeR9tfK2j" alt="notepad  json configuration3"><figcaption></figcaption></figure>

***

### <mark style="background-color:blue;">Device name</mark> <a href="#device_name" id="device_name"></a>

The device name defaults to the system's name. To customize it, modify the `OverriddenHostName` parameter.

{% hint style="warning" %}
Please note that the custom name must be in entered with quotation marks (i.e., `"TESTNAME"`).
{% endhint %}

<figure><img src="/files/f1kHYYPMD2efNMgfvDxM" alt="notepad  json configuration4"><figcaption></figcaption></figure>

***

### <mark style="background-color:blue;">Number of retries</mark>

If database backup task ends with error **DV0249 - "Unable to read backup data"**, first address any connection stability issues on your end. If the problem persists, you can increase the retry attempts in the **Xopero ONE** application— to do this, simply edit the `MaxRetriesCount` parameter, changing its default value from **2** to a higher value, i.e., **20**.

<figure><img src="/files/9WmbevjhMpDpvDm600JQ" alt="MaxRetriesCount config json"><figcaption></figcaption></figure>

***

### <mark style="background-color:blue;">Virtual appliance</mark> <a href="#virtual_appliance" id="virtual_appliance"></a>

The **VMware** virtual appliance is a **Linux**-based machine with an agent service. You can modify its settings by editing the `config.json` file.

To configure the timeout for snapshot creation, locate the **VMware** section at the bottom of the file and adjust the `SnapshotCreationTimeout` parameter to your needs.

<figure><img src="/files/UNPTjRILKxv857BuuZ19" alt="notepad  json configuration5"><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://helpcenter.xopero.com/xopero-one-en/deployment-and-configuration/xopero-one-agent/agent-configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
