Skip to main content

Note

This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name replace even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

New in version 1.6: of ansible.builtin

Synopsis

  • This module will replace all instances of a pattern within a file.
  • It is up to the user to maintain idempotence by ensuring that the same pattern would never match any replacements made.

Parameters

Parameter Choices/Defaults Comments
after
string
added in 2.4 of ansible.builtin
If specified, only content after this match will be replaced/removed.
Can be used in combination with before.
Uses Python regular expressions; see http://docs.python.org/2/library/re.html.
Uses DOTALL, which means the . special character can match newlines.
attributes
string
added in 2.3 of ansible.builtin
The attributes the resulting file or directory should have.
To get supported flags look at the man page for chattr on the target system.
This string should contain the attributes in the same order as the one displayed by lsattr.
The = operator is assumed as default, otherwise + or - operators need to be included in the string.

aliases: attr
backup
boolean
    Choices:
  • no ←
  • yes
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
before
string
added in 2.4 of ansible.builtin
If specified, only content before this match will be replaced/removed.
Can be used in combination with after.
Uses Python regular expressions; see http://docs.python.org/2/library/re.html.
Uses DOTALL, which means the . special character can match newlines.
encoding
string
added in 2.4 of ansible.builtin
Default:
"utf-8"
The character encoding for reading and writing the file.
group
string
Name of the group that should own the file/directory, as would be fed to chown.
mode
raw
The permissions the resulting file or directory should have.
For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like 0644 or 01777) or quote it (like '644' or '1777') so Ansible receives a string and can do its own conversion from string into number.
Giving Ansible a number without following one 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, u+rwx or u=rw,g=r,o=r).
If mode is not specified and the destination file does not exist, the default umask on the system will be used when setting the mode for the newly created file.
If mode is not specified and the destination file does exist, the mode of the existing file will be used.
Specifying mode is the best way to ensure files are created with the correct permissions. See CVE-2020-1736 for further details.
others
string
All arguments accepted by the ansible.builtin.file module also work here.
owner
string
Name of the user that should own the file/directory, as would be fed to chown.
path
path / required
The file to modify.
Before Ansible 2.3 this option was only usable as dest, destfile and name.

