mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
eb1214baad
Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version
116 lines
3.8 KiB
Python
116 lines
3.8 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2015, Phil Schwartz <schwartzmx@gmail.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# this is a windows documentation stub. actual code lives in the .ps1
|
|
# file of the same name
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: win_unzip
|
|
version_added: "2.0"
|
|
short_description: Unzips compressed files and archives on the Windows node
|
|
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)
|
|
requirements:
|
|
- PSCX
|
|
options:
|
|
src:
|
|
description:
|
|
- File to be unzipped (provide absolute path)
|
|
required: true
|
|
dest:
|
|
description:
|
|
- Destination of zip file (provide absolute path of directory). If it does not exist, the directory will be created.
|
|
required: true
|
|
rm:
|
|
description:
|
|
- Remove the zip file, after unzipping
|
|
required: no
|
|
choices:
|
|
- true
|
|
- false
|
|
- yes
|
|
- no
|
|
default: false
|
|
recurse:
|
|
description:
|
|
- Recursively expand zipped files within the src file.
|
|
required: no
|
|
default: false
|
|
choices:
|
|
- true
|
|
- false
|
|
- yes
|
|
- no
|
|
creates:
|
|
description:
|
|
- If this file or directory exists the specified src will not be extracted.
|
|
required: no
|
|
default: null
|
|
notes:
|
|
- For extracting any compression types other than .zip, the PowerShellCommunityExtensions (PSCX) Module is required. This module (in conjunction with PSCX) has the ability to recursively unzip files within the src zip file provided and also functionality for many other compression types. If the destination directory does not exist, it will be created before unzipping the file. Specifying rm parameter will force removal of the src file after extraction.
|
|
author: Phil Schwartz
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
# 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 rm=true" all
|
|
# Playbook example
|
|
|
|
# Simple unzip
|
|
---
|
|
- name: Unzip a bz2 (BZip) file
|
|
win_unzip:
|
|
src: C:\Users\Phil\Logs.bz2
|
|
dest: C:\Users\Phil\OldLogs
|
|
creates: C:\Users\Phil\OldLogs
|
|
|
|
# This playbook example unzips a .zip file and 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: false
|
|
tasks:
|
|
- name: Recursively decompress GZ files in ApplicationLogs.zip
|
|
win_unzip:
|
|
src: C:\Downloads\ApplicationLogs.zip
|
|
dest: C:\Application\Logs
|
|
recurse: yes
|
|
rm: true
|
|
|
|
# Install PSCX to use for extracting a gz file
|
|
- name: Grab PSCX msi
|
|
win_get_url:
|
|
url: http://download-codeplex.sec.s-msft.com/Download/Release?ProjectName=pscx&DownloadId=923562&FileTime=130585918034470000&Build=20959
|
|
dest: C:\pscx.msi
|
|
- name: Install PSCX
|
|
win_msi:
|
|
path: C:\pscx.msi
|
|
- name: Unzip gz log
|
|
win_unzip:
|
|
src: C:\Logs\application-error-logs.gz
|
|
dest: C:\ExtractedLogs\application-error-logs
|
|
'''
|