Class: Ansible::Ruby::Modules::Archive

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Archive

Defined in:

lib/ansible/ruby/modules/generated/files/archive.rb

Overview

Packs an archive. It is the opposite of M(unarchive). By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying I(remove=True).

Instance Method Summary

• #dest ⇒ String^?

  The file name of the destination archive.

• #exclude_path ⇒ Array<String>, ...

  Remote absolute path, glob, or list of paths or globs for the file or files to exclude from the archive.

• #format ⇒ :bz2, ...

  The type of compression to use.,Support for xz was added in version 2.5.

• #path ⇒ Array<String>, String

  Remote absolute path, glob, or list of paths or globs for the file or files to compress or archive.

• #remove ⇒ :yes, ...

  Remove any added source files and trees after adding to archive.

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

#dest ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/files/archive.rb', line 20

attribute :dest

#exclude_path ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/files/archive.rb', line 24

attribute :exclude_path

#format ⇒ :bz2, ...

# File 'lib/ansible/ruby/modules/generated/files/archive.rb', line 16

attribute :format

#path ⇒ Array<String>, String

# File 'lib/ansible/ruby/modules/generated/files/archive.rb', line 12

attribute :path

#remove ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/files/archive.rb', line 28

attribute :remove