New in version 2.0.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
age
|
|
Select files whose age is equal to or greater than the specified time. Use a negative age to find files equal to or less than the specified time. You can choose seconds, minutes, hours, days, or weeks by specifying the first letter of any of those words (e.g., "1w").
|
age_stamp
|
|
Choose the file property against which we compare age.
|
contains
|
|
One or more regex patterns which should be matched against the file content.
|
depth
(added in 2.6) |
|
Set the maximum number of levels to decend into. Setting recurse to false will override this value, which is effectively depth 1. Default is unlimited depth.
|
excludes
(added in 2.5) |
|
One or more (shell or regex) patterns, which type is controlled by
use_regex option.Excludes is a patterns should not be returned in list. Multiple patterns can be specified using a list.
aliases: exclude |
file_type
|
|
Type of file to select.
The 'link' and 'any' choices were added in version 2.3.
|
follow
|
|
Set this to true to follow symlinks in path for systems with python 2.6+.
|
get_checksum
|
|
Set this to true to retrieve a file's sha1 checksum.
|
hidden
|
|
Set this to true to include hidden files, otherwise they'll be ignored.
|
paths
required |
|
List of paths of directories to search. All paths must be fully qualified.
aliases: name, path |
patterns
|
Default:
*
|
One or more (shell or regex) patterns, which type is controlled by
use_regex option.The patterns restrict the list of files to be returned to those whose basenames match at least one of the patterns specified. Multiple patterns can be specified using a list.
aliases: pattern |
recurse
|
|
If target is a directory, recursively descend into the directory looking for files.
|
size
|
|
Select files whose size is equal to or greater than the specified size. Use a negative size to find files equal to or less than the specified size. Unqualified values are in bytes, but b, k, m, g, and t can be appended to specify bytes, kilobytes, megabytes, gigabytes, and terabytes, respectively. Size is not evaluated for directories.
|
use_regex
|
|
If false the patterns are file globs (shell) if true they are python regexes.
|
- name: Recursively find /tmp files older than 2 days
find:
paths: /tmp
age: 2d
recurse: yes
- name: Recursively find /tmp files older than 4 weeks and equal or greater than 1 megabyte
find:
paths: /tmp
age: 4w
size: 1m
recurse: yes
- name: Recursively find /var/tmp files with last access time greater than 3600 seconds
find:
paths: /var/tmp
age: 3600
age_stamp: atime
recurse: yes
- name: Find /var/log files equal or greater than 10 megabytes ending with .old or .log.gz
find:
paths: /var/log
patterns: '*.old,*.log.gz'
size: 10m
# Note that YAML double quotes require escaping backslashes but yaml single quotes do not.
- name: Find /var/log files equal or greater than 10 megabytes ending with .old or .log.gz via regex
find:
paths: /var/log
patterns: "^.*?\\.(?:old|log\\.gz)$"
size: 10m
use_regex: yes
- name: Find /var/log all directories, exclude nginx and mysql
find:
paths: /var/log
recurse: no
file_type: directory
excludes: 'nginx,mysql'
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
examined
string
|
success |
number of filesystem objects looked at
Sample:
34
|
files
list
|
success |
all matches found with the specified criteria (see stat module for full output of each dictionary)
Sample:
[{'path': '/var/tmp/test1', 'mode': '0644', '...': '...', 'checksum': '16fac7be61a6e4591a33ef4b729c5c3302307523'}, {'path': '/var/tmp/test2', '...': '...'}]
|
matched
string
|
success |
number of matches
Sample:
14
|
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.