ansible.windows.win_file (2.3.0) — module

Creates, touches or removes files or directories

Authors: Jon Hawkesworth (@jhawkesworth)

Install collection

Install with ansible-galaxy collection install ansible.windows:==2.3.0


Add to requirements.yml

  collections:
    - name: ansible.windows
      version: 2.3.0

Description

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

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

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Touch a file (creates if not present, updates modification time if present)
  ansible.windows.win_file:
    path: C:\Temp\foo.conf
    state: touch
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove a file, if present
  ansible.windows.win_file:
    path: C:\Temp\foo.conf
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create directory structure
  ansible.windows.win_file:
    path: C:\Temp\folder\subfolder
    state: directory
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove directory structure
  ansible.windows.win_file:
    path: C:\Temp
    state: absent

Inputs

    
path:
    aliases:
    - dest
    - name
    description:
    - Path to the file being managed.
    required: true
    type: path

state:
    choices:
    - absent
    - directory
    - file
    - touch
    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(ansible.windows.win_copy)
      or M(ansible.windows.win_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).
    type: str

See also