11-Ansible常用模块-blockinfile模块

最新推荐文章于 2023-06-03 20:57:56 发布

qq_41417660

最新推荐文章于 2023-06-03 20:57:56 发布

阅读量759

点赞数

分类专栏： Ansible

本文链接：https://blog.csdn.net/qq_41417660/article/details/113965345

版权

Ansible 专栏收录该内容

27 篇文章 4 订阅

订阅专栏

一、概述

blockinfile 模块可以帮助我们在指定的文件中插入”一段文本”，这段文本是被标记过的，也就是，我们在这段文本上做了记号，以便在以后的操作中可以通过”标记”找到这段文本，然后修改或者删除它。单单这样描述不是特别容易理解，结合后面的示例动手做做立马就能明白了。

二、常用参数

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

三、示例

1、在all主机中的 /test/t2.txt件尾部插入如下两行：

[root@CentOSB ~]# cat t2.txt   
AAA
ccc

[root@Ansible ~]#  ansible all -m blockinfile -a 'path=/root/t2.txt block="systemctl start nginx\nsystemctl start httpd"'                                   
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}

查看t2.txt文件：

[root@CentOSB ~]# cat t2.txt 
AAA
ccc
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start nginx
systemctl start httpd
# END ANSIBLE MANAGED BLOCK

blockinfile 模块的作用就是在文件中添加、更新、或者删除”被标记的文本块”。

BEGIN ANSIBLE MANAGED BLOCK 一个是开始标记
END ANSIBLE MANAGED BLOCK 就是 blockinfile 一个是结束标记。
模块自动为我们添加的文本块标记。

2、自定义标记，但是自定义的标记仍然要”成对出现”，需要有开始标记和结束标记

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t2.txt block="systemctl start nginx\nsystemctl start httpd" marker="#{mark} serivce to start"'    
192.168.0.160 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}

{mark}” 会自动被替换成开始标记中的”BEGIN” 和结束标记中的 “END”，如果文件中不存在同名标记的文本块，那么文件的末尾将会出现如下文本块：

[root@CentOSB ~]# cat t2.txt 
AAA
ccc
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start nginx
systemctl start httpd
# END ANSIBLE MANAGED BLOCK
#BEGIN serivce to start
systemctl start nginx
systemctl start httpd
#END serivce to start

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

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t2.txt block="systemctl start mariadb" marker="#{mark} serivce to start"'                                 
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}
192.168.0.160 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}

[root@CentOSB ~]# cat t2.txt 
AAA
ccc
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start nginx
systemctl start httpd
# END ANSIBLE MANAGED BLOCK
#BEGIN serivce to start
systemctl start mariadb
#END serivce to start

3、执行此命令时，”#{mark} serivce to start” 标记对应的文本块已经存在于文件中，而同时，block 参数对应的内容为空，这时，blockinfile 模块会删除对应标记的文本块，所以返回信息是 “Block removed“。我们还可以使用如下命令删除对应的文本块，它们的效果是相同的：

测试文件：

[root@CentOSB ~]# cat t2.txt 
AAA
ccc
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start nginx
systemctl start httpd
# END ANSIBLE MANAGED BLOCK
#BEGIN serivce to start
systemctl start mariadb
#END serivce to start

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t2.txt block="" marker="#{mark} serivce to start"'                            
192.168.0.160 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block removed"
}
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block removed"
}

[root@CentOSB ~]# cat t2.txt 
AAA
ccc
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start nginx
systemctl start httpd
# END ANSIBLE MANAGED BLOCK

使用将 state 的值设置为 absent，表示删除对应标记的文本块。

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t2.txt marker="#{mark} serivce to start" state=absent'

4、默认情况下，文本块插入在文件的尾部，我们也可以将文本块插入指定的位置，比如，插入在文件开头，或者根据正则表达式去匹配对应的行，然后将文本块插入到匹配到的行的前头或者后头。

测试文件：

[root@CentOSB ~]# cat t2.txt 
AAA
ccc
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start nginx
systemctl start httpd
# END ANSIBLE MANAGED BLOCK

将文本块插入到文档的开头，可以使用 insertbefore 参数，将其值设置为BOF，BOF 表示 Begin Of File：

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t2.txt block="####blockinfile test####" marker="#{mark} test" insertbefore=BOF'
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}
192.168.0.160 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}

[root@CentOSB ~]# cat t2.txt 
#BEGIN test
####blockinfile test####
#END test
AAA
ccc
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start nginx
systemctl start httpd
# END ANSIBLE MANAGED BLOCK

表示将文本块插入到文档的结尾，与默认操作相同，将 insertafter 参数设置为 EOF 表示 End Of File：

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t2.txt block="####blockinfile test####" marker="#{mark} test eof" insertafter=EOF'
192.168.0.160 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}

[root@CentOSB ~]# cat t2.txt 
#BEGIN test
####blockinfile test####
#END test
AAA
ccc
# BEGIN ANSIBLE MANAGED BLOCK
systemctl start nginx
systemctl start httpd
# END ANSIBLE MANAGED BLOCK
#BEGIN test eof
####blockinfile test####
#END test eof

5、使用正则表达式匹配行，将文本块插入到 “以#!/bin/bash开头的行” 之后：

测试文件：

[root@CentOSB ~]# cat t3.txt 
#!/bin/bash
echo "test"

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t3.txt block="####blockinfile test####" marker="#{mark} test reg" insertafter="^#!/bin/bash"'
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block inserted"
}

[root@CentOSB ~]# cat t3.txt 
#!/bin/bash
#BEGIN test reg
####blockinfile test####
#END test reg
echo "test"

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

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t3.txt  marker="#{mark} test reg" state=absent backup=yes'                                   
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "Block removed"
}

[root@CentOSB ~]# cat t3.txt
#!/bin/bash
echo "test"
[root@CentOSB ~]# cat t3.txt.102918.2021-02-24@16\:04\:01~ 
#!/bin/bash
#BEGIN test reg
####blockinfile test####
#END test reg
echo "test"

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

[root@Ansible ~]# ansible all -m blockinfile -a 'path=/root/t4.txt block="test" marker="#{mark} test" create=yes'
192.168.0.160 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "File created"
}
192.168.0.161 | CHANGED => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/libexec/platform-python"
    },
    "changed": true,
    "msg": "File created"
}

[root@CentOSB ~]# cat t4.txt 
#BEGIN test
test
#END test

qq_41417660

关注

0
点赞
踩
4

收藏

觉得还不错? 一键收藏
0
评论
11-Ansible常用模块-blockinfile模块

一、概述blockinfile 模块可以帮助我们在指定的文件中插入”一段文本”，这段文本是被标记过的，也就是，我们在这段文本上做了记号，以便在以后的操作中可以通过”标记”找到这段文本，然后修改或者删除它。单单这样描述不是特别容易理解，结合后面的示例动手做做立马就能明白了。二、常用参数path参数：必须参数，指定要操作的文件。block参数：此参数用于指定我们想要操作的那”一段文本”，此参数有一个别名叫”content”，使用content或block的作用是相同的。marker参数：
复制链接

扫一扫

专栏目录