Class: Ansible::Ruby::Modules::Unarchive

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/files/unarchive.rb

Overview

The M(unarchive) module unpacks an archive. By default, it will copy the source file from the local system to the target before unpacking - set copy=no to unpack an archive which already exists on the target..

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

#copy ⇒ :yes, ...

Returns If true, the file is copied from local ‘master’ to the target machine, otherwise, the plugin will look for src archive at the target machine.

Returns:

  • (:yes, :no, nil) —

    If true, the file is copied from local ‘master’ to the target machine, otherwise, the plugin will look for src archive at the target machine.



19
 
# File 'lib/ansible/ruby/modules/generated/core/files/unarchive.rb', line 19

attribute :copy

#creates ⇒ Object?

Returns a filename, when it already exists, this step will B(not) be run.

Returns:

  • (Object, nil) —

    a filename, when it already exists, this step will B(not) be run.



23
 
# File 'lib/ansible/ruby/modules/generated/core/files/unarchive.rb', line 23

attribute :creates

#dest ⇒ String

Returns Remote absolute path where the archive should be unpacked.

Returns:

  • (String) —

    Remote absolute path where the archive should be unpacked



15
 
# File 'lib/ansible/ruby/modules/generated/core/files/unarchive.rb', line 15

attribute :dest

#exclude ⇒ Object?

Returns List the directory and file entries that you would like to exclude from the unarchive action.

Returns:

  • (Object, nil) —

    List the directory and file entries that you would like to exclude from the unarchive action.



30
 
# File 'lib/ansible/ruby/modules/generated/core/files/unarchive.rb', line 30

attribute :exclude

#extra_opts ⇒ Object?

Returns Specify additional options by passing in an array.

Returns:

  • (Object, nil) —

    Specify additional options by passing in an array.



37
 
# File 'lib/ansible/ruby/modules/generated/core/files/unarchive.rb', line 37

attribute :extra_opts

#keep_newer ⇒ Boolean?

Returns Do not replace existing files that are newer than files from the archive.

Returns:

  • (Boolean, nil) —

    Do not replace existing files that are newer than files from the archive.



33
 
# File 'lib/ansible/ruby/modules/generated/core/files/unarchive.rb', line 33

attribute :keep_newer

#list_files ⇒ :yes, ...

Returns If set to True, return the list of files that are contained in the tarball.

Returns:

  • (:yes, :no, nil) —

    If set to True, return the list of files that are contained in the tarball.



26
 
# File 'lib/ansible/ruby/modules/generated/core/files/unarchive.rb', line 26

attribute :list_files

#src ⇒ String

Returns If copy=yes (default), local path to archive file to copy to the target server; can be absolute or relative. If copy=no, path on the target server to existing archive file to unpack.,If copy=no and src contains ://, the remote machine will download the file from the url first. (version_added 2.0).

Returns:

  • (String) —

    If copy=yes (default), local path to archive file to copy to the target server; can be absolute or relative. If copy=no, path on the target server to existing archive file to unpack.,If copy=no and src contains ://, the remote machine will download the file from the url first. (version_added 2.0)



11
 
# File 'lib/ansible/ruby/modules/generated/core/files/unarchive.rb', line 11

attribute :src