Class: Ansible::Ruby::Modules::Win_template
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Win_template
- Defined in:
- lib/ansible/ruby/modules/generated/windows/win_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
-
#block_end_string ⇒ String?
The string marking the end of a block.
-
#block_start_string ⇒ String?
The string marking the beginning of a block.
-
#dest ⇒ String
Location to render the template to on the remote machine.
-
#force ⇒ :yes, ...
If C(yes), will replace the remote file when contents are different from the source.,If C(no), the file will only be transferred if the destination does not exist.
-
#newline_sequence ⇒ :"\\n", ...
Specify the newline sequence to use for templating files.
-
#src ⇒ String
Path of a Jinja2 formatted template on the local server.
-
#trim_blocks ⇒ :yes, ...
If this is set to C(yes) the first newline after a block is removed (block, not variable tag!).
-
#variable_end_string ⇒ String?
The string marking the end of a print statement.
-
#variable_start_string ⇒ String?
The string marking the beginning of a print statement.
Methods inherited from Base
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
#block_end_string ⇒ String?
Returns The string marking the end of a block.
29 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 29 attribute :block_end_string |
#block_start_string ⇒ String?
Returns The string marking the beginning of a block.
25 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 25 attribute :block_start_string |
#dest ⇒ String
Returns Location to render the template to on the remote machine.
17 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 17 attribute :dest |
#force ⇒ :yes, ...
Returns If C(yes), will replace the remote file when contents are different from the source.,If C(no), the file will only be transferred if the destination does not exist.
45 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 45 attribute :force |
#newline_sequence ⇒ :"\\n", ...
Returns Specify the newline sequence to use for templating files.
21 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 21 attribute :newline_sequence |
#src ⇒ String
Returns Path of a Jinja2 formatted template on the local server. This can be a relative or absolute path.
13 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 13 attribute :src |
#trim_blocks ⇒ :yes, ...
Returns If this is set to C(yes) the first newline after a block is removed (block, not variable tag!).
41 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 41 attribute :trim_blocks |
#variable_end_string ⇒ String?
Returns The string marking the end of a print statement.
37 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 37 attribute :variable_end_string |
#variable_start_string ⇒ String?
Returns The string marking the beginning of a print statement.
33 |
# File 'lib/ansible/ruby/modules/generated/windows/win_template.rb', line 33 attribute :variable_start_string |