ansible.builtin.win_file (v2.4.2.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.4.2.0.post1

Description

Creates (empty) files, updates file modification stamps of existing files, and can create or remove directories.

Unlike M(file), does not modify ownership, permissions or manipulate links.

For non-Windows targets, use the M(file) module instead.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Touch a file (creates if not present, updates modification time if present)
  win_file:
    path: C:\Temp\foo.conf
    state: touch

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove a file, if present
  win_file:
    path: C:\Temp\foo.conf
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create directory structure
  win_file:
    path: C:\Temp\folder\subfolder
    state: directory

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove directory structure
  win_file:
    path: C:\Temp
    state: absent

Inputs

    
path:
    aliases:
    - dest
    - name
    description:
    - 'path to the file being managed.  Aliases: I(dest), I(name)'
    required: true

state:
    choices:
    - file
    - directory
    - touch
    - absent
    description:
    - If C(directory), all immediate subdirectories will be created if they do not exist.
      If C(file), the file will NOT be created if it does not exist, see the M(copy) or
      M(template) module if you want that behavior.  If C(absent), directories will be
      recursively deleted, and files will be removed. If C(touch), an empty file will
      be created if the C(path) does not exist, while an existing file or directory will
      receive updated file access and modification times (similar to the way C(touch)
      works from the command line).