win_find — Возврат списка файлов на основе определённых критериев
Новая в версии 2.3.
Описание
- Возвращает список файлов на основе заданных критериев.
- Несколько критериев объединяются по логике И.
- Для платформ, отличных от Windows, используйте модуль find вместо этого.
Параметры
| параметр | обязательный | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| age | нет | Выбирает файлы или папки, чей возраст равен или больше указанного времени. Использование отрицательного значения возраста позволяет найти файлы, чей возраст равен или меньше указанного времени. Вы можете выбрать секунды, минуты, часы, дни или недели, указав первую букву соответствующего слова (например, "2с", "10д", 1н"). | ||
| age_stamp | нет | mtime |
| Выберите свойство файла, с которым мы сравниваем age. По умолчанию сравнивается время последней модификации. |
| checksum_algorithm | нет | sha1 |
| Алгоритм определения контрольной суммы файла. Вызовет ошибку, если хост не поддерживает указанный алгоритм. |
| file_type | нет | file |
| Тип файла для поиска. |
| follow | нет | no |
| Установите в значение true, чтобы следовать символическим ссылкам в пути. Это необходимо использовать совместно с recurse. |
| get_checksum | нет | yes |
| Включить ли возврат контрольной суммы файла в возвращаемой информации (по умолчанию sha1), используйте checksum_algorithm для изменения от значения по умолчанию. |
| hidden | нет | no |
| Установить в значение true для включения скрытых файлов или папок. |
| paths | да | Список путей к каталогам для поиска файлов или папок. Это может быть один путь или список путей. | ||
| patterns | нет | Один или несколько (powershell или regex) шаблонов для сравнения имён файлов. Тип сопоставления шаблонов управляется параметром use_regex. Шаблоны ограничивают список файлов или папок, которые будут возвращены, на основе имён файлов. Для соответствия файла необходимо соответствие хотя бы одному шаблону из предоставленного списка. | ||
| recurse | нет | no |
| Рекурсивно пройдёт по каталогам в поисках файлов или папок. |
| size | нет | Выбирает файлы или папки, чей размер равен или больше указанного размера. Использование отрицательного значения позволяет найти файлы, чей размер равен или меньше указанного размера. Размер можно указать с суффиксом типа байт, например: кило = к, мега = м... Размер не оценивается для символических ссылок. | ||
| use_regex | нет | no |
| Устанавливает шаблоны для работы как проверки regex, если true. |
Примеры
- name: Find files in path
win_find:
paths: D:\temp
- name: Find hidden files in path
win_find:
paths: D:\temp
hidden: True
- name: Find files in multiple paths
win_find:
paths: ['C:\temp', 'D:\temp']
- name: Find files in directory while searching recursively
win_find:
paths: D:\temp
recurse: True
- name: Find files in directory while following symlinks
win_find:
paths: D:\temp
recurse: True
follow: True
- name: Find files with .log and .out extension using powershell wildcards
win_find:
paths: D:\temp
patterns: ['*.log', '*.out']
- name: Find files in path based on regex pattern
win_find:
paths: D:\temp
patterns: 'out_\d{8}-\d{6}.log'
- name: Find files older than 1 day
win_find:
paths: D:\temp
age: 86400
- name: Find files older than 1 day based on create time
win_find:
paths: D:\temp
age: 86400
age_stamp: ctime
- name: Find files older than 1 day with unit syntax
win_find:
paths: D:\temp
age: 1d
- name: Find files newer than 1 hour
win_find:
paths: D:\temp
age: -3600
- name: Find files newer than 1 hour with unit syntax
win_find:
paths: D:\temp
age: -1h
- name: Find files larger than 1MB
win_find:
paths: D:\temp
size: 1048576
- name: Find files larger than 1GB with unit syntax
win_find:
paths: D:\temp
size: 1g
- name: Find files smaller than 1MB
win_find:
paths: D:\temp
size: -1048576
- name: Find files smaller than 1GB with unit syntax
win_find:
paths: D:\temp
size: -1g
- name: Find folders/symlinks in multiple paths
win_find:
paths: ['C:\temp', 'D:\temp']
file_type: directory
- name: Find files and return SHA256 checksum of files found
win_find:
paths: C:\temp
get_checksum: True
checksum_algorithm: sha256
- name: Find files and do not return the checksum
win_find:
path: C:\temp
get_checksum: False
Значения возврата
Общие значения возврата документированы здесь Значения возврата, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| examined | Количество файлов/папок, которые были проверены | всегда | int | 10 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| files | Информация о файлах/папках, которые соответствуют критериям, возвращается как список элементов словаря для каждого соответствующего файла. | успех | сложный | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| содержит: |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| matched | Количество файлов/папок, которые соответствуют критериям | всегда | int | 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вы так решите, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_find_module.html