Skip to main content
Version: 8.1

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.

There are many different types of tasks to choose from, but they mostly involve doing Gateway level actions such as taking a Gateway backup or activating a license.

Create an Agent Task

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

  2. Scroll down to Enterprise Administration > Agent Tasks. This opens the Agent Tasks window.

  3. Click the Create new Gateway Task link to create an agent task.

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

    TaskDescription
    Activate LicenseActivate a license key on selected agent Gateways.
    Collect BackupCollect a Gateway backup from an agent machine.
    Install ModulesInstall one or more modules on selected agent Gateways.
    Remote Agent UpgradePrepare a full system upgrade on selected agent Gateways.
    Restart AgentRestarts the Ignition service on the agent machine.
    Restore BackupRestore a Gateway backup on selected agent Gateways.
    Send ProjectDistributes a project to remote servers. Replaces the project on the remote server as if an export/import was performed.
    Send Project ResourcesDistributes project resources, like windows and templates, to remote servers.
    Send TagsDistributes controller tags to agents.
    Unactivate LicenseUnactivate a license key on selected agent Gateways.
    Update LicenseUpdate the license on selected agent Gateways.
  4. Select task and then click Next. The Task scheduling screen is displayed. Tasks can then be scheduled to run in a few different ways depending on your needs. In the example below, the task is set to execute twice per day.

    Changed in 8.1.17
    Cron Expressions starting with the "/", "-", or "," characters are no longer considered valid.

  5. Click Next. The EAM wizard will guide you through setting up your task.

  6. Lastly, a Task Summary window appears. If you're ready to go, click Finish. Your task will be submitted according to the schedule type you defined.

Agent Task Status

On the Status section of the Gateway Webpage there is a page called EAM Tasks. This page is useful, as it shows information on what tasks are currently running, which tasks are scheduled to run, and a history of tasks that have been run. The EAM Tasks page can be used to allow users to see what is going on with the various agents without giving them the ability to configure them.

Retrying Agent Tasks

New in 8.1.33

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 Config > Enterprise Administration > Agent Tasks.

  2. Expand the More dropdown 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

New in 8.1.33

If a task that involves file transfers fails to complete, Ignition will now 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. Currently, this feature is available only for the Remote Upgrade task.