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

Примечание

Этот модуль является частью коллекции community.windows (версия 2.3.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) способен рекурсивно распаковывать файлы внутри указанного файла src zip, а также имеет функции для многих других типов сжатия. Если целевой каталог не существует, он будет создан перед распаковкой файла. Указание параметра 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_unzip_module.html