Systemd/Timers

Aus wiki.archlinux.de
Wechseln zu: Navigation, Suche

Timer bieten die Möglichkeit Aufgaben zeitlich zu steuern. Die Timer-Unit besteht aus einer .timer Datei die eine .service Datei ansteuert. Timer unterstehen systemd und müssen mit dem systemctl Befehl aktiviert werden. Eine Alternative hierzu bietet cron.

Beispiel

Die .timer Datei

# Datei /etc/systemd/system/beispiel.timer

[Unit]
Description=Beispielaktion nach 1St 30Min

[Timer]
OnBootSec=1h 30m

[Install]
WantedBy=basic.target

Die .service Datei

# Datei /etc/systemd/system/beispiel.service

[Unit]
Description=Beispiel Service

[Service]
ExecStart=/home/<user>/beispiel.sh

Dieses Beispiel stellt eine Minimalvariante der Dateien dar. Weiteres siehe Systemd/Timers#Optionen.

Als [Service] kann ein Befehl oder ein ausführbares Script genutzt werden.

Service- und Timerdatei werden mit root Rechten in /etc/systemd/system/ abgelegt und müssen vor dem . (Punkt) den gleichen Namen tragen.

De-/Aktivierung

systemctl enable --now beispiel.timer

(Bei der ersten Initialisierung legt das System automatisch einen symlink /etc/systemd/system/basic.target.wants/ → /etc/systemd/system/ der .timer Datei an.)

Mit enable --now startet der Timer unverzüglich und permanent, sodass er auch nach einem Neustart aktiv ist.

Ohne --now werden enable oder disable erst nach einem reboot wirksam.

Ein start oder stop wirkt sich nur auf die laufende Sitzung aus.

systemctl reenable --now beispiel.timer

Genügt damit eine nachträgliche Veränderung der Timer-Unit sofort wirksam wird.

Management

systemctl list-timers --all

Listet alle Timer auf. Sollen nur die aktiven Timer angezeigt werden genügt ein systemctl list-timers.


Die folgenden Befehle können beim Debuggen helfen:

systemctl status beispiel.timer
journalctl -xe

Optionen

Die folgende Auflistung der einzelnen Optionen für die Sektionen der .timer und .service Dateien will lediglich einen Überblick bieten.

Für Details wird auf die jeweilige man page verwiesen.

Nur die fettgedruckten Optionen sind Pflichtangaben der betreffenden Sektion.

