> For the complete documentation index, see [llms.txt](https://docs.novacura.com/flow-connect/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.novacura.com/flow-connect/working-with-connect/connect-to-systems/connector-agents/manage-agent.md).

# Manage agent

You can manage the agents from the Agent Manager

## Start/stop agent

1. &#x20;In the **Agent Manager** choose a agent you want start/stop.
2. Select **Stop** if the agent is running but you want to stop the agent.
3. Select **Start** if the agent is stopped but you want to start the agent.

   <figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2F7bUPLQpErbbiFjO8jpEa%2FManage%20agent%201.PNG?alt=media&amp;token=97537575-83d6-4a03-92f0-a995ab8b777e" alt="" width="461"><figcaption></figcaption></figure>

## Export encryption keys

Once you install a agent its important that you export the the encryption keys and store them securely. To export the encryption keys,

1. In the **Agent Manager** select an Agent and select **Details**.
2. Click **Export Keys**.

<figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FCail9BrFfeQn5yUGR9yN%2Fimage.png?alt=media&amp;token=8930ed86-e15f-4292-953f-a47d8e012122" alt=""><figcaption></figcaption></figure>

3. Agent Manager will ask you to set a **password** (at least 12 characters) to encrypt the exported keys. &#x20;
4. Store exported file and password securely.

## Uninstall agent

1. &#x20;In the **Agent Manager** select the agent you want to uninstall and select **Details**.
2. Select **Uninstall**.
3. Generate a new token in the Hub and paste it into the uninstaller. Make sure to select the correct agent group when generating the token. Generated tokens are valid for one week.
4. Select **Uninstall** to confirm.

<figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2Fpa5UffZGMWdS9x4b8ky7%2FManage%20agent%204.PNG?alt=media&amp;token=ee16093e-150f-420b-9824-81199d704a86" alt="" width="462"><figcaption></figcaption></figure>

## Upgrade agent

### Upgrade via Connect Hub

The Flow Connect Hub notifies you when a new version of the Connector Agent is available. A blue dot in the **Agent** menu indicates that an update is available.

1. Select the **Agent Group** containing the Agent(s) with available updates.
2. Click **Update** to update the Agent.

{% hint style="warning" %}
The Connector Agent will be unavailable during installation.

**Tip:** To avoid downtime, configure at least two Connector Agents in the same group and update them one at a time. While one Agent is unavailable, the other Agent can continue processing the workload, ensuring uninterrupted operation.
{% endhint %}

<figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FC6xeyMqzOpU8d3Ac5aYT%2Fimage.png?alt=media&amp;token=dfbee4c8-e568-4b90-86e4-72538567cf8d" alt=""><figcaption></figcaption></figure>

### Upgrade using Agent Manager

1. &#x20;In the **Agent Manager** select the agent you want to upgrade and select **Details**.

   <figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FrliL1qUIdIuN9JmOiJAQ%2Fimage.png?alt=media&amp;token=b8154b49-e85c-4bb3-a9f8-1a6f50d98815" alt="" width="461"><figcaption></figcaption></figure>
2. Select **Upgrade**.

   <figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FhhJJGebaNOrMnniV6etN%2Fimage.png?alt=media&amp;token=d6edbd06-b3d7-4215-b0ad-d0add74b3937" alt="" width="462"><figcaption></figcaption></figure>
3. Generate a new token in the Hub and paste it into the installer. Make sure to select the agent group that the agent belongs to when generating the token.&#x20;
4. Select **Upgrade** to confirm.

{% hint style="warning" %}
If you encounter following error during the upgrade, retry the update operation once again.

<img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FbQ2lUwmJGgV7B9X4lKTf%2Fimage.png?alt=media&amp;token=c0bcc112-c88c-4bce-827b-b53b2434ac4c" alt="" data-size="original">
{% endhint %}

## Access agent logs

1. In the **Agent Manager** select an agent and select **Details**.
2. Select **Open Folder.** This is will open the local file folder where the agent is installed.

   <figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2Fhf7auNAFulA5XWtSil5A%2Fimage.png?alt=media&amp;token=4eff13fc-6fab-4181-99ac-23b5b7cce89a" alt="" width="462"><figcaption></figcaption></figure>
3. In the local installation folder you can find sub folder named logs.

   <figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FAe2WEHUX0ZJFuGkjBhOa%2Fimage.png?alt=media&amp;token=0bb6c175-da22-4c07-808f-9928e7dde9b9" alt="" width="563"><figcaption></figcaption></figure>

## Configure agent logs

By default agent logs are kept for 7 days where a log file is created for each day. You can configure how long the agent logs are kept. *Note that the log configuration is reset every time the agent is upgraded.*

1. In the **Agent Manager** select an agent and select **Details**.
2. **Stop** the agent if its in running state.
3. Select **Open Folder.** This is will open the local file folder where the agent is installed.
4. In the local installation folder find the file named  `appSettings.json` file and open it in you favorite text editor.
5. Modify the parameter *RetainedFileCountLimit.* This number is usually in days. Save the file.

   <figure><img src="https://1716064794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIIgl6sNaTky0iALxYWHH%2Fuploads%2FVx63X1ELEmCqdXmwiQUn%2Fimage.png?alt=media&amp;token=7559fda9-05c3-4dd2-aca0-bea83ef56cfb" alt=""><figcaption></figcaption></figure>
6. **Start** the agent again.

## Configure MaxConcurrentExecutions for a agent

By default, agents are configured to allow up to 50 concurrent sessions. You can override this setting by modifying the `appSettings.json` file. Keep in mind that increasing the **`MaxConcurrentExecutions`** value depends on the hardware capabilities of the machine or server where the agent is installed.

1. In the **Agent Manager** select an agent and select **Details**.
2. **Stop** the agent if its in running state.
3. Select **Open Folder.** This is will open the local file folder where the agent is installed.
4. In the local installation folder find the file named  `appSettings.json` file and open it in you favorite text editor.
5. Modify the <mark style="color:blue;">MachineStepQueueSettings</mark> section to include the **`MaxConcurrentExecutions`** parameter.

```json
"MachineStepQueueSettings": {
    "ConnectionString": "",
    "QueueName": "",
    "MaxConcurrentExecutions": 100
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.novacura.com/flow-connect/working-with-connect/connect-to-systems/connector-agents/manage-agent.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
