ansible.builtin.win_unzip (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Unzips compressed files and archives.

Supports .zip files natively.

Supports other formats supported by the Powershell Community Extensions (PSCX) module (basically everything 7zip supports).

For non-Windows targets, use the M(unarchive) module instead.

Requirements

• PSCX

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Unzip gz log
  win_unzip:
    src: C:\Logs\application-error-logs.gz
    dest: C:\ExtractedLogs\application-error-logs

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
src:
    description:
    - File to be unzipped (provide absolute path).
    required: true
    type: path

dest:
    description:
    - Destination of zip file (provide absolute path of directory). If it does not exist,
      the directory will be created.
    required: true
    type: path

creates:
    description:
    - If this file or directory exists the specified src will not be extracted.
    type: path

recurse:
    default: false
    description:
    - Recursively expand zipped files within the src file.
    - Setting to a value of C(yes) requires the PSCX module to be installed.
    type: bool

delete_archive:
    aliases:
    - rm
    default: false
    description:
    - Remove the zip file, after unzipping.
    type: bool

Outputs

dest:
  description: The provided destination path
  returned: always
  sample: C:\ExtractedLogs\application-error-logs
  type: str
removed:
  description: Whether the module did remove any files during task run
  returned: always
  sample: true
  type: bool
src:
  description: The provided source path
  returned: always
  sample: C:\Logs\application-error-logs.gz
  type: str

See also

• unarchive