Class: Ansible::Ruby::Modules::Template

Inherits:
Base show all
Includes:
MissingFileStuff
Defined in:
lib/ansible/ruby/modules/generated/core/files/template.rb,
lib/ansible/ruby/modules/custom/files/template.rb

Overview

Templates are processed by the Jinja2 templating language (U(jinja.pocoo.org/docs/)) - documentation on the template formatting can be found in the Template Designer Documentation (U(jinja.pocoo.org/docs/templates/)). Six additional variables can be used in templates: C(ansible_managed) (configurable via the C(defaults) section of C(ansible.cfg)) contains a string which can be used to describe the template name, host, modification time of the template file and the owner uid, C(template_host) contains the node name of the template’s machine, C(template_uid) the owner, C(template_path) the absolute path of the template, C(template_fullpath) is the absolute path of the template, and C(template_run_date) is the date that the template was rendered. Note that including a string that uses a date in the template will result in the template being marked ‘changed’ each time.

Instance Method Summary collapse

Methods included from MissingFileStuff

included

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, ...

Returns Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.

Returns:

  • (:yes, :no, nil) —

    Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.



20
 
# File 'lib/ansible/ruby/modules/generated/core/files/template.rb', line 20

attribute :backup

#dest ⇒ String

Returns Location to render the template to on the remote machine.

Returns:

  • (String) —

    Location to render the template to on the remote machine.



16
 
# File 'lib/ansible/ruby/modules/generated/core/files/template.rb', line 16

attribute :dest

#force ⇒ :yes, ...

Returns the default is C(yes), which will replace the remote file when contents are different than the source. If C(no), the file will only be transferred if the destination does not exist.

Returns:

  • (:yes, :no, nil) —

    the default is C(yes), which will replace the remote file when contents are different than the source. If C(no), the file will only be transferred if the destination does not exist.



24
 
# File 'lib/ansible/ruby/modules/generated/core/files/template.rb', line 24

attribute :force

#src ⇒ String

Returns Path of a Jinja2 formatted template on the Ansible controller. This can be a relative or absolute path.

Returns:

  • (String) —

    Path of a Jinja2 formatted template on the Ansible controller. This can be a relative or absolute path.



12
 
# File 'lib/ansible/ruby/modules/generated/core/files/template.rb', line 12

attribute :src