Модуль community.windows.win_file_compression – Изменяет сжатие файлов и каталогов на разделах NTFS.

Примечание

Этот модуль входит в состав коллекции community.windows (версия 2.3.0).

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

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

Для использования в playbook укажите: community.windows.win_file_compression.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль устанавливает атрибут сжатия для файлов и каталогов в файловой системе, поддерживающей это, например, NTFS.
Сжатие NTFS может использоваться для экономии дискового пространства.

Параметры

Параметр	Комментарии
force boolean	Этот параметр имеет эффект только когда recurse равен `true` Если `true`, проверит состояние сжатия всех подкаталогов и файлов и внесёт изменения, если какие-либо из них отличаются от compressed. Если `false`, внесёт изменения только если состояние сжатия path отличается от compressed. Если структура каталога сложная или содержит много файлов, рекомендуется установить этот параметр в `false`, чтобы не проверять каждый файл. Варианты: `false` `true` ← (по умолчанию)
path path / обязательный	Полный путь к файлу или каталогу для изменения. Путь должен существовать в файловой системе, поддерживающей сжатие, например, NTFS.
recurse boolean	Применять ли изменения рекурсивно ко всем подкаталогам и файлам. Этот параметр имеет эффект только когда path является каталогом. Если установлен в `false`, применяет изменения только к path. Если установлен в `true`, применяет изменения к path и всем подкаталогам и файлам. Варианты: `false` ← (по умолчанию) `true`
state string	Установите в `present` для обеспечения сжатия path. Установите в `absent` для обеспечения отсутствия сжатия path. Варианты: `"absent"` `"present"` ← (по умолчанию)

Примечания

Примечание

community.windows.win_file_compression устанавливает состояние сжатия файловой системы, она не создаёт zip-архив.
Дополнительная информация о сжатии NTFS доступна на http://www.ntfs.com/ntfs-compressed.htm

Примеры

- name: Compress log files directory
  community.windows.win_file_compression:
    path: C:\Logs
    state: present

- name: Decompress log files directory
  community.windows.win_file_compression:
    path: C:\Logs
    state: absent

- name: Compress reports directory and all subdirectories
  community.windows.win_file_compression:
    path: C:\business\reports
    state: present
    recurse: true

# This will only check C:\business\reports for the compressed state
# If C:\business\reports is compressed, it will not make a change
# even if one of the child items is uncompressed

- name: Compress reports directory and all subdirectories (quick)
  community.windows.win_file_compression:
    path: C:\business\reports
    compressed: true
    recurse: true
    force: false

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

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

Ключ	Описание
rc целое число	Код возврата операции сжатия/распаковки. Если изменений не было или операция прошла успешно, rc равно 0. Возвращаемое значение: всегда Пример: `0`

Авторы

Micah Hunsberger (@mhunsber)

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

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