Class: Ansible::Ruby::Modules::Win_unzip

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_unzip.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#creates ⇒ String?

Returns If this file or directory exists the specified src will not be extracted.

Returns:

  • (String, nil) —

    If this file or directory exists the specified src will not be extracted.



31
 
# File 'lib/ansible/ruby/modules/generated/windows/win_unzip.rb', line 31

attribute :creates

#delete_archive ⇒ :yes, ...

Returns Remove the zip file, after unzipping.

Returns:

  • (:yes, :no, nil) —

    Remove the zip file, after unzipping.



23
 
# File 'lib/ansible/ruby/modules/generated/windows/win_unzip.rb', line 23

attribute :delete_archive

#dest ⇒ String

Returns Destination of zip file (provide absolute path of directory). If it does not exist, the directory will be created.

Returns:

  • (String) —

    Destination of zip file (provide absolute path of directory). If it does not exist, the directory will be created.



19
 
# File 'lib/ansible/ruby/modules/generated/windows/win_unzip.rb', line 19

attribute :dest

#recurse ⇒ :yes, ...

Returns Recursively expand zipped files within the src file.,Setting to a value of C(yes) requires the PSCX module to be installed.

Returns:

  • (:yes, :no, nil) —

    Recursively expand zipped files within the src file.,Setting to a value of C(yes) requires the PSCX module to be installed.



27
 
# File 'lib/ansible/ruby/modules/generated/windows/win_unzip.rb', line 27

attribute :recurse

#src ⇒ String

Returns File to be unzipped (provide absolute path).

Returns:

  • (String) —

    File to be unzipped (provide absolute path).



15
 
# File 'lib/ansible/ruby/modules/generated/windows/win_unzip.rb', line 15

attribute :src