Tasks

Task is a task (well, thank you, captn). It's a set of workers, that can be scheduled to run with certain periodicity. Tasks are available under Processes -> Tasks menu. Note, that some tasks are considered as system tasks and are protected from deletion and some tasks can't be assigned to nodes - only to devices. Here's the table of built-in tasks:

Task Protected Nodes Devices Description
backup yes yes yes Retrieve nodes configuration
discovery yes no no Discover new and update existing nodes
git_commit yes no no Commit obtained configuration to git. In system settings git repository for configs must be configured and initialized. Check corresponding manual for Git configuration.
log_processing yes no no Clear outdated logs. Additionally configured in system settings via parameter Logs lifetime (7 days by default)
node_processing yes no no Clear outdated nodes which were not online for certain time. Additionally configured in system settings via parameter Nodes lifetime (unlimited by default).
save yes yes yes Save configuration on nodes, can be useful to additionally secure node from losing unsaved config
stp yes yes yes Retrieve STP information from nodes

In the task list you can see all available tasks grouped by destination and to check if there're any assignments exist and to edit or assign them as well. Please note, that column Task Type is displayed only in the list of tasks for information purposes. All custom tasks you create automatically acquire Node task type. Creating system task or defining new task type requires diving deeper into development, working with Java daemon and API. Also, task type Yii command is assigned to plugin-related tasks only.

Assign tasks

Task can be assigned under Processes -> Task Assignments menu to any node or to the device. Or you can press seen on the image above. Note, that tasks discovery, git_commit, log_processing and node_processing are system-wide tasks and can't be assigned to devices nor nodes (there's no icon next to them).

There're several assignment modes: simple assignment to nodes, advanced assignment to nodes, simple assignment to devices and advanced assignment to devices. Difference between assignment to nodes and devices should be clear: in the first case task is assigned to particular nodes, and in the second - to every node under certain device class.

Simple nodes

Simple mode allows to assign task to node in one easy step: choose task, choose node, set worker and save. Dropdown select box for hostname or ip-address is searchable. Keep in mind what worker do you want to assign to the chosen node:

Advanced nodes

Advanced mode is meant to allow assignment in batch mode, processing multiple nodes at once. First you will be promted what task do you want to assign. Next you will be redirected to advanced form where you want to choose all necessary nodes. Mark checkboxes for all nodes you want to assign and press "Assign nodes" button below. All nodes that are already assigned will be marked with green checkmark you can remove to unassign task from the node:

Simple devices

Simple mode allows to assign task to node in one easy step: choose task, choose device, set worker and save. Keep in mind what worker do you want to assign to the chosen device:

Advanced devices

Advanced mode is meant to allow assignment in batch mode, processing multiple devices at once. First you will be promted what task and what do you want to assign. Next you will be redirected to advanced form where you want to choose all necessary devices. Mark checkboxes for all devices you want to assign and press "Assign devices" button below. All devices that are already assigned will be marked with green checkmark you can remove to unassign task from the device. Also there can be red icons, showing that this device has already attached to the chosen task but with different worker. To read what worker has been assigned, hover mouse pointer onto the icon.