Create an agent group so that a connection keeps running when one of your on-premise agents goes offline. This article shows you how to create a group from agents you've already installed, use the group in a connection, change the group's agents or their order, and delete a group. For how failover works and what to consider before you start, see On-premise agent overview.
Before you begin
- Make sure your account includes agent groups. See Requirements and limits.
- Sign in as an account owner, an administrator, or a user with Manage all access.
- Install at least two on-premise agents, on version 6.0 or later, on separate machines in the environment where you'll create the group, and confirm that each agent is online. Version 6.0 is available for Windows only. See Install and configure the Windows on-premise agent or Install and configure the Linux on-premise agent.
Create an agent group
- Go to Resources, and then select On-premise agents.
- Select Create, and then select Agent group.
- Enter a Group name.
- Optional: Enter a Description.
- Select Add agents, and then select two or three agents. The list shows the agents in your current environment, including agents that already belong to another group.
- Put the agents in failover order. The first agent handles the group's work while it's available. To move an agent, drag its handle (⋮⋮).
- Select Save & close.
The group appears under Agent groups on the agents list.
If integrator.io won't save the group, see On-premise agents: Troubleshooting and FAQs.
Use an agent group in a connection
You can use an agent group in a new connection or switch an existing connection from a single agent to a group. Flows that use the connection don't need any changes.
- Go to Resources, and then select Connections.
- Open the connection you want to change, or create a connection.
- For Mode, select On-premise.
- For Agent, select your group under Agent groups.
- Select Test connection. The test succeeds when at least one agent in the group is available.
- Select Save & close.
The connection now uses the group. New flow runs go to the first available agent in the group.
If you're switching several connections, switch and test them one at a time.
Edit an agent group
Edit a group to add or remove agents or to change their order. New work follows the updated order. A group must keep two or three agents. See Requirements and limits.
- Go to Resources, and then select On-premise agents.
- Under Agent groups, select the group's name. The Agent group drawer opens.
- Select Edit.
- Change the agents or their order:
- To add an agent, select Add agents, and then select the agent.
- To remove an agent, select Actions next to the agent, and then select Remove agent.
- To change the order, drag an agent's handle (⋮⋮).
- Select Save & close.
Delete an agent group
Deleting a group doesn't delete its agents. You can't delete a group while another resource, such as a connection, export, flow, or integration, references it. To see which resources use a group, select Actions on the group, and then select Used by. Edit each of those resources to remove the reference before you delete the group.
- Go to Resources, and then select On-premise agents.
- Under Agent groups, select Actions on the group, and then select Delete group.
- In the Confirm delete dialog, select Delete.
Deleted agent groups go to the recycle bin, where you can restore them.
If integrator.io won't delete the group, see On-premise agents: Troubleshooting and FAQs.