Initial commit

Author: vlcty

README.md

@@ -0,0 +1,55 @@
+# ansible-systemd-timer
+
+## About
+This roles enables you to create systemd timers which call scripts or execute commands.
+
+## Usage
+
+Define a variable ```timers```. This variable is a dictionary. Every key is a new timer.
+
+### Example
+
+Here is an example for my 1337 Telegram Bot. The Timer "calls" a script which sends the message "It's now 13:37" in one of my Telegram chats every day at 13:37 GMT o'Clock.
+
+```
+timers:
+   1337TelegramBot:
+      timer_command: /home/telegrambot/sendMessage.pl
+      timer_user: telegrambot
+      timer_OnCalendar: "*-*-* 13:37:00 CET"
+      timer_AccuracySec: 5s
+```
+
+That's all the magic.
+
+### Existing variables
+
+| Variable | Required |  Default value / Explanation |
+|----------|----------|------------------------------|
+| timer_command |  yes | Which command or script to execute |
+| timer_user | no | Under which users the timer_command is executed. Default: root |
+| timer_persistent | no | Takes a boolean argument. If true, the time when the service unit was last triggered is stored on disk. When the timer is activated, the service unit is triggered immediately if it would have been triggered at least once during the time when the timer was inactive. This is useful to catch up on missed runs of the service when the machine was off. Note that this setting only has an effect on timers configured with OnCalendar=. Defaults to false. [Source](https://www.freedesktop.org/software/systemd/man/systemd.timer.html) |
+| timer_OnActiveSec | no | Relative time after the timer unit was last activated |
+| timer_OnBootSec | no | Relative time after the computer was booted |
+| timer_OnStartupSec | no | Relative time after systemd was started |
+| timer_OnUnitActiveSec | no | Relative time after the service unit was last activated |
+| timer_OnUnitInactiveSec | no | Relative time after the service unit was last deactivated |
+| timer_OnCalendar | no | Absolute time when to call activate the unit |
+| timer_AccuracySec | no | Timer have a default accuracy of round about one minute. You can set the accuracy with this var. Default: 15s |
+
+You can chain every timer_On* variable. Example:
+
+```
+timers:
+   updateDNS:
+      timer_command: /home/dnsupdate/updateMe.pl
+      timer_user: dnsupdate
+      timer_OnStartupSec: 20s
+      timer_OnUnitActiveSec: 5m
+```
+
+The timer unit will be triggered 20 seconds after systemd was started and then every 5 minutes.
+
+More about timers: https://www.freedesktop.org/software/systemd/man/systemd.timer.html
+
+More about timespans: https://www.freedesktop.org/software/systemd/man/systemd.time.html

tasks/main.yml

@@ -0,0 +1,37 @@
+---
+- block:
+
+    - name: Failing when timer_command is undefined
+      fail:
+          msg: Varible timer_command is not defined
+      when: item.value.timer_command is undefined
+      with_dict: "{{ timers }}"
+
+    - name: Uploading service file
+      template:
+          src: service.j2
+          dest: "/etc/systemd/system/{{ item.key }}.service"
+          owner: root
+          group: root
+          mode: 0750
+      with_dict: "{{ timers }}"
+
+    - name: Uploading timer file
+      template:
+          src: timer.j2
+          dest: "/etc/systemd/system/{{ item.key }}.timer"
+          owner: root
+          group: root
+          mode: 0750
+      with_dict: "{{ timers }}"
+
+    - name: Enabling timers
+      systemd:
+          name: "{{ item.key }}.timer"
+          state: started
+          enabled: true
+          masked: false
+          daemon_reload: true
+      with_dict: "{{ timers }}"
+
+  when: timers is defined

templates/service.j2

@@ -0,0 +1,13 @@
+#
+# Managed by ansible
+# Role: systemd-timer
+#
+[Unit]
+Description={{ item.key }} Service
+
+[Service]
+Type=oneshot
+ExecStart={{ item.value.timer_command }}
+{% if item.value.timer_user is defined %}
+User={{ item.value.timer_user }}
+{% endif %}

templates/timer.j2

@@ -0,0 +1,31 @@
+#
+# Managed by ansible
+# Role: systemd-timer
+#
+[Unit]
+Description={{ item.key }} Timer
+
+[Timer]
+{% if item.value.timer_OnActiveSec is defined %}
+OnActiveSec={{ item.value.timer_OnActiveSec }}
+{% endif %}
+{% if item.value.timer_OnBootSec is defined %}
+OnBootSec={{ item.value.timer_OnBootSec }}
+{% endif %}
+{% if item.value.timer_OnStartupSec is defined %}
+OnStartupSec={{ item.value.timer_OnStartupSec }}
+{% endif %}
+{% if item.value.timer_OnUnitActiveSec is defined %}
+OnUnitActiveSec={{ item.value.timer_OnUnitActiveSec }}
+{% endif %}
+{% if item.value.timer_OnUnitInactiveSec is defined %}
+OnUnitInactiveSec={{ item.value.timer_OnUnitInactiveSec }}
+{% endif %}
+{% if item.value.timer_OnCalendar is defined %}
+OnCalendar={{ item.value.timer_OnCalendar }}
+Persistent={{ item.value.timer_persistent | default('false') }}
+{% endif %}
+AccuracySec={{ item.value.timer_AccuracySec | default('15s') }}
+
+[Install]
+WantedBy=timers.target