Agent Tasks

Using The Gateway Network

Once the Gateway Network is up, and there is at least one Controller and one Agent configured, there are a variety of actions that can be performed on your agents in the form of Agent Tasks.

Agent Tasks involve performing a specific task to one or more specific Agents. The Agent Tasks page contains three tabs:

• Available Tasks which contain tasks waiting to run.
• Running and Scheduled Tasks which include any tasks that are currently running or scheduled to be run.
• Task History, which provides a list of all previously run tasks.

Although there are many different types of tasks to choose from, they are mostly Gateway level actions like taking a Gateway backup or activating a license.

Create an Agent Task

1. To create an Agent task, go to the Controller, and select Network on the Gateway Webpage.

2. Select Enterprise > Agent Tasks. This opens the Agent Tasks window.

   

3. Click Create Agent Task +.

   

   The options for Agent tasks are listed in the following table.

   Task	Description
   Activate License	Activate a license key on selected agent Gateways.
   Collect Backup	Collect a Gateway backup from an agent machine.
   Install Modules	Install one or more modules on selected agent Gateways.
   Remote Agent Upgrade	Prepare a full system upgrade on selected agent Gateways.
   Restart Agent	Restarts the Ignition service on the agent machine.
   Restore Backup	Restore a Gateway backup on selected agent Gateways.
   Send Project	Distributes a project to remote servers. Replaces the project on the remote server as if an export/import was performed.
   Send Project Resources	Distributes project resources, like windows and templates, to remote servers. Note: This is typically performed from a controller Gateway to an agent Gateway, but you can also send project resources from agent Gateway to agent Gateway.
   Send Tags	Distributes controller tags to agents.
   Unactivate License	Unactivate a license key on selected agent Gateways.
   Update License	Update the license on selected agent Gateways.

4. Select task and then click Next. The Task Scheduling form is displayed. Tasks can be scheduled to run in a few different ways depending on your needs. In the example below, the task is set to execute immediately.

   

5. Click Next to finish creating your task with the Agent Selection and Settings forms.

6. Review your settings on the Task Summary form. If you're ready to go, click Create Agent Task. Your task will be submitted according to the schedule type you defined.

   

Agent Task Status

You can utilize the Running & Schedule and History tabs to gain more insight to the Agent Task Status beyond what is shown on the Available tab. Any Agent Tasks that encountered an error will be listed on the History tab with a dropdown that displays the log message.

Retrying Agent Tasks

⚠️ 8.3 Known Issue

When running multiple On-Demand EAM tasks, if at least one task succeeds the user will be unable to retry any failed tasks. The user will need to delete the failed task, create a new task and run that task. For a full list of known issues, click here to learn more.

Should a task fail, you can directly execute the task again without needing to set the task back up by using the Retry option.

1. On the Gateway webpage, navigate to Network > Enterprise > Agent Tasks.

   

2. Expand the three dots menu for the task you want to retry, and select Retry.

   

3. The Gateway will ask for a confirmation. Click Confirm.

The controller will now attempt to run the task again.

Resuming Failed File Transfer Tasks

If a Remote Upgrade task that involves file transfers fails to complete, Ignition will resume the file transfer task when you choose the Retry option. In this situation, Ignition will resume transferring the specified file(s) from the point where the process was interrupted.