Ansible—— 6. blockinfile模块

blockinfile 模块在指定的文件中插入”一段文本”，这段文本是被标记过的，也就是，在这段文本上做了记号，以便在以后的操作中可以通过”标记”找到这段文本，然后修改或者删除它。

1. 参数

path：required，指定要操作的文件。
block：指定要操作的”一段文本”，此参数有一个别名叫”content”，使用content或block的作用是相同的。
marker：在指定文件中插入一段文本，ansible会自动为这段文本添加两个标记，一个开始标记，一个结束标记，默认情况下，开始标记为# BEGIN ANSIBLE MANAGED BLOCK，结束标记为# END ANSIBLE MANAGED BLOCK，使用marker参数自定义”标记”。比如，marker=#{mark}test ，这样设置以后，开始标记变成了# BEGIN test，结束标记变成了# END test。
state: state参数有两个可选值，present与absent，插入和删除对应标记的段落。
insertafter：在插入一段文本时，默认会在文件的末尾插入文本，如果你想要将文本插入在某一行的后面，可以使用此参数指定对应的行，也可以使用正则表达式(python正则)，表示将文本插入在符合正则表达式的行的后面。如果有多行文本都能够匹配对应的正则表达式，则以最后一个满足正则的行为准，此参数的值还可以设置为EOF，表示将文本插入到文档末尾。
insertbefore：在插入一段文本时，默认会在文件的末尾插入文本，如果你想要将文本插入在某一行的前面，可以使用此参数指定对应的行，也可以使用正则表达式(python正则)，表示将文本插入在符合正则表达式的行的前面。如果有多行文本都能够匹配对应的正则表达式，则以最后一个满足正则的行为准，此参数的值还可以设置为BOF，表示将文本插入到文档开头。
backup：是否在修改文件之前对文件进行备份。
create：当要操作的文件并不存在时，是否创建对应的文件。

2. 示例

示例1

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local block="systemctl start mariadb\nsystemctl start httpd"' 
[root@ansible-manager ~]#cat/testdir/rc.local 
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start mariadb
systemctl start httpd
# END ANSIBLE MANAGED BLOCK

示例2

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local block="systemctl start mariadb\nsystemctl start httpd" marker="#{mark} serivce to start"'
[root@ansible-manager ~]#cat/testdir/rc.local 
#BEGIN serivce to start
systemctl start mariadb
systemctl start httpd
#END serivce to start   

示例3
在执行完上述命令的基础上，执行如下命令：

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local block="systemctl start mariadb" marker="#{mark} serivce to start"' 

因为在执行此命令时，”#{mark} serivce to start” 标记对应的文本块已经存在于文件中，而同时，block 参数对应的内容又与之前文本块的内容不同，所以，这种情况下，对应文本块中的内容会被更新，而不会再一次插入新的文本块，这种用法相当于更新原来文本块中的内容。

[root@ansible-manager ~]#cat/testdir/rc.local 
#BEGIN serivce to start
systemctl start mariadb
#END serivce to start

示例4
在执行完上述命令的基础上，执行如下命令：

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local block="" marker="#{mark} serivce to start"' 

因为在执行此命令时，”#{mark} serivce to start” 标记对应的文本块已经存在于文件中，而同时，block 参数对应的内容为空，这时，blockinfile 模块会删除对应标记的文本块，所以返回信息是 “Block removed“。
示例5

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local marker="#{mark} serivce to start" state=absent' 

使用将 state 的值设置为 absent，表示删除对应标记的文本块。
默认情况下，文本块插入在文件的尾部，我们也可以将文本块插入指定的位置，比如，插入在文件开头，或者根据正则表达式去匹配对应的行，然后将文本块插入到匹配到的行的前头或者后头。
示例6
如果想要将文本块插入到文档的开头，可以使用 insertbefore 参数，将其值设置为BOF，BOF 表示 Begin Of File：

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local block="####blockinfile test####" marker="#{mark} test" insertbefore=BOF'

示例7
如果使用如下命令，表示将文本块插入到文档的结尾，与默认操作相同，将 insertafter 参数设置为 EOF 表示 End Of File：

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local block="####blockinfile test####" marker="#{mark} test eof" insertafter=EOF'

示例8
使用如下命令表示使用正则表达式匹配行，将文本块插入到 “以#!/bin/bash开头的行” 之后：

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local block="####blockinfile test####" marker="#{mark} test reg" insertafter="^#!/bin/bash"'

示例9
使用 backup 参数，可以在操作修改文件之前，对文件进行备份，备份的文件会在原文件名的基础上添加时间戳：

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/rc.local marker="#{mark} test" state=absent backup=yes'

示例10
使用 create 参数，如果指定的文件不存在，则创建它：

[root@ansible-manager ~]# ansible host1 -m blockinfile -a 'path=/testdir/testfile3 block="test" marker="#{mark} test" create=yes'

————Blueicex 2020/2/2 17:55 blueice1980@126.com