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

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

Overview

Unzips compressed files and archives. 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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #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.



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

attribute :creates

#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.



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

attribute :dest

#recurse ⇒ Boolean?

Returns Recursively expand zipped files within the src file.

Returns:

  • (Boolean, nil) —

    Recursively expand zipped files within the src file.



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

attribute :recurse

#rm ⇒ Boolean?

Returns Remove the zip file, after unzipping.

Returns:

  • (Boolean, nil) —

    Remove the zip file, after unzipping



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

attribute :rm

#src ⇒ String

Returns File to be unzipped (provide absolute path).

Returns:

  • (String) —

    File to be unzipped (provide absolute path)



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

attribute :src