Class: Ansible::Ruby::Modules::Assemble

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

Overview

Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a C(conf.d) style structure where it is easy to build up the configuration from multiple sources. C(assemble) will take a directory of files that can be local or have already been transferred to the system, and concatenate them together to produce a destination file. Files are assembled in string sorting order. Puppet calls this idea I(fragments).

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

#backup ⇒ :yes, ...

Returns Create a backup file (if C(yes)), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.

Returns:

  • (:yes, :no, nil) —

    Create a backup file (if C(yes)), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.



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

attribute :backup

#delimiter ⇒ String?

Returns A delimiter to separate the file contents.

Returns:

  • (String, nil) —

    A delimiter to separate the file contents.



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

attribute :delimiter

#dest ⇒ String

Returns A file to create using the concatenation of all of the source files.

Returns:

  • (String) —

    A file to create using the concatenation of all of the source files.



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

attribute :dest

#ignore_hidden ⇒ :yes, ...

Returns A boolean that controls if files that start with a ‘.’ will be included or not.

Returns:

  • (:yes, :no, nil) —

    A boolean that controls if files that start with a ‘.’ will be included or not.



35
 
# File 'lib/ansible/ruby/modules/generated/files/assemble.rb', line 35

attribute :ignore_hidden

#regexp ⇒ Object?

Returns Assemble files only if C(regex) matches the filename. If not set, all files are assembled. All “\” (backslash) must be escaped as “\\” to comply yaml syntax. Uses Python regular expressions; see U(docs.python.org/2/library/re.html).

Returns:

  • (Object, nil) —

    Assemble files only if C(regex) matches the filename. If not set, all files are assembled. All “\” (backslash) must be escaped as “\\” to comply yaml syntax. Uses Python regular expressions; see U(docs.python.org/2/library/re.html).



32
 
# File 'lib/ansible/ruby/modules/generated/files/assemble.rb', line 32

attribute :regexp

#remote_src ⇒ :yes, ...

Returns If False, it will search for src at originating/master machine, if True it will go to the remote/target machine for the src. Default is True.

Returns:

  • (:yes, :no, nil) —

    If False, it will search for src at originating/master machine, if True it will go to the remote/target machine for the src. Default is True.



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

attribute :remote_src

#src ⇒ String

Returns An already existing directory full of source files.

Returns:

  • (String) —

    An already existing directory full of source files.



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

attribute :src

#validate ⇒ String?

Returns The validation command to run before copying into place. The path to the file to validate is passed in via ‘%s’ which must be present as in the sshd example below. The command is passed securely so shell features like expansion and pipes won’t work.

Returns:

  • (String, nil) —

    The validation command to run before copying into place. The path to the file to validate is passed in via ‘%s’ which must be present as in the sshd example below. The command is passed securely so shell features like expansion and pipes won’t work.



39
 
# File 'lib/ansible/ruby/modules/generated/files/assemble.rb', line 39

attribute :validate