Vh[< d dl mZ dZdZd dlZd dlZd dlZd dlmZ d dl m
Z
d dl m Z m
Z
d Zd Zd
Zed k( r e yy) ) annotationsa
---
module: blockinfile
short_description: Insert/update/remove a text block surrounded by marker lines
version_added: '2.0'
description:
- This module will insert/update/remove a block of multi-line text surrounded by customizable marker lines.
author:
- Yaegashi Takeshi (@yaegashi)
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: yes
aliases: [ dest, destfile, name ]
state:
description:
- Whether the block should be there or not.
type: str
choices: [ absent, present ]
default: present
marker:
description:
- The marker line template.
- C({mark}) will be replaced with the values in O(marker_begin) (default=C(BEGIN)) and O(marker_end) (default=C(END)).
- Using a custom marker without the C({mark}) variable may result in the block being repeatedly inserted on subsequent playbook runs.
- Multi-line markers are not supported and will result in the block being repeatedly inserted on subsequent playbook runs.
- A newline is automatically appended by the module to O(marker_begin) and O(marker_end).
type: str
default: '# {mark} ANSIBLE MANAGED BLOCK'
block:
description:
- The text to insert inside the marker lines.
- If it is missing or an empty string, the block will be removed as if O(state) were specified to V(absent).
type: str
default: ''
aliases: [ content ]
insertafter:
description:
- If specified and no begin/ending O(marker) lines are found, the block will be inserted after the last match of specified regular expression.
- A special value is available; V(EOF) for inserting the block at the end of the file.
- If specified regular expression has no matches or no value is passed, V(EOF) will be used instead.
- The presence of the multiline flag (?m) in the regular expression controls whether the match is done line by line or with multiple lines.
This behaviour was added in ansible-core 2.14.
type: str
insertbefore:
description:
- If specified and no begin/ending O(marker) lines are found, the block will be inserted before the last match of specified regular expression.
- A special value is available; V(BOF) for inserting the block at the beginning of the file.
- If specified regular expression has no matches, the block will be inserted at the end of the file.
- The presence of the multiline flag (?m) in the regular expression controls whether the match is done line by line or with multiple lines.
This behaviour was added in ansible-core 2.14.
type: str
create:
description:
- Create a new file if it does not exist.
type: bool
default: no
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
marker_begin:
description:
- This will be inserted at C({mark}) in the opening ansible block O(marker).
type: str
default: BEGIN
version_added: '2.5'
marker_end:
required: false
description:
- This will be inserted at C({mark}) in the closing ansible block O(marker).
type: str
default: END
version_added: '2.5'
append_newline:
required: false
description:
- Append a blank line to the inserted block, if this does not appear at the end of the file.
- Note that this attribute is not considered when C(state) is set to C(absent)
type: bool
default: no
version_added: '2.16'
prepend_newline:
required: false
description:
- Prepend a blank line to the inserted block, if this does not appear at the beginning of the file.
- Note that this attribute is not considered when C(state) is set to C(absent)
type: bool
default: no
version_added: '2.16'
notes:
- When using C(with_*) loops be aware that if you do not set a unique mark the block will be overwritten on each iteration.
- As of Ansible 2.3, the O(dest) option has been changed to O(path) as default, but O(dest) still works as well.
- 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.
- When more than one block should be handled in one file you must change the O(marker) per task.
extends_documentation_fragment:
- action_common_attributes
- action_common_attributes.files
- files
- validate
attributes:
check_mode:
support: full
diff_mode:
support: full
safe_file_operations:
support: full
platform:
support: full
platforms: posix
vault:
support: none
a6
# Before Ansible 2.3, option 'dest' or 'name' was used instead of 'path'
- name: Insert/Update "Match User" configuration block in /etc/ssh/sshd_config prepending and appending a new line
ansible.builtin.blockinfile:
path: /etc/ssh/sshd_config
append_newline: true
prepend_newline: true
block: |
Match User ansible-agent
PasswordAuthentication no
- name: Insert/Update eth0 configuration stanza in /etc/network/interfaces
(it might be better to copy files into /etc/network/interfaces.d/)
ansible.builtin.blockinfile:
path: /etc/network/interfaces
block: |
iface eth0 inet static
address 192.0.2.23
netmask 255.255.255.0
- name: Insert/Update configuration using a local file and validate it
ansible.builtin.blockinfile:
block: "{{ lookup('ansible.builtin.file', './local/sshd_config') }}"
path: /etc/ssh/sshd_config
backup: yes
validate: /usr/sbin/sshd -T -f %s
- name: Insert/Update HTML surrounded by custom markers after line
ansible.builtin.blockinfile:
path: /var/www/html/index.html
marker: ""
insertafter: ""
block: |
Welcome to {{ ansible_hostname }}
Last updated on {{ ansible_date_time.iso8601 }}
- name: Remove HTML as well as surrounding markers
ansible.builtin.blockinfile:
path: /var/www/html/index.html
marker: ""
block: ""
- name: Add mappings to /etc/hosts
ansible.builtin.blockinfile:
path: /etc/hosts
block: |
{{ item.ip }} {{ item.name }}
marker: "# {mark} ANSIBLE MANAGED BLOCK {{ item.name }}"
loop:
- { name: host1, ip: 10.10.1.10 }
- { name: host2, ip: 10.10.1.11 }
- { name: host3, ip: 10.10.1.12 }
- name: Search with a multiline search flags regex and if found insert after
blockinfile:
path: listener.ora
block: "{{ listener_line | indent(width=8, first=True) }}"
insertafter: '(?m)SID_LIST_LISTENER_DG =\n.*\(SID_LIST ='
marker: " "
N)b)
AnsibleModule)to_bytes to_nativec 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: %smsgr zfailed to validate: rc:z error:
unsafe_writes)r ) tempfilemkstemptmpdirosfdopenwritecloseparamsget fail_json run_command atomic_move) modulecontentspathtmpfdtmpfilefr validrcouterrs K/home/dcms/DCMS/lib/python3.12/site-packages/ansible/modules/blockinfile.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 )NF)diffz and Tz,ownership, perms or SE linux context changed)load_file_common_argumentsr set_file_attributes_if_different)r changedmessager) file_argss r% check_file_attrsr/ sS 11&--@I
..y%d.K w GAA G r' c t t t ddg d t ddddg t dd
t dd d g
t d t d t dd
t dd
t d t dd
t dd
t dd
t dd
ddggdd } | j }|d }t j j | r| j
dd|z t j j | }|s| j |d s| j
dd |z t j j | }|rAt j j | s"| j s t j | d }g }n6t# |d" 5 }|j% }d d d j' d }d d d#|z d#|z d$} | j( r|r|| d%< |d }
|d } t+ |d& } t+ |d' }
|d( dk( }t- t j. g}|s|s| j1 dd)|z * |
| d+} | d,vr!t3 j4 t+ | d-. }n'|
d/vr!t3 j4 t+ |
d-. }nd }t3 j6 t- d0 t- |d1 |
t- t j. z }t3 j6 t- d0 t- |d2 |
t- t j. z }|r`| r^| j9 t- t j. s | t- t j. z
} |g| j' d z |gz }ng }d x}}t; | D ] \ }}||k( r|}||k( s|} d ||fv rd }||j< t2 j> z rm|jA | }|r| r+t! | jC d3d4|jE }nT|
rRt! | jC d3d4|jG }n't; | D ] \ }}|jA | s|} | tI | }n1| /|d5z
}n)|
d4}n$tI | }n||k r g |||d5z n
g |||d5z |}|d4kD rU||d5z
j9 t- t j. s'||d5z
xx t- t j. z
cc< |d6 r3|r1|d4k7 r,||d5z
t- t j. k7 r
|||| |d5z
}|||| |d7 rB|r@|tI | z }|tI | k r$|| t- t j. k7 r|||| |rd8jK | }nd8}| j( r|| d9< ||k( rd }d} n|d:}d} n |sd;}d} nd<}d} d } | rb| j sV| j |d= r|r| jM | } t j jO |d } tQ | || | j r|s| j1 | || > i } tS | | || \ }} d?|z | d@< d?|z | dA< | | g} | | j1 | || > y | j1 | || | B y # t $ r:}| j
d |d |j d |j Y d }~Zd }~wt $ r,}| j
d |d!t! | Y d }~d }~ww xY w# 1 sw Y uxY w)CNr T)destdestfilename)typerequiredaliasesstrpresentabsent)r4 defaultchoicesz # {mark} ANSIBLE MANAGED BLOCK)r4 r: content)r4 r: r6 )r4 boolFBEGINEND)
r statemarkerblock insertafter insertbeforecreatebackupr marker_begin
marker_endappend_newlineprepend_newlinerE rD )
argument_specmutually_exclusiveadd_file_common_argssupports_check_mode zPath %s is a directory !)r" r
rF i zPath %s does not exist !zError creating z
Error code: z Error description: r z Error: rbz %s (content))beforeafter
before_header after_headerrR rC rB rA zFile %s not present)r, r
EOF)NrV surrogate_or_strict)errors)NBOFz{mark}rH rI
r rK rJ r' rS z File createdz
Block removedzBlock insertedrG )r, r
r) z%s (file attributes)rT rU )r, r
r) backup_file)*r dictr r r isdirr existsbooleandirname
check_modemakedirsOSErrorerrnostrerror Exceptionr openread
splitlines_diffr r linesep exit_jsonrecompilesubendswith enumerateflags MULTILINEsearchcountendstartlenjoin backup_localrealpathr& r/ )!r r r path_existsdestpatheoriginallinesr r) rE rD rC rB r8
blank_lineinsertremarker0marker1
blocklinesn0n1ilinematchline_after_blockresultr
r, r\ real_path attr_diffdifflists! r% mainr s$
6D:VWE9x>STU,LME2 {C %( 5)VU3VU3u% 5':6 VU; fe <
,] ;< ! %F( ]]F &>D ww}}TC 7$ > @ ''..&K ~~fX ./ !;d!B
D77??4( BGGNN8 4V=N=N
_ H%
$
vvxH ##D) +d 2 *T 1 3D
||!X.)L 'K VG_ %E
fX&
'FWo*GBJJ- J ;,AD,HI 3 -'::h{;P QR ] *::h|>&* + --d3KGG$$VF^4 ffi0
c=I#FGS)DLC!7$!>Io 6 =In i HcAckZo
A aiklkrkrtut~t~% A A
_ hPYZ[P\%] ^^
_
s0 [ ] ]/\
]!\==]]__main__)
__future__r
DOCUMENTATIONEXAMPLESrn r r ansible.module_utils.sixr ansible.module_utils.basicr +ansible.module_utils.common.text.convertersr r r& r/ r __name__ r' r% r sV #v
p< |
& 4 KX*
|[~ zF r'