Defined Type: cron::monthly

Defined in:
manifests/monthly.pp

Overview

Type: cron::monthly

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

Parameters:

ensure - The state to ensure this resource exists in. Can be absent, present
  Defaults to 'present'
minute - The minute the cron job should fire on. Can be any valid cron
minute value.
  Defaults to '0'.
hour - The hour the cron job should fire on. Can be any valid cron hour
value.
  Defaults to '0'.
date - The date the cron job should fire on. Can be any valid cron date
value.
  Defaults to '1'.
environment - An array of environment variable settings.
  Defaults to an empty set ([]).
user - The user the cron job should be executed as.
  Defaults to 'root'.
mode - The mode to set on the created job file
  Defaults to 0600.
description - Optional short description, which will be included in the
cron job file.
  Defaults to undef.
command - The command to execute.

Actions:

Requires:

Sample Usage:

cron::monthly { 'delete_old_log_files':
  minute      => '1',
  hour        => '7',
  date        => '28',
  environment => [ 'MAILTO="admin@example.com"' ],
  command     => 'find /var/log -type f -ctime +30 -delete',
}

Parameters:

  • command (Optional[String[1]]) (defaults to: undef)
  • ensure (Cron::Job_ensure) (defaults to: 'present')
  • minute (Cron::Minute) (defaults to: 0)
  • hour (Cron::Hour) (defaults to: 0)
  • date (Cron::Date) (defaults to: 1)
  • environment (Cron::Environment) (defaults to: [])
  • user (Cron::User) (defaults to: 'root')
  • mode (Cron::Mode) (defaults to: '0600')
  • description (Optional[String]) (defaults to: undef) 


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
 
# File 'manifests/monthly.pp', line 41

define cron::monthly (
  Optional[String[1]] $command     = undef,
  Cron::Job_ensure    $ensure      = 'present',
  Cron::Minute        $minute      = 0,
  Cron::Hour          $hour        = 0,
  Cron::Date          $date        = 1,
  Cron::Environment   $environment = [],
  Cron::User          $user        = 'root',
  Cron::Mode          $mode        = '0600',
  Optional[String]    $description = undef,
) {

  cron::job { $title:
    ensure      => $ensure,
    minute      => $minute,
    hour        => $hour,
    date        => $date,
    month       => '*',
    weekday     => '*',
    user        => $user,
    environment => $environment,
    mode        => $mode,
    command     => $command,
    description => $description,
  }

}