ansible.builtin.win_template (v2.3.3.0-1) — module

Templates a file out to a remote server.

| "added in version" 1.9.2 of ansible.builtin"

Authors: Jon Hawkesworth (@jhawkesworth)

stableinterface | supported by core

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

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. Note that including a string that uses a date in the template will result in the template being marked 'changed' each time.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a file from a Jinja2 template
  win_template:
    src: /mytemplates/file.conf.j2
    dest: C:\temp\file.conf

Inputs

    
src:
    description:
    - Path of a Jinja2 formatted template on the local server. This can be a relative
      or absolute path.
    required: true

dest:
    description:
    - Location to render the template to on the remote machine.
    required: true