{% extends "base.html.twig" %}

{% block title %}How to use Agent Profiles{% endblock %}

{% block body %}

    <div class="container-fluid">
        <div class="row">
            <div class="col-md-12">
                <div class="bgc-white bd bdrs-3 p-20 mB-20">
                    <h4 class="c-grey-900"><i class="c-yellow-500 fas fa-question-circle"></i> How to manage Agent Profiles</h4>
                    <hr>
<p class = "text-justify">
The purpose of agent profiles is to be able to configure agent settings on a device in an automatic way.
</p>
<p class = "text-justify">
Every agent is assigned a profile and the profile configuration parameters are checked on each data push from the device. If the parameters on the agent differs from the values defined in the profile, the agent is immediately provided with actual values, resulting in immediate update to the correct values.
</p>
<p class = "text-justify">
The meaning of profile settable values is this:
<ul>
<li>Name ... just a name of the profile. For system profiles, you cannot change the name.</li>
<li>Ping ... interval (in seconds) between ping attempts. If a ping fails, the agent waits this number of seconds till the next ping attempt.</li>
<li>Regular ... number of seconds between data pushes. This is probably the most interesting parameter. Increasing this, the data updates from the device agent will happen in longer intervals, thus making the data consumption smaller but also less frequent, meaning the data you are looking at will be updates less frequently and also device reacting slowly on commands. NOTE that decreasing this to too low number has impact on higher consumtion of resources not only on device, but on the server as well (especially if this concerns a lot of devices). Also, decreasing this to a low number (below 60) may have impact on Webtunnel setup - if a device is not fast enough to finish tunnel setup between two data pushes, the tunnel setup may fail - in that case, first increase this number and then retry Webtunnel setup.</li>
<li>Debug ... this is an interval (in seconds) used to wait between the data pushes when the device agent is set to debug mode. Currently (v. 0.8), this value <i>is not propagated</i> to the device agent.</li>
<li>Fallback ... this interval (in seconds) is a fallback interval between data pushes that is used when all the ping attempts (3) fails consecutively. Once a data push is successful, agent switches back to the Regular interval.</li>
<li>Small Cycles ... number of data pushes (called <i>small data pushes or small cycles</i>) which are followed by a <i>big cycle (big data push)</i>. Some data metrics, especially these that could consume more resources on the device to gather or consume higher amount of data during transfer, are gathered on the device and transferred to the server only during the big cycle. Lowering this increases the frequency of these big data pushes. Increasing the number lowers data and resources consumption, mainly on the devices.</li>
<li>Fail Tolerance ... the number of failed connections (connection fails after 3 unsuccessful pings) for which the data gathered are still considered fresh. Once there are more failed attempts than this number, the data are gathered again prior to next push attempt.</li>
<li>Devices count ... not an agent parameter but a counter showing you how many devices are using this profile.</li>
</ul>
</p>
<p class = "text-justify">
Every new device agent is automatically assigned the <b>DEFAULT</b> agent profile.
</p>
<p class = "text-justify">
You can assign any of the available profiles in two ways:
<ul>
<li> In Device Details - to the one device you are viewing</li>
<li> On the <b>Devices</b> page, using the <b>Assign Agent Profile</b> mass action button below the table. This way you assign the profile to all of the selected devices. If you want to see which Agent profiles are the devices using directly in the table, go to <b>System -&gt; Settings</b> and add the field <i>Agent Profile</i> in the <b>Devices Table Columns</b>. Once you add the field, you can use it for filtering/sorting purposes as usual.</li>
</ul>
</p>
<p class = "text-justify">
You can add any number of your own profiles and edit them at any later time. You can also delete unsued profiles you created.
</p>
<p class = "text-justify">
As for the predefined (system) profiles (<b>DEFAULT</b>, <b>FASTEST</b>, <b>SLOWEST</b>), you can edit the values as you wish but you cannot delete those profiles or rename them.
</p>
                </div>
            </div>
        </div>
    </div>

{% endblock body %}