assemble¶
Collection Note
This module is part of the ansible.builtin collection. To install the collection, use:
Added in version0.5.
Synopsis¶
- 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. M(ansible.builtin.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).
Parameters¶
| Parameter | Defaults / Choices | Comments |
|---|---|---|
| attributes str |
The attributes the resulting filesystem object should have. To get supported flags look at the man page for C(chattr) on the target system. This string should contain the attributes in the same order as the one displayed by C(lsattr). The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string. Version Added: 2.3 |
|
| backup bool |
Create a backup file (if V(true)), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. | |
| decrypt bool |
Default: True |
This option controls the auto-decryption of source files using vault. Version Added: 2.4 |
| delimiter str |
A delimiter to separate the file contents. Version Added: 1.4 |
|
| dest path required |
A file to create using the concatenation of all of the source files. | |
| group str |
Name of the group that should own the filesystem object, as would be fed to C(chown). When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership. |
|
| ignore_hidden bool |
A boolean that controls if files that start with a C(.) will be included or not. Version Added: 2.0 |
|
| mode raw |
The permissions the resulting filesystem object should have. For those used to C(/usr/bin/chmod) remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, V(0755)) works sometimes, but can fail in loops and some other circumstances. Giving Ansible a number without following either of these rules will end up with a decimal number which will have unexpected results. As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx) or V(u=rw,g=r,o=r)). If O(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used when setting the mode for the newly created filesystem object. If O(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used. Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details. |
|
| owner str |
Name of the user that should own the filesystem object, as would be fed to C(chown). When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership. Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion. |
|
| regexp str |
Assemble files only if the given regular expression matches the filename. If not set, all files are assembled. Every V(\\) (backslash) must be escaped as V(\\\\) to comply to YAML syntax. Uses L(Python regular expressions,https://docs.python.org/3/library/re.html). |
|
| remote_src bool |
Default: True |
If V(false), it will search for src at originating/master machine. If V(true), it will go to the remote/target machine for the src. Version Added: 1.4 |
| selevel str |
The level part of the SELinux filesystem object context. This is the MLS/MCS attribute, sometimes known as the C(range). When set to V(_default), it will use the C(level) portion of the policy if available. |
|
| serole str |
The role part of the SELinux filesystem object context. When set to V(_default), it will use the C(role) portion of the policy if available. |
|
| setype str |
The type part of the SELinux filesystem object context. When set to V(_default), it will use the C(type) portion of the policy if available. |
|
| seuser str |
The user part of the SELinux filesystem object context. By default it uses the V(system) policy, where applicable. When set to V(_default), it will use the C(user) portion of the policy if available. |
|
| src path required |
An already existing directory full of source files. | |
| unsafe_writes bool |
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object. By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes). IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. Version Added: 2.2 |
|
| validate str |
The validation command to run before copying into place. The path to the file to validate is passed in by C(%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. Version Added: 2.0 |
Examples¶
- name: Assemble from fragments from a directory
ansible.builtin.assemble:
src: /etc/someapp/fragments
dest: /etc/someapp/someapp.conf
- name: Insert the provided delimiter between fragments
ansible.builtin.assemble:
src: /etc/someapp/fragments
dest: /etc/someapp/someapp.conf
delimiter: '### START FRAGMENT ###'
- name: Assemble a new "sshd_config" file into place, after passing validation with sshd
ansible.builtin.assemble:
src: /etc/ssh/conf.d/
dest: /etc/ssh/sshd_config
validate: /usr/sbin/sshd -t -f %s
Authors¶
- Stephen Fromm (@sfromm)