a
)g, @ s d dl mZmZmZ eZdZdZdZd dl Z d dl
Z
d dl Z d dl m
Z
d dlmZmZ d dlmZ d d
Zd d Zd
d Zedkre dS ) )absolute_importdivisionprint_functiona
---
module: replace
author: Evan Kaufman (@EvanK)
extends_documentation_fragment:
- action_common_attributes
- action_common_attributes.files
- files
- validate
attributes:
check_mode:
support: full
diff_mode:
support: full
platform:
platforms: posix
safe_file_operations:
support: full
vault:
support: none
short_description: Replace all instances of a particular string in a
file using a back-referenced regular expression
description:
- 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.
version_added: "1.6"
options:
path:
description:
- The file to modify.
- Before Ansible 2.3 this option was only usable as I(dest), I(destfile) and I(name).
type: path
required: true
aliases: [ dest, destfile, name ]
regexp:
description:
- The regular expression to look for in the contents of the file.
- Uses Python regular expressions; see
U(https://docs.python.org/3/library/re.html).
- Uses MULTILINE mode, which means C(^) and C($) match the beginning
and end of the file, as well as the beginning and end respectively
of I(each line) of the file.
- Does not use DOTALL, which means the C(.) special character matches
any character I(except newlines). A common mistake is to assume that
a negated character set like C([^#]) will also not match newlines.
- In order to exclude newlines, they must be added to the set like C([^#\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.
type: str
required: true
replace:
description:
- 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 C(\1), or explicitly like C(\g<1>).
type: str
after:
description:
- If specified, only content after this match will be replaced/removed.
- Can be used in combination with C(before).
- Uses Python regular expressions; see
U(https://docs.python.org/3/library/re.html).
- Uses DOTALL, which means the C(.) special character I(can match newlines).
type: str
version_added: "2.4"
before:
description:
- If specified, only content before this match will be replaced/removed.
- Can be used in combination with C(after).
- Uses Python regular expressions; see
U(https://docs.python.org/3/library/re.html).
- Uses DOTALL, which means the C(.) special character I(can match newlines).
type: str
version_added: "2.4"
backup:
description:
- Create a backup file including the timestamp information so you can
get the original file back if you somehow clobbered it incorrectly.
type: bool
default: no
others:
description:
- All arguments accepted by the M(ansible.builtin.file) module also work here.
type: str
encoding:
description:
- The character encoding for reading and writing the file.
type: str
default: utf-8
version_added: "2.4"
notes:
- As of Ansible 2.3, the I(dest) option has been changed to I(path) as default, but I(dest) still works as well.
- As of Ansible 2.7.10, the combined use of I(before) and I(after) works properly. If you were relying on the
previous incorrect behavior, you may be need to adjust your tasks.
See U(https://github.com/ansible/ansible/issues/31354) for details.
- Option I(follow) has been removed in Ansible 2.5, because this module modifies the contents of the file so I(follow=no) doesn't make sense.
a
- name: Replace old hostname with new hostname (requires Ansible >= 2.4)
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: ''
before: ''
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: '^(?PListenAddress[ ]+)(?P[^\n]+)$'
replace: '#\g\g\n\g0.0.0.0'
#N)
format_exc)to_textto_bytes)
AnsibleModulec C s t j| jd\}}t|d}|| | | jdd }| }|rd|vr`| j d| d |
|| \}} }
|dk}|dkr| j d||
f d |r| j ||| jd d
d S ) N)dirwbvalidatez%sz validate must contain %%s: %s)msgr z"failed to validate: rc:%s error:%s
unsafe_writes)r ) tempfileZmkstempZtmpdirosfdopenwritecloseparamsget fail_jsonZ run_commandZ atomic_move) modulecontentspathZtmpfdZtmpfilefr Zvalidrcouterr r ;/usr/lib/python3.9/site-packages/ansible/modules/replace.py
write_changes s"
r c C s8 | | j}| |dr0|r$|d7 }d}|d7 }||fS )NFz and Tz,ownership, perms or SE linux context changed)Zload_file_common_argumentsr Z set_file_attributes_if_different)r changedmessageZ file_argsr r r check_file_attrs s r# c
C s t ttddg ddtdddtdddtdd tdd td
d dtdd tdd dd
ddd} | j}|d }|d }tdd}t|d ddd|d< t|d ddd|d< t|d ddd|d< t|d ddd|d< tj|r| jdd| d tj|s| jd d | d nzBt |d "}t|
d|d }W d n1 sP0 Y W nF t t fy } z(| jd |t|f t
d! W Y d }~n
d }~0 0 d}|d r|d rd"|d |d f }n.|d rd#|d }n|d r d$|d }|rlt|tj} t| |}
|
rF|
d%} |
d%|
d%g} n$d&| |d'< d |d(< | jf i | n|} t|d tj}
t|
|d | d}|d) dkr| |d kr|r|d | d |d || d) d |d) f}d*|d) }d}| jr ||||d d+|d,< nd}d }|rx| jsx|d- rTtj|rT| ||d.< tj|}t | t |d |d/| t | ||\|d'< |d(< | jf i | d S )0Nr T)destZdestfilename)typerequiredaliasesstr)r& r' )r& default)r& boolFzutf-8)r regexpreplaceafterbeforebackupr encoding)Z
argument_specZadd_file_common_argsZsupports_check_moder2 r )r r/ Zsurrogate_or_strictZpassthru)errorsZ nonstringr0 r- r. zPath %s is a directory !)r r
i zPath %s does not exist !rb)r3 r2 z%Unable to read the contents of %s: %s)r
exceptionz%s(?P.*?)%sz%s(?P.*)z(?P.*)%sZ
subsectionz@Pattern for before/after params did not match the given file: %sr
r! z%s replacements made)Z
before_headerr0 Z after_headerr/ diffr1 Z backup_file)r2 ) r dictr r r r isdirr existsopenreadOSErrorIOErrorr recompileDOTALLsearchgroupstartendZ exit_json MULTILINEsubnZ_diffZ
check_modeZ backup_localrealpathr r r# )r r r r2 Zres_argsr r epatternZ
section_rematchsectionindicesZmreresultr
r! r r r main s
6
0 rP __main__)Z
__future__r r r r& Z
__metaclass__Z
DOCUMENTATIONZEXAMPLESZRETURNr r@ r tracebackr Zansible.module_utils._textr r Zansible.module_utils.basicr r r# rP __name__r r r r s eD
Z