Skip to main content
Version: 8.1

Agent Management

Maintaining Your Agents

There are a variety of tools available that allow you to manage certain parts of your agent Gateways that are not scheduled tasks. If your agent goes down, agent recovery makes it easy to get your agent back up and running again as quickly as possible, from backups that were taken from the Controller Gateway. In addition, you can create configuration files that can automatically set up an agent when starting the Gateway instead of having to go through the agent configuration wizard. This makes it easy to set up multiple agents.

Agent Management

Once the agent is set up and connected, the Setup option disappears on the controller, and is replaced with a list of Enterprise Administration menu options.

  1. On the controller, go to the Config section of the Gateway Webpage.

  2. Scroll down to Enterprise Administration > Agent Management. You'll notice that each agent row is expandable with a More button on the right side which displays tasks you can perform: Details, Visit Agent, and Restart Agent.

    • Details: Takes you to an agent details screen.
    • Visit Agent: This is a link that takes you to the Gateway Webpage of that agent.
    • Restart: Creates a Gateway task that immediately restarts the agent Gateway. After clicking the link, you will be asked to confirm that you really want to restart the agent.

If you select the details option, you can view agent details on your Gateway backups, license, installed modules, and projects.

The following are the options in the Agent Details.

View Saved Gateway BackupsOpens a page that allows you to view all Gateway backups and modules that have been archived for this agent. You can schedule a Gateway task to restore a specified Gateway backup from this page by using the Restore Backup link.
View Details about the LicenseOpens a page which compares the agent’s current license to the license key on file at Inductive Automation. This page is handy when you have purchased new software for a license, and you need to verify that your agent’s license key is up to date. You can update the license for this agent by clicking the “Update Agent License” link at the bottom of the screen. This will schedule a Gateway task to immediately update the license on the agent.
Display a List of Installed ModulesOpens a page that displays all modules that are currently installed in the agent Gateway. The module version and the current state of each module is also displayed
View Details about ProjectsOpens a page that displays all projects that currently exist on the agent. The Project Source field is populated by the controller name if the project was deployed to the agent by the controller via a Gateway task.

Agent Groups

Agents can be grouped into groups that you create. This allows you to organize agent lists by location or agent function. Agent groups can also be selected in Gateway tasks. For example, you can create an agent group for a location that collects backups every night at 3AM. Any new agent that is added to the group will automatically be included when the Gateway tasks executes.

  1. To edit and create agent groups, go to the Config section on the Gateway Webpage.

  2. Scroll down to Enterprise Administration > Agent Management, and click Edit agent groups at the bottom of the page.

  3. To assign an agent to a group, check the checkbox on the left side next to the agent name. Then locate the agent groups dropdown on the right side next to the Move selected Agents to link. Select the new group from the dropdown.

  4. Then click the Move selected Agents to link to move the agents, and click Save.

  5. From the Edit Agent Groups page, click on Edit group names to create new groups, edit a group name, and delete a group. If you delete a group that contains agents, the agent will be automatically reassigned to the default group.