win_unzip – Распаковывает сжатые файлы и архивы на узле Windows

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Описание

Распаковывает сжатые файлы и архивы.
Поддерживает файлы .zip напрямую.
Поддерживает другие форматы, поддерживаемые модулем PowerShell Community Extensions (PSCX) (в основном все, что поддерживает 7zip).
Для целей, не относящихся к Windows, используйте модуль unarchive вместо этого.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

PSCX

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
creates путь		Если этот файл или директория существуют, указанный src не будет распакован.
delete_archive логический тип	Варианты: нет ← да	Удалить файл zip после распаковки. псевдонимы: rm
dest путь / обязательный		Назначение файла zip (указать абсолютный путь к каталогу). Если каталог не существует, он будет создан.
recurse логический тип	Варианты: нет ← да	Рекурсивно распаковывать сжатые файлы внутри файла src. Установка значения `yes` требует установки модуля PSCX.
src путь / обязательный		Файл для распаковки (указать абсолютный путь).

Примечания

Примечание

Этот модуль не является идемпотентным, он будет распаковывать архив каждый раз и сообщать об изменении.
Для распаковки типов сжатия, отличных от .zip, требуется модуль PowerShellCommunityExtensions (PSCX). Этот модуль (в сочетании с PSCX) имеет возможность рекурсивно распаковывать файлы внутри предоставленного файла src zip, а также функциональность для многих других типов сжатия. Если целевой каталог не существует, он будет создан перед распаковкой файла. Указание параметра rm принудительно удалит файл src после распаковки.

См. также

unarchive – Распаковывает архив после (необязательного) копирования его с локального компьютера: Официальная документация модуля unarchive.

Примеры

# 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=yes" 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: no
  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

- name: Install PSCX
  win_psmodule:
    name: Pscx
    state: present

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

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

Ключ	Возвращаемое значение	Описание
dest строка	всегда	Предоставленный путь к назначению Пример: C:\ExtractedLogs\application-error-logs
removed логический тип	всегда	Указало ли модуль удаление каких-либо файлов во время выполнения задачи Пример: True
src строка	всегда	Предоставленный путь к источнику Пример: C:\Logs\application-error-logs.gz

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Phil Schwartz (@schwartzmx)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/win_unzip_module.html