mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
66 lines
2.7 KiB
Text
66 lines
2.7 KiB
Text
# this is a virtual module that is entirely implemented server side
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: template
|
|
version_added: historical
|
|
short_description: Templates a file out to a remote server.
|
|
description:
|
|
- Templates are processed by the Jinja2 templating language
|
|
(U(http://jinja.pocoo.org/docs/)) - documentation on the template
|
|
formatting can be found in the Template Designer Documentation
|
|
(U(http://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."
|
|
options:
|
|
src:
|
|
description:
|
|
- Path of a Jinja2 formatted template on the local server. This can be a relative or absolute path.
|
|
required: true
|
|
default: null
|
|
aliases: []
|
|
dest:
|
|
description:
|
|
- Location to render the template to on the remote machine.
|
|
required: true
|
|
default: null
|
|
backup:
|
|
description:
|
|
- Create a backup file including the timestamp information so you can get
|
|
the original file back if you somehow clobbered it incorrectly.
|
|
required: false
|
|
choices: [ "yes", "no" ]
|
|
default: "no"
|
|
validate:
|
|
description:
|
|
- validation to run before copying into place
|
|
required: false
|
|
default: ""
|
|
version_added: "1.2"
|
|
others:
|
|
description:
|
|
- all arguments accepted by the M(file) module also work here
|
|
required: false
|
|
notes:
|
|
- "Since Ansible version 0.9, templates are loaded with C(trim_blocks=True)."
|
|
|
|
- "Also, you can override jinja2 settings by adding a special header to template file.
|
|
i.e. C(#jinja2:variable_start_string:'[%' , variable_end_string:'%]')
|
|
which changes the variable interpolation markers to [% var %] instead of {{ var }}. This is the best way to prevent evaluation of things that look like, but should not be Jinja2. raw/endraw in Jinja2 will not work as you expect because templates in Ansible are recursively evaluated."
|
|
|
|
requirements: []
|
|
author: Michael DeHaan
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Example from Ansible Playbooks
|
|
- template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644
|
|
|
|
# Copy a new "sudoers file into place, after passing validation with visudo
|
|
- action: template src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s'
|
|
'''
|