ansible.builtin.file – Manage files and file properties
ansible.builtin.file – Manage files and file properties
Note
This module is part of ansible-base
and included in all Ansible installations. In most cases, you can use the short module name file even without specifying the collections:
keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.
Synopsis
- Set attributes of files, symlinks or directories.
- Alternatively, remove files, symlinks or directories.
- Many other modules support the same options as the
file
module - including ansible.builtin.copy, ansible.builtin.template, and ansible.builtin.assemble. - For Windows targets, use the ansible.windows.win_file module instead.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
access_time string added in 2.7 of ansible.builtin |
This parameter indicates the time the file's access time should be set to. Should be Default is | |
access_time_format string added in 2.7 of ansible.builtin |
Default: "%Y%m%d%H%M.%S" |
When used with Based on default Python format (see time.strftime doc). |
attributes string added in 2.3 of ansible.builtin |
The attributes the resulting file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr. The
| |
follow boolean added in 1.8 of ansible.builtin |
|
This flag indicates that filesystem links, if they exist, should be followed. Previous to Ansible 2.5, this was |
force boolean |
|
Force the creation of the symlinks in two cases: the source file does not exist (but will appear later); the destination exists and is a file (so, we need to unlink the |
group string |
Name of the group that should own the file/directory, as would be fed to chown. | |
mode raw |
The permissions the resulting file or directory should have. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, If If Specifying | |
modification_time string added in 2.7 of ansible.builtin |
This parameter indicates the time the file's modification time should be set to. Should be Default is None meaning that | |
modification_time_format string added in 2.7 of ansible.builtin |
Default: "%Y%m%d%H%M.%S" |
When used with Based on default Python format (see time.strftime doc). |
owner string |
Name of the user that should own the file/directory, as would be fed to chown. | |
path path / required |
Path to the file being managed.
| |
recurse boolean added in 1.1 of ansible.builtin |
|
Recursively set the specified file attributes on directory contents. This applies only when |
selevel string |
The level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the When set to | |
serole string |
The role part of the SELinux file context. When set to | |
setype string |
The type part of the SELinux file context. When set to | |
seuser string |
The user part of the SELinux file context. By default it uses the When set to | |
src path |
Path of the file to link to. This applies only to For Relative paths are relative to the file being created ( | |
state string |
|
If If If If If If |
unsafe_writes boolean added in 2.2 of ansible.builtin |
|
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. This option allows Ansible to fall back to unsafe methods of updating files when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes). IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. |
Notes
Note
- Supports
check_mode
.
See Also
See also
- ansible.builtin.assemble
- The official documentation on the ansible.builtin.assemble module.
- ansible.builtin.copy
- The official documentation on the ansible.builtin.copy module.
- ansible.builtin.stat
- The official documentation on the ansible.builtin.stat module.
- ansible.builtin.template
- The official documentation on the ansible.builtin.template module.
- ansible.windows.win_file
- The official documentation on the ansible.windows.win_file module.
Examples
- name: Change file ownership, group and permissions
ansible.builtin.file:
path: /etc/foo.conf
owner: foo
group: foo
mode: '0644'
- name: Give insecure permissions to an existing file
ansible.builtin.file:
path: /work
owner: root
group: root
mode: '1777'
- name: Create a symbolic link
ansible.builtin.file:
src: /file/to/link/to
dest: /path/to/symlink
owner: foo
group: foo
state: link
- name: Create two hard links
ansible.builtin.file:
src: '/tmp/{{ item.src }}'
dest: '{{ item.dest }}'
state: hard
loop:
- { src: x, dest: y }
- { src: z, dest: k }
- name: Touch a file, using symbolic modes to set the permissions (equivalent to 0644)
ansible.builtin.file:
path: /etc/foo.conf
state: touch
mode: u=rw,g=r,o=r
- name: Touch the same file, but add/remove some permissions
ansible.builtin.file:
path: /etc/foo.conf
state: touch
mode: u+rw,g-wx,o-rwx
- name: Touch again the same file, but do not change times this makes the task idempotent
ansible.builtin.file:
path: /etc/foo.conf
state: touch
mode: u+rw,g-wx,o-rwx
modification_time: preserve
access_time: preserve
- name: Create a directory if it does not exist
ansible.builtin.file:
path: /etc/some_directory
state: directory
mode: '0755'
- name: Update modification and access time of given file
ansible.builtin.file:
path: /etc/some_file
state: file
modification_time: now
access_time: now
- name: Set access time based on seconds from epoch value
ansible.builtin.file:
path: /etc/another_file
state: file
access_time: '{{ "%Y%m%d%H%M.%S" | strftime(stat_var.stat.atime) }}'
- name: Recursively change ownership of a directory
ansible.builtin.file:
path: /etc/foo
state: directory
recurse: yes
owner: foo
group: foo
- name: Remove file (delete file)
ansible.builtin.file:
path: /etc/foo.txt
state: absent
- name: Recursively remove directory
ansible.builtin.file:
path: /etc/foo
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
dest string |
state=touch, state=hard, state=link |
Destination file/path, equal to the value passed to path.
Sample: /path/to/file.txt |
path string |
state=absent, state=directory, state=file |
Destination file/path, equal to the value passed to path.
Sample: /path/to/file.txt |
Authors
- Ansible Core Team
- Michael DeHaan
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/file_module.html