Skip to main content
Version: 7.9

Adding an Agent

Inductive University

Adding an Agent

Watch the video

Agent Setup

To communicate with the controller, agents send data across a Gateway Network connection. If your Gateway Network setup requires that connections be manually approved in advance on the controller Gateway, you will need to set up the Gateway Network connection before starting the EAM Setup Wizard. You will be able to select the existing Gateway Network connection within the wizard. Navigate to Configure > Enterprise Administration > Setup to begin the EAM Setup Wizard.

Step 1: Select Controller or Agent

Since you are installing an agent, select 'Agent' on this screen. Click the Next button.

" "

Step 2: Agent Installation Mode

Select New Agent or Agent Recovery. Select 'New Agent' if you are setting up a machine that is unknown to the controller. Select 'Agent Recovery' if you are reinstalling an existing agent (possibly on a different machine), and the machine has been known to the controller in the past. This option also gives an opportunity to perform a system recovery (restore Gateway backup, reinstall missing modules and license) if possible. After you made your selection, click the Next button.

" "

Step 3: Gateway Network Setup

As mentioned previously, a Gateway Network connection is required to communicate with a controller. On this page, you can either select an existing connection from the dropdown list, or click Create New Connection to create a new Gateway Network connection. If you are using an existing connection, enter the System Name that identifies your Agent to the controller.

If you create a new network connection, enter the Host network address and Port for the remote machine. You can even test the settings you selected by clicking on the Test Connection button. Note, that you cannot create a new SSL connection on this page. When using SSL, you must create the Gateway Network connection before entering the EAM Setup Wizard.

Click Finish.

" "

Agent Post Setup

The EAM module will now attempt to register the local Gateway as an EAM agent on the controller, and download files if performing a system recovery.

  • If you are running in New Agent mode, you will see the agent status check on the screen. When the agent status check is complete, you will need to navigate to the controller Gateway and approve the agent on the Gateway Agents page, as discussed in the section below. Click the Retry button to recheck agent status on the controller if the first status check failed. " "

  • If you are running in Agent Recovery mode, and you selected the System Recovery option, you will see the download status of the license file, installed modules, and the most recently collected Gateway backup file. Depending on the contents of your archive, some files may not be available. Click the Apply Files button to apply downloaded files. Note that this operation will require a Gateway restart if a Gateway backup file needs to be applied. Click the Ignore Files button to close this page and not apply downloaded files. Note that the agent settings have already been saved, so it is safe to not apply downloaded files if you choose. Click the Retry button to attempt to download the recovery files again.

Setup a Regularly Scheduled Collect Backup Task for Agents

After you set up your agents, it is very strongly recommended that you set up a regularly scheduled Collect Backup task for your agents. System recovery through the EAM Setup Wizard will not work if there are no archived backup files! To learn more about performing agent backups, refer to Agent Task - Backup and Restore.

Agent Approval

When an unknown agent first contacts the controller, it is saved in pending status. No interaction with the controller is allowed until you approve the agent. Agent version and license information fields will remain empty until the agent is approved. To approve the agent, go to your controller on the Configure section of the Gateway webpage, scroll down to Enterprise Administration > Agent Management, and click on the 'approve' button on the right side next to the name of your agent. After a few moments, the agent’s status should change to “Connected." To remove an agent, click the 'delete' button on the right side. If the agent machine is still active, the agent will reappear on the list in pending status, but will no longer be able to interact with the controller. To remove the agent permanently, you must navigate to the agent Gateway and uninstall the agent via the Agent Settings page.

" "

Modifying Agent Settings

You can modify Agent Settings by going to the agent, and under the Configure section on the Gateway webpage, select Enterprise Administration > Agent Settings. Here you can change the Gateway Network Server name and the Send Stats Interval.

  • Gateway Network Server is the Gateway Network Server running the EAM controller. You can select your controller machine from this dropdown list.
  • Send Stats Interval is the interval in seconds that the agent will send its statistics to the controller Gateway.
  • After you make your changes, click Save. " "
  • Perform System Recovery - this checkbox is only shown when running in Agent Recovery mode.
  • After you make your selections, click the Finish button. The Gateway will attempt to download the most recent Gateway backup, previously installed modules, and the license file.

Agent Management

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

" "

On the controller, go to the Configure section of the Gateway webpage, 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.

" "

  • If you select details, you can view agent details on your Gateway backups, license, installed modules, and projects. " "
  • View Saved Gateway Backups: opens 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 License Detail: opens 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.
  • Installed Modules: opens 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
  • Details about Projects: opens 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.
  • 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.

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.

To edit and create agent groups, go to the Configure section on the Gateway webpage, scroll down to Enterprise Administration > Agent Management, and click the 'Edit agent groups' link at the bottom of the page. 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. Then click the “Move selected Agents to” link to move the agents, and click Save.

" "

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.

" "