Die [Unit] Sektion

  • Description= #Hier muss die Einheit beschrieben werden. Die Formulierung ist frei. Auch darf sie in der .timer und .service Datei unterschiedlich sein. Kurze, aussagefähige Beschreibungen sind hierbei vorzuziehen.
  • Documentation= #Eine URL kann hier angegeben werden.
  • Requires=, Requisite= #Weitere Units können hier angegeben werden.
  • Wants= #ein etwas weicheres Requires=
  • BindsTo= #Auch hier wird eine Unit angegeben. Fällt der service aus, weil z.B. ein device entfernt wurde, wird die Timer-Unit an der Ausführung gehindert.
  • PartOf= #beim Ausfall eines service stoppt die timer-unit. Jedoch ohne Auswirkungen auf die hier aufgeführten services.
  • Conflicts=
  • Before=, After= #legt die Start Reihenfolge von services fest.
  • OnFailure= #Ersatz-Units die bei Ausfall genutzt werden sollen.
  • PropagatesReloadTo=, ReloadPropagatedFrom= #ähndelt OnFailure=
  • JoinsNamespaceOf= #Nur wichtig wenn PrivateNetwork= oder PrivateTmp= eingesetzt wird.
  • RequiresMountsFor= #Überprüft ob devices auch gemountet sind.
  • OnFailureJobMode=fail, replace (default), replace-irreversibly, isolate, flush, ignore-dependencies, ignore-requirements #legt das Verhalten für OnFailure= fest.
  • IgnoreOnIsolate=true/false #default ist false. Bei true wird nicht mehr gestoppt bei Isolierung einer anderen Unit.
  • StopWhenUnneeded=true/false #default ist false. Steht im Zusammenhang mit Requires=. Bei true werden nicht mehr benötigte units deaktiviert.
  • RefuseManualStart=true/false, RefuseManualStop=true/false #default ist false. Ein Sicherheitstool. bei true wird die die explizite User Eingabe verlangt, bevor Units de/aktiviert werden können.
  • AllowIsolate=true/false #default ist false. Sinnvoll um ähnlich der runlevels in SysV init Systemen um unbestimmte Systemzustände zu vermeiden.
  • DefaultDependencies=true/false #Default ist true und stellt sicher, dass das System komplett hochgelaufen ist bevor die timer-unit gestartet wird.
  • JobTimeoutSec=, JobTimeoutAction=, JobTimeoutRebootArgument= #stellt bei gestaffelten Jobs ein time-out zur Verfügung.
  • StartLimitIntervalSec=, StartLimitBurst= #Als default werden 5 Ausführungen eines service innerhalb von 10 Sekunden zugestanden. Dieses Limit kann hier den speziellen Anforderungen angepasst werden.
  • StartLimitAction= #Ein Ersatzservice kann bestimmt werden falls das vereinbarte StartLimitIntervalSec=, StartLimitBurst= überschritten wird.
  • RebootArgument= #Optionales reboot.
  • ConditionArchitecture=, ConditionVirtualization=, ConditionHost=, ConditionKernelCommandLine=, ConditionSecurity=, ConditionCapability=, ConditionACPower=, ConditionNeedsUpdate=, ConditionFirstBoot=, ConditionPathExists=, ConditionPathExistsGlob=, ConditionPathIsDirectory=, ConditionPathIsSymbolicLink=, ConditionPathIsMountPoint=, ConditionPathIsReadWrite=, ConditionDirectoryNotEmpty=, ConditionFileNotEmpty=, ConditionFileIsExecutable= # Vorbedingung für die Ausführung der Unit.
  • AssertArchitecture=, AssertVirtualization=, AssertHost=, AssertKernelCommandLine=, AssertSecurity=, AssertCapability=, AssertACPower=, AssertNeedsUpdate=, AssertFirstBoot=, AssertPathExists=, AssertPathExistsGlob=, AssertPathIsDirectory=, AssertPathIsSymbolicLink=, AssertPathIsMountPoint=, AssertPathIsReadWrite=, AssertDirectoryNotEmpty=, AssertFileNotEmpty=, AssertFileIsExecutable= # Wie Condition...allerdings incl. logged loudly bei failure.
  • SourcePath= # Überprüft das Vorhandensein einer Datei.

Genauere Auskunft gibt: man systemd.unit

Die [Timer] Sektion

Es können hier mehrere Zeitangaben gemacht werden. Mindestens eine Zeitangabe muss es in [Timer] geben.

Kalendarische Zeitangaben

  • OnCalendar= #Kalendarische Zeitangabe
Absolute Zeitangaben
OnCalendar=Thu,Fri 2012-*-1..5 11:12:13

Das obige Beispiel besagt: Um 11:12:13 Uhr, zwischen einschl. dem 1. und 5. Tag, aller Monate, des Jahres 2012, jedoch ausschließlich nur an Donnerstagen und Freitagen.

Die Angabe eines Wochentags erfolgt in Englisch. Sie ist optional. Jede Rubrik kann mit "," oder ".." versehen werden oder durch "*" ersetzt werden.

Periodische Zeitangaben
OnCalendar=weekly

Auch diese Werte sind möglich.

minutely, hourly, daily, monthly, weekly, yearly, quarterly, semiannually

Entsprechend den oberen Werten, kann auch diese Schreibweise genutzt werden.

*-*-* *:*:00, *-*-* *:00:00, *-*-* 00:00:00, *-*-01 00:00:00, Mon *-*-* 00:00:00, *-01-01 00:00:00, *-01,04,07,10-01 00:00:00, *-01,07-01 00:00:00

Relative Zeitangaben

Sind abhängig von anderen Ereignissen

Beispiel:

OnBootSec=2d 1h 30m
  • OnActiveSec= #Zeitspanne seit Aktivierung der Timer-Unit.
  • OnBootSec= #Zeitspanne seit dem Booten des Rechners.
  • OnStartupSec= #Zeitspanne seit dem Start von systemd.
  • OnUnitActiveSec= #Zeitspanne seit der Timer den letzten Job ausgelöst hat.
  • OnUnitInactiveSec= #Zeitspanne der Inaktivität seit Beendigung des letzten Jobs.

Folgende Einheiten können für relative Zeitangaben gewählt werden:

usec, us
msec, ms
seconds, second, sec, s
minutes, minute, min, m
hours, hour, hr, h
days, day, d
weeks, week, w
months, month, M (definiert als 30.44 Tage)
years, year, y (definiert als 365.25 Tage)

Ohne Verwendung einer Einheit werden alle Angaben als Sekunden gewertet.

