Модуль community.windows.win_unzip — распаковывает сжатые файлы и архивы на узле Windows

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.windows. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

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

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

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

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

PSCX

Параметры

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

Примечания

Примечание

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

См. также

ansible.builtin.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
  community.windows.win_unzip:
    src: C:\Users\Phil\Logs.bz2
    dest: C:\Users\Phil\OldLogs
    creates: C:\Users\Phil\OldLogs

- name: Unzip gz log
  community.windows.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: Recursively decompress GZ files in ApplicationLogs.zip
  community.windows.win_unzip:
    src: C:\Downloads\ApplicationLogs.zip
    dest: C:\Application\Logs
    recurse: true
    delete_archive: true

- name: Install PSCX
  community.windows.win_psmodule:
    name: Pscx
    state: present

- name: Unzip .7z file which is password encrypted
  community.windows.win_unzip:
    src: C:\Downloads\ApplicationLogs.7z
    dest: C:\Application\Logs
    password: abcd
    delete_archive: true

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

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

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

Авторы

Phil Schwartz (@schwartzmx)

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

© 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/windows/win_unzip_module.html