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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/system/cron.rb

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#backup ⇒ Boolean?

Returns If set, create a backup of the crontab before it is modified. The location of the backup is returned in the C(backup_file) variable by this module.

Returns:

  • (Boolean, nil) —

    If set, create a backup of the crontab before it is modified. The location of the backup is returned in the C(backup_file) variable by this module.



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

attribute :backup

#cron_file ⇒ String?

Returns If specified, uses this file instead of an individual user’s crontab. If this is a relative path, it is interpreted with respect to /etc/cron.d. (If it is absolute, it will typically be /etc/crontab). To use the C(cron_file) parameter you must specify the C(user) as well.

Returns:

  • (String, nil) —

    If specified, uses this file instead of an individual user’s crontab. If this is a relative path, it is interpreted with respect to /etc/cron.d. (If it is absolute, it will typically be /etc/crontab). To use the C(cron_file) parameter you must specify the C(user) as well.



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

attribute :cron_file

#day ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :day

#disabled ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



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

attribute :disabled

#env ⇒ :yes, ...

Returns If set, manages a crontab’s environment variable. New variables are added on top of crontab. “name” and “value” paramenters are the name and the value of environment variable.

Returns:

  • (:yes, :no, nil) —

    If set, manages a crontab’s environment variable. New variables are added on top of crontab. “name” and “value” paramenters are the name and the value of environment variable.



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

attribute :env

#hour ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :hour

#insertafter ⇒ String?

Returns Used with C(state=present) and C(env). If specified, the environment variable will be inserted after the declaration of specified environment variable.

Returns:

  • (String, nil) —

    Used with C(state=present) and C(env). If specified, the environment variable will be inserted after the declaration of specified environment variable.



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

attribute :insertafter

#insertbefore ⇒ Object?

Returns Used with C(state=present) and C(env). If specified, the environment variable will be inserted before the declaration of specified environment variable.

Returns:

  • (Object, nil) —

    Used with C(state=present) and C(env). If specified, the environment variable will be inserted before the declaration of specified environment variable.



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

attribute :insertbefore

#job ⇒ String?

Returns The command to execute or, if env is set, the value of environment variable. Required if state=present.

Returns:

  • (String, nil) —

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



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

attribute :job

#minute ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :minute

#month ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :month

#name ⇒ String?

Returns Description of a crontab entry or, if env is set, the name of environment variable. Required if state=absent.

Returns:

  • (String, nil) —

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



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

attribute :name

#reboot ⇒ :yes, ...

Returns If the job should be run at reboot. This option is deprecated. Users should use special_time.

Returns:

  • (:yes, :no, nil) —

    If the job should be run at reboot. This option is deprecated. Users should use special_time.



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

attribute :reboot

#special_time ⇒ :reboot, ...

Returns Special time specification nickname.

Returns:

  • (:reboot, :yearly, :annually, :monthly, :weekly, :daily, :hourly, nil) —

    Special time specification nickname.



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

attribute :special_time

#state ⇒ :present, ...

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

Returns:

  • (:present, :absent, nil) —

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



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

attribute :state

#user ⇒ String?

Returns The specific user whose crontab should be modified.

Returns:

  • (String, nil) —

    The specific user whose crontab should be modified.



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

attribute :user

#weekday ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :weekday