Config-Model-Systemd

 view release on metacpan or  search on metacpan

lib/Config/Model/models/Systemd/Section/Timer.pl  view on Meta::CPAN

    'element' => [
      'OnActiveSec',
      {
        'description' => 'Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pl  view on Meta::CPAN

      },
      'OnBootSec',
      {
        'description' => 'Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pl  view on Meta::CPAN

      },
      'OnStartupSec',
      {
        'description' => 'Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pl  view on Meta::CPAN

      },
      'OnUnitActiveSec',
      {
        'description' => 'Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pl  view on Meta::CPAN

      },
      'OnUnitInactiveSec',
      {
        'description' => 'Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pl  view on Meta::CPAN

below.',
        'type' => 'leaf',
        'value_type' => 'uniline'
      },
      'OnCalendar',
      {
        'cargo' => {
          'type' => 'leaf',
          'value_type' => 'uniline'
        },
        'description' => 'Defines realtime (i.e. wallclock) timers with calendar event expressions. See
L<systemd.time(7)> for
more information on the syntax of calendar event expressions. Otherwise, the semantics are similar to
C<OnActiveSec> and related settings.

Note that timers do not necessarily expire at the precise time configured with this setting, as
it is subject to the C<AccuracySec> setting below.

May be specified more than once, in which case the timer unit will trigger whenever any of the
specified expressions elapse. Moreover, calendar timers and monotonic timers (see above) may be
combined within the same timer unit.

If the empty string is assigned to any of these options, the list of timers is reset (both
C<OnCalendar> timers and monotonic timers, see above), and all prior assignments
will have no effect.

Note that calendar timers might be triggered at unexpected times if the system\'s realtime clock
is not set correctly. Specifically, on systems that lack a battery-buffered Realtime Clock (RTC) it
might be wise to enable C<systemd-time-wait-sync.service> to ensure the clock is
adjusted to a network time source before the timer event is set up. Timer units
with at least one C<OnCalendar> expression are automatically ordered after
C<time-sync.target>, which C<systemd-time-wait-sync.service> is
ordered before.

When a system is temporarily put to sleep (i.e. system suspend or hibernation) the realtime
clock does not pause. When a calendar timer elapses while the system is sleeping it will not be acted
on immediately, but once the system is later resumed it will catch up and process all timers that
triggered while the system was sleeping. Note that if a calendar timer elapsed more than once while
the system was continuously sleeping the timer will only result in a single service activation. If
C<WakeSystem> (see below) is enabled a calendar time event elapsing while the system
is suspended will cause the system to wake up (under the condition the system\'s hardware supports
time-triggered wake-up functionality).',
        'type' => 'list'
      },
      'AccuracySec',
      {
        'description' => 'Specify the accuracy the timer shall elapse
with. Defaults to 1min. The timer is scheduled to elapse
within a time window starting with the time specified in
C<OnCalendar>,

lib/Config/Model/models/Systemd/Section/Timer.pod  view on Meta::CPAN

=head2 OnActiveSec

Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pod  view on Meta::CPAN

=head2 OnBootSec

Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pod  view on Meta::CPAN

=head2 OnStartupSec

Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pod  view on Meta::CPAN

=head2 OnUnitActiveSec

Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pod  view on Meta::CPAN

=head2 OnUnitInactiveSec

Defines monotonic timers relative to different
starting points:

Multiple directives may be combined of the same and of different types, in which case the timer
unit will trigger whenever any of the specified timer expressions elapse. For example, by combining
C<OnBootSec> and C<OnUnitActiveSec>, it is possible to define a
timer that elapses in regular intervals and activates a specific service each time. Moreover, both
monotonic time expressions and C<OnCalendar> calendar expressions may be combined in
the same timer unit.

The arguments to the directives are time spans
configured in seconds. Example: "OnBootSec=50" means 50s after
boot-up. The argument may also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and 30 minutes after
boot-up. For details about the syntax of time spans, see
L<systemd.time(7)>.

If a timer configured with C<OnBootSec>

lib/Config/Model/models/Systemd/Section/Timer.pod  view on Meta::CPAN

monotonic timers and C<OnCalendar> timers, see below), and all prior assignments
will have no effect.

Note that timers do not necessarily expire at the
precise time configured with these settings, as they are
subject to the C<AccuracySec> setting
below. I< Optional. Type uniline.  > 

=head2 OnCalendar

Defines realtime (i.e. wallclock) timers with calendar event expressions. See
L<systemd.time(7)> for
more information on the syntax of calendar event expressions. Otherwise, the semantics are similar to
C<OnActiveSec> and related settings.

Note that timers do not necessarily expire at the precise time configured with this setting, as
it is subject to the C<AccuracySec> setting below.

May be specified more than once, in which case the timer unit will trigger whenever any of the
specified expressions elapse. Moreover, calendar timers and monotonic timers (see above) may be
combined within the same timer unit.

If the empty string is assigned to any of these options, the list of timers is reset (both
C<OnCalendar> timers and monotonic timers, see above), and all prior assignments
will have no effect.

Note that calendar timers might be triggered at unexpected times if the system's realtime clock
is not set correctly. Specifically, on systems that lack a battery-buffered Realtime Clock (RTC) it
might be wise to enable C<systemd-time-wait-sync.service> to ensure the clock is
adjusted to a network time source before the timer event is set up. Timer units
with at least one C<OnCalendar> expression are automatically ordered after
C<time-sync.target>, which C<systemd-time-wait-sync.service> is
ordered before.

When a system is temporarily put to sleep (i.e. system suspend or hibernation) the realtime
clock does not pause. When a calendar timer elapses while the system is sleeping it will not be acted
on immediately, but once the system is later resumed it will catch up and process all timers that
triggered while the system was sleeping. Note that if a calendar timer elapsed more than once while
the system was continuously sleeping the timer will only result in a single service activation. If
C<WakeSystem> (see below) is enabled a calendar time event elapsing while the system
is suspended will cause the system to wake up (under the condition the system's hardware supports
time-triggered wake-up functionality). I< Optional. Type list of uniline.  > 

=head2 AccuracySec

Specify the accuracy the timer shall elapse
with. Defaults to 1min. The timer is scheduled to elapse
within a time window starting with the time specified in
C<OnCalendar>,
C<OnActiveSec>,