@@ -158,6 +158,9 @@ <h1 class="toc-title">Contents</h1>
158158id ="toc-aide_cron_check "> aide_cron_check</ a > </ li >
159159< li > < a href ="#aide_cron_interval "
160160id ="toc-aide_cron_interval "> aide_cron_interval</ a > </ li >
161+ < li > < a href ="#variables-exported-by-the-role "
162+ id ="toc-variables-exported-by-the-role "> Variables Exported by the
163+ Role</ a > </ li >
161164</ ul > </ li >
162165< li > < a href ="#example-playbook " id ="toc-example-playbook "> Example
163166Playbook</ a > </ li >
@@ -198,12 +201,17 @@ <h1 id="role-variables">Role Variables</h1>
198201< h2 id ="aide_config_template "> aide_config_template</ h2 >
199202< p > This variable takes a string to specify a path where the custom
200203template for aide.conf is located.</ p >
201- < p > To be sure that everething is correct, template needs to start with
204+ < p > To be sure that everything is correct, template needs to start with
202205following snippet:</ p >
203206< pre class ="jinja "> < code > {{ ansible_managed | comment }}
204207{{ "system_role:aide" | comment(prefix="", postfix="") }}</ code > </ pre >
205208< p > Default: < code > null</ code > </ p >
206209< p > Type: < code > string</ code > </ p >
210+ < p > < strong > NOTE:</ strong > The config file format has changed somewhat in
211+ AIDE version 0.17. The role exports a variable < code > aide_version</ code >
212+ which you can use, and see < code > examples/aide-custom.conf.j2</ code > for
213+ an example of how to conditionally define configuration which will work
214+ across multiple versions of AIDE.</ p >
207215< h2 id ="aide_db_fetch_dir "> aide_db_fetch_dir</ h2 >
208216< p > This variable takes a string to specify the directory on the Ansible
209217Control Node (ACN) where the role will store the AIDE database fetched
@@ -248,25 +256,39 @@ <h2 id="aide_cron_interval">aide_cron_interval</h2>
248256< span id ="cb2-8 "> < a href ="#cb2-8 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="co "> # * * * * *</ span > </ span > </ code > </ pre > </ div >
249257< p > Default: < code > 0 12 * * *</ code > </ p >
250258< p > Type: < code > string</ code > </ p >
259+ < h2 id ="variables-exported-by-the-role "> Variables Exported by the
260+ Role</ h2 >
261+ < p > The role will export the following variables:</ p >
262+ < p > < code > aide_version</ code > - string - this is the AIDE version you can
263+ use if you need to do something which depends on the version e.g. in
264+ your custom template you can do:</ p >
265+ < pre class ="jinja2 "> < code > {% if aide_version is version("0.17.0", ">=") %}
266+ # The location of the database to be read.
267+ database_in=file:@@{DBDIR}/aide.db.gz
268+ ... other new style parameters ...
269+ {% else %}
270+ database=file:@@{DBDIR}/aide.db.gz
271+ ... other old style parameters ...
272+ {% endif %}</ code > </ pre >
251273< h1 id ="example-playbook "> Example Playbook</ h1 >
252274< p > Including an example of how to use your role (for instance, with
253275variables passed in as parameters) is always nice for users too:</ p >
254- < div class ="sourceCode " id ="cb3 "> < pre
255- class ="sourceCode yaml "> < code class ="sourceCode yaml "> < span id ="cb3 -1 "> < a href ="#cb3 -1 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="co "> # </ span > < span class ="an "> SPDX-License-Identifier:</ span > < span class ="co "> MIT</ span > </ span >
256- < span id ="cb3 -2 "> < a href ="#cb3 -2 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="pp "> ---</ span > </ span >
257- < span id ="cb3 -3 "> < a href ="#cb3 -3 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="kw "> -</ span > < span class ="at "> </ span > < span class ="fu "> name</ span > < span class ="kw "> :</ span > < span class ="at "> Example aide role invocation</ span > </ span >
258- < span id ="cb3 -4 "> < a href ="#cb3 -4 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> hosts</ span > < span class ="kw "> :</ span > < span class ="at "> targets</ span > </ span >
259- < span id ="cb3 -5 "> < a href ="#cb3 -5 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> tasks</ span > < span class ="kw "> :</ span > </ span >
260- < span id ="cb3 -6 "> < a href ="#cb3 -6 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="kw "> -</ span > < span class ="at "> </ span > < span class ="fu "> name</ span > < span class ="kw "> :</ span > < span class ="at "> Include role aide</ span > </ span >
261- < span id ="cb3 -7 "> < a href ="#cb3 -7 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> vars</ span > < span class ="kw "> :</ span > </ span >
262- < span id ="cb3 -8 "> < a href ="#cb3 -8 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_db_fetch_dir</ span > < span class ="kw "> :</ span > < span class ="at "> files</ span > </ span >
263- < span id ="cb3 -9 "> < a href ="#cb3 -9 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_install</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> true</ span > </ span >
264- < span id ="cb3 -10 "> < a href ="#cb3 -10 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_generate_config</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> true</ span > </ span >
265- < span id ="cb3 -11 "> < a href ="#cb3 -11 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_init</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> true</ span > </ span >
266- < span id ="cb3 -12 "> < a href ="#cb3 -12 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_check</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> false</ span > </ span >
267- < span id ="cb3 -13 "> < a href ="#cb3 -13 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_update</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> false</ span > </ span >
268- < span id ="cb3 -14 "> < a href ="#cb3 -14 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> ansible.builtin.include_role</ span > < span class ="kw "> :</ span > </ span >
269- < span id ="cb3 -15 "> < a href ="#cb3 -15 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> name</ span > < span class ="kw "> :</ span > < span class ="at "> linux-system-roles.aide</ span > </ span > </ code > </ pre > </ div >
276+ < div class ="sourceCode " id ="cb4 "> < pre
277+ class ="sourceCode yaml "> < code class ="sourceCode yaml "> < span id ="cb4 -1 "> < a href ="#cb4 -1 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="co "> # </ span > < span class ="an "> SPDX-License-Identifier:</ span > < span class ="co "> MIT</ span > </ span >
278+ < span id ="cb4 -2 "> < a href ="#cb4 -2 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="pp "> ---</ span > </ span >
279+ < span id ="cb4 -3 "> < a href ="#cb4 -3 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="kw "> -</ span > < span class ="at "> </ span > < span class ="fu "> name</ span > < span class ="kw "> :</ span > < span class ="at "> Example aide role invocation</ span > </ span >
280+ < span id ="cb4 -4 "> < a href ="#cb4 -4 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> hosts</ span > < span class ="kw "> :</ span > < span class ="at "> targets</ span > </ span >
281+ < span id ="cb4 -5 "> < a href ="#cb4 -5 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> tasks</ span > < span class ="kw "> :</ span > </ span >
282+ < span id ="cb4 -6 "> < a href ="#cb4 -6 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="kw "> -</ span > < span class ="at "> </ span > < span class ="fu "> name</ span > < span class ="kw "> :</ span > < span class ="at "> Include role aide</ span > </ span >
283+ < span id ="cb4 -7 "> < a href ="#cb4 -7 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> vars</ span > < span class ="kw "> :</ span > </ span >
284+ < span id ="cb4 -8 "> < a href ="#cb4 -8 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_db_fetch_dir</ span > < span class ="kw "> :</ span > < span class ="at "> files</ span > </ span >
285+ < span id ="cb4 -9 "> < a href ="#cb4 -9 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_install</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> true</ span > </ span >
286+ < span id ="cb4 -10 "> < a href ="#cb4 -10 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_generate_config</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> true</ span > </ span >
287+ < span id ="cb4 -11 "> < a href ="#cb4 -11 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_init</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> true</ span > </ span >
288+ < span id ="cb4 -12 "> < a href ="#cb4 -12 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_check</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> false</ span > </ span >
289+ < span id ="cb4 -13 "> < a href ="#cb4 -13 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> aide_update</ span > < span class ="kw "> :</ span > < span class ="at "> </ span > < span class ="ch "> false</ span > </ span >
290+ < span id ="cb4 -14 "> < a href ="#cb4 -14 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> ansible.builtin.include_role</ span > < span class ="kw "> :</ span > </ span >
291+ < span id ="cb4 -15 "> < a href ="#cb4 -15 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="at "> </ span > < span class ="fu "> name</ span > < span class ="kw "> :</ span > < span class ="at "> linux-system-roles.aide</ span > </ span > </ code > </ pre > </ div >
270292< p > More examples can be found in the < a
271293href ="examples "> < code > examples/</ code > </ a > directory.</ p >
272294< h1 id ="license "> License</ h1 >
0 commit comments