Skip to content

Commit

Permalink
Close #256 - Add documentation for new tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
Valentin Hamon committed Jan 17, 2017
1 parent 6d3c168 commit 95719f8
Showing 1 changed file with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion doc/source/armadito-agent/tasks/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,29 @@ Enrollment is mandatory and need to be done when agent is not in database (remov

$ armadito-agent -t "Enrollment" -k "AAAAA-AAAAA-AAAAA-AAAAA-AAAAA"


Scheduler
*********

-- GET & POST **/api/schedulers**

**1** - Retrieve Scheduler configuration defined into plugin Armadito for GLPI (if there is one)

**2** - Update local Scheduler configuration (if needed)

**3** - Retrieve current local Scheduler configuration

**4** - Send it in a json message to plugin Armadito for GLPI

**5** - Store only differences in database


**Example** :
::

$ armadito-agent -t "Scheduler"


Getjobs
*******

Expand Down Expand Up @@ -79,7 +102,6 @@ Example 2, tasks are executed after waiting randomly between 0 and 10 seconds :

.. note:: It works in combination with **Getjobs** task. **Getjobs** should be run more often than **Runjobs** in order to fully benefit from job priority system.


State
*****

Expand Down Expand Up @@ -133,3 +155,28 @@ Alerts

.. note:: A checksum considering main characteristics is computed on server side. It allows to avoid inserting duplicates.

AVConfig
********

-- GET & POST **/api/avconfigs**

**1** - Retrieve Antivirus configuration defined into plugin Armadito for GLPI (if there is one)

**2** - Update local computer Antivirus' configuration (if needed)

**3** - Retrieve current local Antivirus configuration

**4** - Send it in a json message to plugin Armadito for GLPI

**5** - Store only differences in database


**Example** :
::

$ armadito-agent -t "AVConfigs"

.. note:: The way Step **5** has been implemented leads to a great reduction of database size. Indeed, if 1000 agents have the same configuration, only 1 copy will be stored.



0 comments on commit 95719f8

Please sign in to comment.