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.

On this page ...

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.

    Activate LicenseActivate 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 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 Project

    Distributes 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.

  5. Click NextThe 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.

In This Section ...

  • No labels