win_unzip - Разархивирует сжатые файлы и архивы на узле Windows
Новое в версии 2.0.
- Описание
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Описание
- Разархивирует сжатые файлы и архивы.
- Поддерживает файлы .zip напрямую
- Поддерживает другие форматы, поддерживаемые модулем расширений сообщества PowerShell (PSCX) (в основном все, что поддерживает 7zip)
- Для целей, отличных от Windows, используйте модуль unarchive вместо этого.
Требования (для хоста, на котором выполняется модуль)
- PSCX
Параметры
| параметр | обязательный | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| creates | нет | Если этот файл или каталог существует, указанный src не будет извлечён. | ||
| delete_archive | нет | нет |
| Удалить файл zip после разархивирования. псевдонимы: rm |
| dest | да | Место назначения файла zip (укажите абсолютный путь к каталогу). Если он не существует, каталог будет создан. | ||
| recurse | нет | нет |
| Рекурсивно развернуть сжатые файлы в файле src. |
| src | да | Файл, который нужно разархивировать (укажите абсолютный путь). |
Примеры
# This unzips a library that was downloaded with win_get_url, and removes the file after extraction
# $ ansible -i hosts -m win_unzip -a "src=C:\LibraryToUnzip.zip dest=C:\Lib remove=true" all
- name: Unzip a bz2 (BZip) file
win_unzip:
src: C:\Users\Phil\Logs.bz2
dest: C:\Users\Phil\OldLogs
creates: C:\Users\Phil\OldLogs
- name: Unzip gz log
win_unzip:
src: C:\Logs\application-error-logs.gz
dest: C:\ExtractedLogs\application-error-logs
# Unzip .zip file, recursively decompresses the contained .gz files and removes all unneeded compressed files after completion.
- name: Unzip ApplicationLogs.zip and decompress all GZipped log files
hosts: all
gather_facts: false
tasks:
- name: Recursively decompress GZ files in ApplicationLogs.zip
win_unzip:
src: C:\Downloads\ApplicationLogs.zip
dest: C:\Application\Logs
recurse: yes
delete_archive: yes
# Install PSCX to use for extracting a gz file
- name: Grab PSCX msi
win_get_url:
url: http://download-codeplex.sec.s-msft.com/Download/Release?ProjectName=pscx&DownloadId=923562&FileTime=130585918034470000&Build=20959
dest: C:\Windows\Temp\pscx.msi
- name: Install PSCX
win_msi:
path: C:\Windows\Temp\pscx.msi
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для этого модуля:
| имя | описание | возвращено | тип | пример |
|---|---|---|---|---|
| dest | Указанный путь к месту назначения | всегда | строка | C:\ExtractedLogs\application-error-logs |
| removed | Были ли удалены какие-либо файлы модулем во время выполнения задачи | всегда | булево | True |
| src | Указанный путь к исходному файлу | всегда | строка | C:\Logs\application-error-logs.gz |
Примечания
Примечание
- Этот модуль не является полностью идемпотентным, он будет извлекать архив каждый раз и сообщать об изменении.
- Для извлечения типов сжатия, отличных от .zip, требуется модуль PowerShellCommunityExtensions (PSCX). Этот модуль (в сочетании с PSCX) обладает возможностью рекурсивного разархивирования файлов внутри предоставленного файла zip src, а также функциональностью для многих других типов сжатия. Если целевой каталог не существует, он будет создан перед разархивированием файла. Указание параметра rm принудительно удалит файл src после извлечения.
- Для целей, отличных от Windows, используйте модуль unarchive вместо этого.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочтите Информацию сообщества и вклад, Тестирование 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_unzip_module.html