Documentation

assemble - Assembles a configuration file from fragments

Synopsis

Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a conf.d style structure where it is easy to build up the configuration from multiple sources. 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 fragments.

Options

parameter required default choices comments
backup
 no no
  • yes
  • no
Create a backup file (if yes), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
delimiter
(added in 1.4)
 no
    A delimiter to separate the file contents.
    dest
    		 yes
      A file to create using the concatenation of all of the source files.
      group
      		 no
        name of the group that should own the file/directory, as would be fed to chown
        ignore_hidden
        (added in 2.0)
        		 no
          A boolean that controls if files that start with a '.' will be included or not.
          mode
          		 no
            mode the file or directory should be. For those used to /usr/bin/chmod remember that modes are actually octal numbers (like 0644). Leaving off the leading zero will likely have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r).
            owner
            		 no
              name of the user that should own the file/directory, as would be fed to chown
              regexp
              		 no
                Assemble files only if 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 http://docs.python.org/2/library/re.html.
                remote_src
                (added in 1.4)
                		 no True
                • True
                • False
                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.
                selevel
                		 no s0
                  level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range. _default feature works as for seuser.
                  serole
                  		 no
                    role part of SELinux file context, _default feature works as for seuser.
                    setype
                    		 no
                      type part of SELinux file context, _default feature works as for seuser.
                      seuser
                      		 no
                        user part of SELinux file context. Will default to system policy, if applicable. If set to _default, it will use the user portion of the policy if available
                        src
                        		 yes
                          An already existing directory full of source files.
                          validate
                          (added in 2.0)
                          		 no
                            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.

                            Examples

                            # Example from Ansible Playbooks
- assemble: src=/etc/someapp/fragments dest=/etc/someapp/someapp.conf

# When a delimiter is specified, it will be inserted in between each fragment
- assemble: src=/etc/someapp/fragments dest=/etc/someapp/someapp.conf delimiter='### START FRAGMENT ###'

# Copy a new "sshd_config" file into place, after passing validation with sshd
- assemble: src=/etc/ssh/conf.d/ dest=/etc/ssh/sshd_config validate='/usr/sbin/sshd -t -f %s'

                            This is a Core Module

                            For more information on what this means please read Core Modules

                            For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.