Parameter | Choices/Defaults | Comments |
---|---|---|
path
path
/ required
|
Path to the file being managed.
aliases: dest, name |
|
state
string
|
|
If
directory , all immediate subdirectories will be created if they do not exist.If
file , the file will NOT be created if it does not exist, see the copy or template module if you want that behavior. If absent , directories will be recursively deleted, and files will be removed.If
touch , an empty file will be created if the path does not exist, while an existing file or directory will receive updated file access and modification times (similar to the way touch works from the command line). |
See also
The official documentation on the file module.
The official documentation on the win_acl module.
The official documentation on the win_acl_inheritance module.
The official documentation on the win_owner module.
The official documentation on the win_stat module.
- name: Touch a file (creates if not present, updates modification time if present)
win_file:
path: C:\Temp\foo.conf
state: touch
- name: Remove a file, if present
win_file:
path: C:\Temp\foo.conf
state: absent
- name: Create directory structure
win_file:
path: C:\Temp\folder\subfolder
state: directory
- name: Remove directory structure
win_file:
path: C:\Temp
state: absent
This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
This module is maintained by the Ansible Core Team. [core]
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Jon Hawkesworth (@jhawkesworth)
Hint
If you notice any issues in this documentation you can edit this document to improve it.