Class: Ansible::Ruby::Modules::Cron

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Cron

Defined in:

lib/ansible/ruby/modules/generated/system/cron.rb

Overview

Use this module to manage crontab and environment variables entries. This module allows you to create environment variables and named crontab entries, update, or delete them. When crontab jobs are managed: the module includes one line with the description of the crontab entry C(“#Ansible: <name>”) corresponding to the “name” passed to the module, which is used by future ansible/module calls to find/check the state. The “name” parameter should be unique, and changing the “name” value will result in a new cron task being created (or a different one being removed). When environment variables are managed: no comment line is added, but, when the module needs to find/check the state, it uses the “name” parameter to find the environment variable definition line. When using symbols such as %, they must be properly escaped.

Instance Method Summary

• #backup ⇒ :yes, ...

  If set, create a backup of the crontab before it is modified.

• #cron_file ⇒ String^?

  If specified, uses this file instead of an individual user’s crontab.

• #day ⇒ String^?

  Day of the month the job should run ( 1-31, *, */2, etc ).

• #disabled ⇒ :yes, ...

  If the job should be disabled (commented out) in the crontab.,Only has effect if C(state=present).

• #env ⇒ :yes, ...

  If set, manages a crontab’s environment variable.

• #hour ⇒ String^?

  Hour when the job should run ( 0-23, *, */2, etc ).

• #insertafter ⇒ String^?

  Used with C(state=present) and C(env).

• #insertbefore ⇒ Object^?

  Used with C(state=present) and C(env).

• #job ⇒ String^?

  The command to execute or, if env is set, the value of environment variable.

• #minute ⇒ String^?

  Minute when the job should run ( 0-59, *, */2, etc ).

• #month ⇒ String^?

  Month of the year the job should run ( 1-12, *, */2, etc ).

• #name ⇒ String^?

  Description of a crontab entry or, if env is set, the name of environment variable.

• #reboot ⇒ :yes, ...

  If the job should be run at reboot.

• #special_time ⇒ :reboot, ...

  Special time specification nickname.

• #state ⇒ :absent, ...

  Whether to ensure the job or environment variable is present or absent.

• #user ⇒ String^?

  The specific user whose crontab should be modified.

• #weekday ⇒ String^?

  Day of the week that the job should run ( 0-6 for Sunday-Saturday, *, etc ).

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#backup ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 35

attribute :backup

#cron_file ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 31

attribute :cron_file

#day ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 47

attribute :day

#disabled ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 67

attribute :disabled

#env ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 71

attribute :env

#hour ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 43

attribute :hour

#insertafter ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 75

attribute :insertafter

#insertbefore ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 79

attribute :insertbefore

#job ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 23

attribute :job

#minute ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 39

attribute :minute

#month ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 51

attribute :month

#name ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 15

attribute :name

#reboot ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 59

attribute :reboot

#special_time ⇒ :reboot, ...

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 63

attribute :special_time

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 27

attribute :state

#user ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 19

attribute :user

#weekday ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/cron.rb', line 55

attribute :weekday