Vh-. d dl mZ dZdZdZd dlZd dlZd dlZd dlm Z d dl
m Z m Z d dl
mZ d Zd
Zd Zed k( r e yy)
) annotationsa
---
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 O(dest), O(destfile) and O(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 V(^) and V($) 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 V(.) special character matches
any character I(except newlines). A common mistake is to assume that
a negated character set like V([^#]) will also not match newlines.
- In order to exclude newlines, they must be added to the set like V([^#\\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 V(\\1), or explicitly like V(\\g<1>).
type: str
default: ''
after:
description:
- If specified, only content after this match will be replaced/removed.
- Can be used in combination with O(before).
- Uses Python regular expressions; see
U(https://docs.python.org/3/library/re.html).
- Uses DOTALL, which means the V(.) special character I(can match newlines).
- Does not use MULTILINE, so V(^) and V($) will only match the beginning and end of the file.
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 O(after).
- Uses Python regular expressions; see
U(https://docs.python.org/3/library/re.html).
- Uses DOTALL, which means the V(.) special character I(can match newlines).
- Does not use MULTILINE, so V(^) and V($) will only match the beginning and end of the file.
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
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 O(dest) option has been changed to O(path) as default, but O(dest) still works as well.
- As of Ansible 2.7.10, the combined use of O(before) and O(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 O(ignore:follow) has been removed in Ansible 2.5, because this module modifies the contents of the file
so O(ignore:follow=no) does not 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 from the beginning 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.
# Note (?m) which turns on MULTILINE mode so ^ matches any line's beginning
- name: Replace between the expressions (requires Ansible >= 2.4)
ansible.builtin.replace:
path: /etc/hosts
after: '(?m)^'
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 t j | j \ }}t j |d }|j | |j
| j j dd }| }|rSd|vr| j d|z | j ||z \ }} }
|dk( }|dk7 r| j d|d |
|r"| j ||| j d
y y ) N)dirwbvalidatez%sz validate must contain %%s: %s)msgr zfailed to validate: rc:z error:
unsafe_writes)r ) tempfilemkstemptmpdirosfdopenwritecloseparamsget fail_json run_command atomic_move) modulecontentspathtmpfdtmpfilefr validrcouterrs G/home/dcms/DCMS/lib/python3.12/site-packages/ansible/modules/replace.py
write_changesr& s %%&--8NE7
% AGGHGGI}} T2HLE x !@H!M N ++Hw,>?S#a
7 57">
? 7D
o8VW
c | j | j }| j |d r|r|dz
}d}|dz
}||fS )NFz and Tz,ownership, perms or SE linux context changed)load_file_common_argumentsr set_file_attributes_if_different)r changedmessage file_argss r% check_file_attrsr. sN 11&--@I
..y%@ w GAA G r' c ` t t t ddg d t dd t dd t d t d t d
d t d t dd
dd } | j }|d }|d }t d }d }t |d dd |d< t |d dd |d< t |d dd |d< t |d dd |d< t j
j
| r| j dd|z t j
j | s| j d d |z n2 t |d 5 }t |j d| }d d d d}|d r|d r|d d#|d }n|d r d$|d z }n
|d rd%|d z }|rt j |t j } t j" | | }
|
r4|
j% d& } |
j' d& |
j) d& g} n"d'|z |d(< d |d)< | j* d2i | n|} t j |d t j, }
t j. |
|d d }d+ dkD rJ |d k7 rB|r |d d |d z || d+ d z |d+ f}d,|d+ z }d}| j2 r||||d d-|d.< nd}d }|r~| j4 sr|d/ r3t j
j | r| j7 | |d0< t j
j9 | }t; | t= |d |1 | t? | || \ |d(< |d)< | j* d2i | y # 1 sw Y xY w# t t f$ r5}| j d |d!t | t " Y d }~Wd }~ww xY w# t j0 $ r2}| j d*t | z t " Y d }~d }~ww xY w)3Nr T)destdestfilename)typerequiredaliasesstr)r3 r4 )r3 default)r3 boolFzutf-8)r regexpreplaceafterbeforebackupr encoding)
argument_specadd_file_common_argssupports_check_moder? r )r" r< surrogate_or_strictpassthru)errors nonstringr= r: r; zPath %s is a directory !)r" r
i zPath %s does not exist !rb)rE r? z Unable to read the contents of z: )r
exceptionz(?P.*?)z%s(?P.*)z(?P.*)%s
subsectionz@Pattern for before/after params did not match the given file: %sr
r+ z*Unable to process replace due to error: %s z%s replacements made)
before_headerr= after_headerr< diffr> backup_file)r? ) r dictr r r r isdirr existsopenreadOSErrorIOErrorr recompileDOTALLsearchgroupstartend exit_json MULTILINEsubnerror_diff
check_mode backup_localrealpathr& r r. )r r r r? res_argsr r epattern
section_rematchsectionindicesmreresultr
r+ s r% mainrp s?
6D:VWUT2eR0E"U#VU3u%ug6
"
F ]]F &>Dj!HqzHH fWo6KWabF7O vh /8MYcdF8 vh /8MYcdF8 y 1:O[efF9 ww}}TC%?$%FG
77>>$ C%?$%FG 5dD!
^Q"16684IT\]
^ G
g6(+06wAQR )F7O; )F8,<<ZZ3
*h/ kk,/G {{<0%))L2IJG `cj jHUO"'HY F (x (
**VH%r||
4C1fY /!<
ay1}F1I- {
+fQi7(71:;:OOQWXYQZ[F$vay0 <rz s[ #c
JC J
I 4X*
\!~ zF r'