library/template
931f9f1a
 # this is a virtual module that is entirely implemented server side
a040807f
 
 DOCUMENTATION = '''
 ---
 module: template
 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/)).
feab57e2
      - "Four 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, and C(template_path) the
        file name."
a040807f
 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"
   others:
     description:
       - all arguments accepted by the M(file) module also work here
     required: false
 examples:
feab57e2
    - code: "template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644"
a040807f
      description: "Example from Ansible Playbooks"
e620fed7
 notes:
   - Since Ansible version 0.9, templates are loaded with C(trim_blocks=True).
a040807f
 requirements: null
 author: Michael DeHaan
 '''