aliases: dest, destfile, name
regexp
string / required
The regular expression to look for in the contents of the file.
Uses Python regular expressions; see http://docs.python.org/2/library/re.html.
Uses MULTILINE mode, which means ^ and $ match the beginning and end of the file, as well as the beginning and end respectively of each line of the file.
Does not use DOTALL, which means the . special character matches any character except newlines. A common mistake is to assume that a negated character set like [^#] will also not match newlines.
In order to exclude newlines, they must be added to the set like [^#\n].
Note that, as of Ansible 2.0, short form tasks should have any escape sequences backslash-escaped in order to prevent them being parsed as string literal escapes. See the examples.
replace
string
The string to replace regexp matches.
May contain backreferences that will get expanded with the regexp capture groups if the regexp matches.
If not set, matches are removed entirely.
Backreferences can be used ambiguously like \1, or explicitly like \g<1>.
selevel
string
The level part of the SELinux file context.
This is the MLS/MCS attribute, sometimes known as the range.
When set to _default, it will use the level portion of the policy if available.
serole
string
The role part of the SELinux file context.
When set to _default, it will use the role portion of the policy if available.
setype
string
The type part of the SELinux file context.
When set to _default, it will use the type portion of the policy if available.
seuser
string
The user part of the SELinux file context.
By default it uses the system policy, where applicable.
When set to _default, it will use the user portion of the policy if available.
unsafe_writes
boolean
added in 2.2 of ansible.builtin
    Choices:
  • no ←
  • yes
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file.
By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, 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 files 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.
validate
string
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 examples below.
The command is passed securely so shell features like expansion and pipes will not work.

Notes

Note

Examples

- name: Before Ansible 2.3, option 'dest', 'destfile' or 'name' was used instead of 'path'   ansible.builtin.replace:     path: /etc/hosts     regexp: '(\s+)old\.host\.name(\s+.*)?$'     replace: '\1new.host.name\2'  - name: Replace after the expression till the end of the file (requires Ansible >= 2.4)   ansible.builtin.replace:     path: /etc/apache2/sites-available/default.conf     after: 'NameVirtualHost [*]'     regexp: '^(.+)$'     replace: '# \1'  - name: Replace before the expression till the begin of the file (requires Ansible >= 2.4)   ansible.builtin.replace:     path: /etc/apache2/sites-available/default.conf     before: '# live site config'     regexp: '^(.+)$'     replace: '# \1'  # Prior to Ansible 2.7.10, using before and after in combination did the opposite of what was intended. # see https://github.com/ansible/ansible/issues/31354 for details. - name: Replace between the expressions (requires Ansible >= 2.4)   ansible.builtin.replace:     path: /etc/hosts     after: '<VirtualHost [*]>'     before: '</VirtualHost>'     regexp: '^(.+)$'     replace: '# \1'  - name: Supports common file attributes   ansible.builtin.replace:     path: /home/jdoe/.ssh/known_hosts     regexp: '^old\.host\.name[^\n]*\n'     owner: jdoe     group: jdoe     mode: '0644'  - name: Supports a validate command   ansible.builtin.replace:     path: /etc/apache/ports     regexp: '^(NameVirtualHost|Listen)\s+80\s*$'     replace: '\1 127.0.0.1:8080'     validate: '/usr/sbin/apache2ctl -f %s -t'  - name: Short form task (in ansible 2+) necessitates backslash-escaped sequences   ansible.builtin.replace: path=/etc/hosts regexp='\\b(localhost)(\\d*)\\b' replace='\\1\\2.localdomain\\2 \\1\\2'  - name: Long form task does not   ansible.builtin.replace:     path: /etc/hosts     regexp: '\b(localhost)(\d*)\b'     replace: '\1\2.localdomain\2 \1\2'  - name: Explicitly specifying positional matched groups in replacement   ansible.builtin.replace:     path: /etc/ssh/sshd_config     regexp: '^(ListenAddress[ ]+)[^\n]+$'     replace: '\g<1>0.0.0.0'  - name: Explicitly specifying named matched groups   ansible.builtin.replace:     path: /etc/ssh/sshd_config     regexp: '^(?P<dctv>ListenAddress[ ]+)(?P<host>[^\n]+)$'     replace: '#\g<dctv>\g<host>\n\g<dctv>0.0.0.0'

Authors

  • Evan Kaufman (@EvanK)

Comments

Post a Comment

Popular posts from this blog

Chemistry - Bond Angles In NH3 And NCl3

Answer : Solution 1: As Tan Yong Boon stated, it is Bent’s Rule with which we can explain the lower bond angle of \ce N F 3 \ce{NF3} \ce NF 3 when compared to \ce N H 3 \ce{NH3} \ce N H 3 . The rule as stated by Henry Bent: Atomic s character concentrates in orbitals directed towards electropositive substituents. Fluorine is more electronegative that hydrogen, and the \ce N − F \ce{N−F} \ce N − F bond would have greater p character than the \ce N − H \ce{N−H} \ce N − H bond. And more s character leads to large bond angles. Thus, the bond angle is greater in \ce N H 3 \ce{NH3} \ce N H 3 than in \ce N F 3 \ce{NF3} \ce NF 3 . Now, consider \ce N C l 3 \ce{NCl3} \ce NCl 3 . Clearly, \ce C l \ce{Cl} \ce Cl atom islarger in size than the central atom, nitrogen. Hence the higher bond angle here is due to the steric crowding caused by \ce C l \ce{Cl} \ce Cl atoms.(More pronounced than the electrongativity of \ce C l \ce{Cl} \ce Cl atom). They repel eachother and hence b
Read more

Are Regular VACUUM ANALYZE Still Recommended Under 9.1?

Answer : VACUUM is only needed on updated or deleted rows in non-temporary tables. Obviously you're doing lots of INSERTs but it's not obvious from the description that you're also doing lots of UPDATEs or DELETEs. These operations can be tracked with the pg_stat_all_tables view, specifically the n_tup_upd and n_tup_del columns. Also, even more to the point, there is a n_dead_tup column that tells, per table, how much rows need to be vacuumed. (see Monitoring statistics in the doc for functions and views related to statistics gathering). A possible strategy in your case would be to suppress the scheduled VACUUM, keeping an eye on this view and checking on which tables the n_dead_tup is going up significantly. Then apply the aggressive VACUUM to these tables only. This will be a win if there are large tables whose rows never get deleted nor updated and the aggressive VACUUM is really necessary only on smaller tables. But keep running the ANALYZE for the optimiz
Read more

Can Feynman Diagrams Be Used To Represent Any Perturbation Theory?

Answer : Diagram machinery works also for perturbation theory in classical statistical mechanics and classical field theories. Generally, various kinds of diagrams constitute a pictorial way of talking about tensor products and their contractions while hiding the multi-linear algebra from the layman. In the simplest case, vertices (or blobs) represent vectors, matrices, tensors; vertices have ingoing and/or outgoing ports; ingoing ports denote (contravariant) ro indices; outgoing ports denote (covariant) co indices; directed arcs between blobs give a pair of equal indices summed over; different base spaces ⇔ \Leftrightarrow ⇔ different arc types; symmetric tensors ⇔ \Leftrightarrow ⇔ undirected diagrams; no labels are needed for internal lines. In many cases, the directed arcs are decorated (as thin, thick, broken,wavy, curly lines), each decoration indicating the presence of a so-called propagator, a function of its label to use as a weight in the sum, which may beco
Read more