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

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

Для его установки используйте: 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 логический	Варианты: нет ← да	Удалить файл zip после распаковки. Псевдонимы: rm
dest путь / обязательно		Путь назначения файла zip (указать абсолютный путь к каталогу). Если он не существует, каталог будет создан.
password строка		Если файл zip зашифрован паролем. Передача значения в параметр password требует установки модуля PSCX.
recurse логический	Варианты: нет ← да	Рекурсивно распаковывать сжатые файлы внутри файла src. Установка значения `yes` требует установки модуля PSCX.
src путь / обязательно		Файл для распаковки (указать абсолютный путь).

Примечания

Примечание

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

См. также

ansible.builtin.unarchive: Официальная документация по модулю 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: yes
    delete_archive: yes

- 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: yes

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

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

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

Авторы

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.10/collections/community/windows/win_unzip_module.html