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

Примечания

Примечание

Этот модуль не является полностью идемпотентным, он будет распаковывать архив каждый раз и сообщать об изменении.
Для извлечения любых типов сжатия, кроме .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 string	всегда	Указанный путь назначения Пример: C:\ExtractedLogs\application-error-logs
removed boolean	всегда	Удалялись ли файлы модулем во время выполнения задачи Пример: True
src string	всегда	Указанный исходный путь Пример: C:\Logs\application-error-logs.gz

Авторы

Phil Schwartz (@schwartzmx)

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