Class: Ansible::Ruby::Modules::Cronvar

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

Overview

Use this module to manage crontab variables. This module allows you to create, update, or delete cron variable definitions.

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, remove_existing_validations, #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) 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) variable by this module.



37
 
# File 'lib/ansible/ruby/modules/generated/extras/system/cronvar.rb', line 37

attribute :backup

#cron_file ⇒ String?

Returns If specified, uses this file instead of an individual user’s crontab. Without a leading /, this is assumed to be in /etc/cron.d. With a leading /, this is taken as absolute.

Returns:

  • (String, nil) —

    If specified, uses this file instead of an individual user’s crontab. Without a leading /, this is assumed to be in /etc/cron.d. With a leading /, this is taken as absolute.



33
 
# File 'lib/ansible/ruby/modules/generated/extras/system/cronvar.rb', line 33

attribute :cron_file

#insertafter ⇒ Object?

Returns Used with C(state=present). If specified, the variable will be inserted after the variable specified.

Returns:

  • (Object, nil) —

    Used with C(state=present). If specified, the variable will be inserted after the variable specified.



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

attribute :insertafter

#insertbefore ⇒ Object?

Returns Used with C(state=present). If specified, the variable will be inserted just before the variable specified.

Returns:

  • (Object, nil) —

    Used with C(state=present). If specified, the variable will be inserted just before the variable specified.



22
 
# File 'lib/ansible/ruby/modules/generated/extras/system/cronvar.rb', line 22

attribute :insertbefore

#name ⇒ String

Returns Name of the crontab variable.

Returns:

  • (String) —

    Name of the crontab variable.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/system/cronvar.rb', line 11

attribute :name

#state ⇒ :present, ...

Returns Whether to ensure that the variable is present or absent.

Returns:

  • (:present, :absent, nil) —

    Whether to ensure that the variable is present or absent.



25
 
# File 'lib/ansible/ruby/modules/generated/extras/system/cronvar.rb', line 25

attribute :state

#user ⇒ String?

Returns The specific user whose crontab should be modified.

Returns:

  • (String, nil) —

    The specific user whose crontab should be modified.



29
 
# File 'lib/ansible/ruby/modules/generated/extras/system/cronvar.rb', line 29

attribute :user

#value ⇒ String?

Returns The value to set this variable to. Required if state=present.

Returns:

  • (String, nil) —

    The value to set this variable to. Required if state=present.



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

attribute :value