Weitere Optionen in [Timer]

  • AccuracySec= #Die Zeitspanne zum Ausführen beträgt als default 1 Minute. Durch Verwendung von AccuracySec kann diese Zeitspanne variiert werden.
  • RandomizedDelaySec= #Kann verwendet werden damit nicht mehrere Timer exakt zur gleichen Zeit loslegen. default ist 0.
  • Unit= #Als default ist dieser Wert identisch mit dem Suffix der .timer Datei. Bei der Verwendung von Unit= muss auch eine Datei mit selbigen Namen erstellt werden. Eine Verschachtelung von Units ist hierdurch möglich. Siehe Higgsboson Blog Reflector
  • Persistent=true #bewirkt, dass ein versäumter Job beim nächsten Rechnerstart unverzüglich nachgeholt wird.
  • WakeSystem= #Weckt das System aus dem supend mode.
  • RemainAfterElapse=true/false #true hält den Timer aktiv, false beendet den Timer nach einmaliger Ausführung.

Weiteres dazu siehe man systemd.time.


Die [Install] Sektion

  • Alias= #Aliasnamen der Unit. Wird nicht von jedem Type unterstützt.
  • WantedBy=basic.target, bluetooth.target, getty.target, multi-user.target, printer.target, sockets.target #Bei der ersten Initialisierung der Timer-Unit wird ein symbolischen Link von /etc/systemd/system/basic.target.wants/ angelegt. Erst dann ist die Unit aktiv.
  • RequiredBy= #entspricht WantetBy=.
  • Also= #installiert oder deinstalliert andere Units bei Aktivierung dieser Unit.
  • DefaultInstance= #Regelt den expliziten Einsatz von Vorlage Unit Dateien.

Näheres dazu siehe man systemd.unit und man systemd.special.

Die [Service] Sektion

  • Type=simple (default), forking, oneshot, dbus, notify, idle.
    • PIDFile= #In Zusammenhang mit Type=forking kann für den Fork eine PID hinterlegt werden.
    • BusName= #Bei Type=dbus kann hier der betreffende D-Bus Name vereinbart werden.
    • NotifyAccess= none (default), main, all. #Steuert den service status notification socket.
  • ExecStart= #Angabe von einem oder mehrerer Befehle und deren Argumente oder eines ausführbaren Scripts. Die absolute Pfadangabe wird verlangt.
    • ExecStartPre=, ExecStartPost= #Hier aufgeführte Befehle werden vor bzw. nach ExecStart= ausgeführt.
    • ExecReload=# Wind genutzt um eine Rekonfiguration des Service zu veranlassen.
    • ExecStop= #Wird benötigt falls der Service zum Beenden spezielle Befehle braucht.
      • ExecStopPost= #Ergänzt ExecStop=
    • RemainAfterExit= #no (default), yes hält den service aktiv.
    • PermissionsStartOnly= #Default ist false. True erlaubt unter ExecStart= Befehle mit anderen Benutzerrechten ausführen zu lassen als die Komandos bei ExecStartPre=, ExecStartPost=, ExecReload=, ExecStop=, und ExecStopPost=.
  • GuessMainPID= #Default ist yes. Wenn die PID nicht exakt bestimmt werden kann wird normalerweise versucht sie zu berechnen. Dies kann hier ausgeschaltet werden.
  • TimeoutSec=, TimeoutStartSec=, TimeoutStopSec= #Legt ein Timeout für den Service fest.
  • RuntimeMaxSec= #Begrenzt die Laufzeit eines Service. Default ist unbegrenzte Zeit.
  • WatchdogSec= #Überwacht den Service auf Aktivität.
  • Restart= no (default), on-success, on-failure, on-abnormal, on-watchdog, on-abort, always #Startet den Service erneut.
    • RestartSec= #wird nur für Restart= gebraucht
  • RootDirectoryStartOnly= #Default ist false. True erlaubt das root Verzeichnis selektiv für ExecStart= Befehle neu zu definieren.
  • Sockets= #Siehe man systemd.socket
    • NonBlocking= #Default ist false. Siehe Näheres man systemd.socket
  • FailureAction= #Aktion nach Scheitern des Service. Default ist none.
  • FileDescriptorStoreMax= #Anzahl der Datei Descriptoren. Default ist 0.
  • USBFunctionDescriptors= #Betrifft USB-Sticks.
  • USBFunctionStrings= #Betrifft USB-Sticks.

Näheres dazu siehe man systemd.service.

E-Mail

Die engliche Archwiki Seite berichtet ausführlich darüber.

Siehe auch

Weblinks