Defined Type: cron::job

Defined in:
manifests/job.pp

Summary

This type creates a cron job via a file in /etc/cron.d

Overview

Examples:

create a cron job

cron::job { 'generate_puppetdoc':
  minute      => '01',
  environment => [ 'PATH="/usr/sbin:/usr/bin:/sbin:/bin"' ],
  command     => 'puppet doc /etc/puppet/modules >/var/www/puppet_docs.mkd',
}

Parameters:

  • command (Optional[String[1]]) (defaults to: undef) —

    The command to execute.

  • ensure (Cron::Job_ensure) (defaults to: 'present') —

    The state to ensure this resource exists in. Can be absent, present.

  • minute (Cron::Minute) (defaults to: '*') —

    The minute the cron job should fire on. Can be any valid cron.

  • hour (Cron::Hour) (defaults to: '*') —

    The hour the cron job should fire on. Can be any valid cron hour.

  • date (Cron::Date) (defaults to: '*') —

    The date the cron job should fire on. Can be any valid cron date.

  • month (Cron::Month) (defaults to: '*') —

    The month the cron job should fire on. Can be any valid cron month.

  • weekday (Cron::Weekday) (defaults to: '*') —

    The day of the week the cron job should fire on. Can be any valid cron weekday value.

  • special (Cron::Special) (defaults to: undef) —

    A crontab specific keyword like ‘reboot’.

  • environment (Cron::Environment) (defaults to: []) —

    An array of environment variable settings.

  • user (Cron::User) (defaults to: 'root') —

    The user the cron job should be executed as.

  • group (Variant[String[1],Integer[0]]) (defaults to: 0) —

    the group the cron job file should by owned by.

  • mode (Stdlib::Filemode) (defaults to: '0600') —

    The mode to set on the created job file.

  • description (Optional[String]) (defaults to: undef) —

    Optional short description, which will be included in the cron job file.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'manifests/job.pp', line 22

define cron::job (
  Optional[String[1]] $command     = undef,
  Cron::Job_ensure    $ensure      = 'present',
  Cron::Minute        $minute      = '*',
  Cron::Hour          $hour        = '*',
  Cron::Date          $date        = '*',
  Cron::Month         $month       = '*',
  Cron::Weekday       $weekday     = '*',
  Cron::Special       $special     = undef,
  Cron::Environment   $environment = [],
  Cron::User          $user        = 'root',
  Variant[String[1],Integer[0]] $group = 0,
  Stdlib::Filemode    $mode        = '0600',
  Optional[String]    $description = undef,
) {
  assert_type(Cron::Jobname, $title)

  case $ensure {
    'absent':  {
      file { "job_${title}":
        ensure => 'absent',
        path   => "/etc/cron.d/${title}",
      }
    }
    default: {
      file { "job_${title}":
        ensure  => 'file',
        owner   => 'root',
        group   => $group,
        mode    => $mode,
        path    => "/etc/cron.d/${title}",
        content => epp('cron/job.epp', {
            name        => $name,
            environment => $environment,
            description => $description,
            special     => $special,
            user        => $user,
            command     => $command,
            minute      => $minute,
            hour        => $hour,
            date        => $date,
            month       => $month,
            weekday     => $weekday,
        }),
      }
    }
  }
}