Модуль community.general.file_remove — удаление файлов, соответствующих шаблону, из каталога

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать модуль в плейбуке, укажите: community.general.file_remove.

Добавлено в community.general 12.1.0

Краткое описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль удаляет из указанного каталога файлы, соответствующие заданному шаблону. Шаблон может содержать подстановочные знаки и регулярные выражения.
По умолчанию удаляются только файлы в указанном каталоге (без рекурсивного обхода). Используйте параметр recursive для поиска и удаления файлов во вложенных каталогах.

Параметры

Параметр	Комментарии
file_type строка	Тип файлов для удаления. Варианты: `"any"`: удалять и файлы, и символические ссылки. `"file"` (по умолчанию): удалять только обычные файлы. `"link"`: удалять только символические ссылки.
path путь / обязательный	Путь к каталогу, в котором следует удалить файлы. Каталог должен существовать.
pattern строка / обязательный	Шаблон для поиска файлов, которые нужно удалить. Поддерживаются подстановочные знаки (`*`, `?`, `[seq]`, `[!seq]`) для поиска по шаблону glob. Используйте `use_regex=true`, чтобы интерпретировать шаблон как регулярное выражение.
recursive логический	Если `true`, выполнять рекурсивный поиск файлов во вложенных каталогах. Если `false`, удалять файлы только из указанного каталога. Варианты: `false` ← (по умолчанию) `true`
use_regex логический	Если `true`, `pattern` интерпретируется как регулярное выражение. Если `false`, `pattern` интерпретируется как шаблон glob с подстановочными знаками. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль можно запускать в режиме `check_mode` для получения прогноза изменений без изменения целевого объекта.
diff_mode	Поддержка: полная	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примечания

Примечание

Этот модуль никогда не удаляет каталоги — только файлы и, при необходимости, символические ссылки.
При recursive=true этот модуль не следует по символическим ссылкам.
Будьте осторожны с шаблонами, которым могут соответствовать многие файлы, особенно при использовании recursive=true.

Примеры

- name: Remove all log files from /var/log
  community.general.file_remove:
    path: /var/log
    pattern: "*.log"

- name: Remove all temporary files recursively
  community.general.file_remove:
    path: /tmp/myapp
    pattern: "*.tmp"
    recursive: true

- name: Remove files matching a regex pattern
  community.general.file_remove:
    path: /data/backups
    pattern: "backup_[0-9]{8}\\.tar\\.gz"
    use_regex: true

- name: Remove both files and symbolic links
  community.general.file_remove:
    path: /opt/app/cache
    pattern: "cache_*"
    file_type: any

- name: Remove all files starting with 'test_' (check mode)
  community.general.file_remove:
    path: /home/user/tests
    pattern: "test_*"
  check_mode: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
files_count целое число	Количество удалённых файлов. Возвращается: при успешном выполнении Пример: `2`
path строка	Путь к каталогу, в котором выполнялся поиск. Возвращается: при успешном выполнении Пример: `"/var/log"`
removed_files список / элементы=строка	Список удалённых файлов. Возвращается: всегда Пример: `["/var/log/app.log", "/var/log/error.log"]`

Авторы

Shahar Golshani (@shahargolshani)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/file_remove_module.html