Manage agent

You can manage the agents from the Agent Manager

Start/stop agent

1. 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.

   

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. Select Export Keys.

3. Store exported file securely.

   

Uninstall agent

1. 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.

Upgrade agent

1. In the Agent Manager select the agent you want to upgrade and select Details.

   
2. Select Upgrade.

   
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.

4. Select Upgrade to confirm.

If you encounter following error during the upgrade, retry the update operation once again.

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.

   
3. In the local installation folder you can find sub folder named logs.

   

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.

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.

   
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 MachineStepQueueSettings section to include the MaxConcurrentExecutions parameter.

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