Ansible（四）-- ansible中常用模块之文件操作--copy模块、file模块、blockinfile模块、lineinfile模块

客官°小女子只卖身不卖艺 2023-07-17 15:40 3阅读 0赞

### ansible中 常用模块之文件操作 ###

*  一、copy模块
 *   *  模块介绍
     *  模块参数
     *  模块示例
 *  二、file模块
 *   *  模块介绍
     *  模块参数
     *  模块示例
 *  三、blockinfile模块
 *   *  模块介绍
     *  模块参数
     *  模块示例
 *  四、lineinfile模块
 *   *  模型介绍
     *  模型参数
     *  模型示例

# 一、copy模块 #

## 模块介绍 ##

见名知义，copy模块的作用就是拷贝文件，它与之前介绍的fetch模块类似，不过，fetch模块是从远程主机中拉取文件到ansible主机，而copy模块是将ansible主机上的文件拷贝到远程主机中。

## 模块参数 ##

此处我们介绍一些copy模块的常用参数，然后再给出对应示例。

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>src参数</td> 
   <td>用于指定需要copy的文件或目录</td> 
  </tr> 
  <tr> 
   <td>dest参数</td> 
   <td>用于指定文件将被拷贝到远程主机的哪个目录中，dest为必须参数</td> 
  </tr> 
  <tr> 
   <td>content参数</td> 
   <td>当不使用src指定拷贝的文件时，可以使用content直接指定文件内容，src与content两个参数必有其一，否则会报错。</td> 
  </tr> 
  <tr> 
   <td>force参数</td> 
   <td>当远程主机的目标路径中已经存在同名文件，并且与ansible主机中的文件内容不同时，是否强制覆盖，可选值有yes和no，默认值为yes，表示覆盖，如果设置为no，则不会执行覆盖拷贝操作，远程主机中的文件保持不变。</td> 
  </tr> 
  <tr> 
   <td>backup参数</td> 
   <td>当远程主机的目标路径中已经存在同名文件，并且与ansible主机中的文件内容不同时，是否对远程主机的文件进行备份，可选值有yes和no，当设置为yes时，会先备份远程主机中的文件，然后再将ansible主机中的文件拷贝到远程主机。</td> 
  </tr> 
  <tr> 
   <td>owner参数</td> 
   <td>指定文件拷贝到远程主机后的属主，但是远程主机上必须有对应的用户，否则会报错。</td> 
  </tr> 
  <tr> 
   <td>group参数</td> 
   <td>指定文件拷贝到远程主机后的属组，但是远程主机上必须有对应的组，否则会报错。</td> 
  </tr> 
  <tr> 
   <td>mode参数</td> 
   <td>指定文件拷贝到远程主机后的权限，如果你想将权限设置为"rw-r–r--"，则可以使用mode=0644表示，如果你想要在user对应的权限位上添加执行权限，则可以使用mode=u+x表示。</td> 
  </tr> 
 </tbody> 
</table>

## 模块示例 ##

对应上述参数的ad-hoc示例命令如下：

将ansible主机中/testdir/copytest文件复制到远程主机的/opt目录下，注意，如果copytest文件已经存在于远程主机的/opt目录中，并且远程主机中的copytest与ansible主机中copytest文件内容不同，那么使用如下命令时，远程主机中的copytest文件将被覆盖。

在server4中只执行：

ansible testB -m copy -a "src=/testdir/copytest dest=/opt/"

![在这里插入图片描述][20200322213120788.png]上图可以看出内容已经被覆盖

在远程主机的/opt目录下生成文件test，test文件中有两行文本，第一行文本为aaa，第二行为bbb，当使用content指定文件内容时，dest参数对应的值必须是一个文件，而不能是一个路径。

ansible testB -m copy -a 'content="aaa\nbbb\n" dest=/opt/test'

![在这里插入图片描述][20200322213234856.png]

将ansible主机中/testdir/copytest文件复制到远程主机的/opt目录中时，如果远程主机中已经存在/opt/copytest文件，并且文件内容与ansible主机中的copytest文件的内容不一致，则不执行拷贝操作，远程主机中的/opt/copytest文件内容不会被改变。

ansible testB -m copy -a "src=/testdir/copytest dest=/opt/ force=no"

![在这里插入图片描述][20200322213451896.png]

将ansible主机中/testdir/copytest文件复制到远程主机的/opt目录中时，如果远程主机中已经存在/opt/copytest文件，并且文件内容与ansible主机中的copytest文件的内容不一致，会执行拷贝操作，但是在执行拷贝操作之前，会将远程主机中的原文件重命名，以作备份，然后再进行拷贝操作。

ansible testB -m copy -a "src=/testdir/copytest dest=/opt/ backup=yes"

![在这里插入图片描述][20200322213604608.png]

拷贝文件时，指定文件的属主，需要注意，远程主机上必须存在对应的用户。

ansible testB -m copy -a "src=/testdir/westos dest=/opt/ owner=cl"

![在这里插入图片描述][20200322213646803.png]  
![在这里插入图片描述][20200322213721794.png]如果拷贝的文件在目标主机存在且相同时，只会更改文件所属用户：  
![在这里插入图片描述][20200322213901293.png]执行：

ansible testB -m copy -a "src=/testdir/copytest dest=/opt owner=cl"

执行后：  
![在这里插入图片描述][20200322214002666.png]

拷贝文件时，指定文件的属组，需要注意，远程主机上必须存在对应的组。

ansible testB -m copy -a "src=/testdir/copytest dest=/opt/ group=cl"

执行后：  
![在这里插入图片描述][20200322214106956.png]

拷贝文件时，指定文件的权限

ansible testB -m copy -a "src=/testdir/pp dest=/opt mode=0640"

执行后：  
![在这里插入图片描述][20200322214156888.png]当目标文件存在且相同时，只会更改权限：  
执行前：  
![在这里插入图片描述][20200322214245375.png]  
执行：

ansible testB -m copy -a "src=/testdir/copytest dest=/opt mode=0640"

执行后：  
![在这里插入图片描述][20200322214344740.png]可以看出权限已经更改为0640。

# 二、file模块 #

## 模块介绍 ##

file模块可以帮助我们完成一些对文件的基本操作，比如，**创建文件或目录、删除文件或目录、修改文件权限等**

## 模块参数 ##

此处我们介绍一些file模块的常用参数，然后再给出对应示例。

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th align="left">含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>path参数</td> 
   <td align="left"><strong>必须参数，用于指定要操作的文件或目录</strong>，在之前版本的ansible中，使用dest参数或者name参数指定要操作的文件或目录，为了兼容之前的版本，使用dest或name也可以。</td> 
  </tr> 
  <tr> 
   <td>state参数</td> 
   <td align="left">此参数非常灵活，此参数对应的值需要根据情况设定，比如，当我们需要在远程主机中创建一个目录的时候，我们需要使用path参数指定对应的目录路径，假设，我想要在远程主机上创建/testdir/a/b目录，那么我则需要设置path=/testdir/a/b，但是，我们无法从"/testdir/a/b"这个路径看出b是一个文件还是一个目录，ansible也同样无法单单从一个字符串就知道你要创建文件还是目录，所以，我们需要通过state参数进行说明，<strong>当我们想要创建的/testdir/a/b是一个目录时，需要将state的值设置为directory</strong>，"directory"为目录之意，当它与path结合，ansible就能知道我们要操作的目标是一个目录，同理，<strong>当我们想要操作的/testdir/a/b是一个文件时，则需要将state的值设置为touch</strong>，<strong>当我们想要创建软链接文件时，需将state设置为link</strong>，<strong>想要创建硬链接文件时，需要将state设置为hard</strong>，<strong>当我们想要删除一个文件时（删除时不用区分目标是文件、目录、还是链接），则需要将state的值设置为absent</strong>，"absent"为缺席之意，当我们想让操作的目标"缺席"时，就表示我们想要删除目标。</td> 
  </tr> 
  <tr> 
   <td>src参数</td> 
   <td align="left">当state设置为link或者hard时，表示我们想要创建一个软链或者硬链，所以，我们必须指明软链或硬链链接的哪个文件，通过src参数即可指定链接源 。</td> 
  </tr> 
  <tr> 
   <td>force参数</td> 
   <td align="left"><strong>当state=link的时候，可配合此参数强制创建链接文件</strong>，当force=yes时，表示强制创建链接文件，不过强制创建链接文件分为两种情况，情况一：当你要创建的链接文件指向的源文件并不存在时，使用此参数，可以先强制创建出链接文件。情况二：当你要创建链接文件的目录中已经存在与链接文件同名的文件时，将force设置为yes，会将同名文件覆盖为链接文件，相当于删除同名文件，创建链接文件。情况三：当你要创建链接文件的目录中已经存在与链接文件同名的文件，并且链接文件指向的源文件也不存在，这时会强制替换同名文件为链接文件。</td> 
  </tr> 
  <tr> 
   <td>owner参数</td> 
   <td align="left">用于<strong>指定被操作文件的属主</strong>，<strong>属主对应的用户必须在远程主机中存在</strong>，否则会报错。</td> 
  </tr> 
  <tr> 
   <td>group参数</td> 
   <td align="left">用于<strong>指定被操作文件的属组，属组对应的组必须在远程主机中存在</strong>，否则会报错。</td> 
  </tr> 
  <tr> 
   <td>mode参数</td> 
   <td align="left"><strong>用于指定被操作文件的权限</strong>，比如，如果想要将文件权限设置为"rw-r-x—"，则可以使用mode=650进行设置，或者使用mode=0650，效果也是相同的，如果你想要设置特殊权限，比如为二进制文件设置suid，则可以使用mode=4700，很方便吧。</td> 
  </tr> 
  <tr> 
   <td>recurse参数</td> 
   <td align="left">当要操作的文件为目录，将recurse设置为yes，可以<strong>递归的修改目录中文件的属性</strong>。</td> 
  </tr> 
 </tbody> 
</table>

## 模块示例 ##

对应上述参数的ad-hoc示例命令如下：

在testB（server3）主机上创建一个名为westos的文件，如果testfile文件已经存在，则会更新文件的时间戳，与touch命令的作用相同。

在server4：

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/westos state=touch"

结果：  
![在这里插入图片描述][20200323120200696.png]当远程主机中文件已经从在再次执行命令依然会成功，会修改远程主机文件的时间戳：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70]![在这里插入图片描述][20200323120438843.png]  
在testB（server3）主机上创建一个名为westosdir的目录，如果westosdir目录已经存在，则不进行任何操作。

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/westosdir state=directory"

结果：  
![在这里插入图片描述][20200323121057196.png]当目录已经存在时：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 1]![在这里插入图片描述][20200323121213430.png]

在testB（server3）上为westos文件创建软链接文件，软链接名为linkwestos，执行下面命令的时候，westos已经存在。

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/linkwestos state=link src=/testdir/westos"

结果：  
![在这里插入图片描述][20200323121344559.png]

在testB（server3）上为westos文件创建硬链接文件，硬链接名为hardwestos，执行下面命令的时候，westos已经存在。

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/hardwestos state=hard src=/testdir/westos"

![在这里插入图片描述][20200323121635481.png]

在创建链接文件时，如果源文件不存在，或者链接文件与其他文件同名时，强制覆盖同名文件或者创建链接文件，参考上述force参数的解释。  
源文件不存在并且链接文件与其他文件同名：

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/linkwestos state=link src=westos-cl force=yes"

结果：  
![在这里插入图片描述][20200323121837425.png]

删除远程机器上的指定文件或目录

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/linkwestos state=absent"

![在这里插入图片描述][20200323121944407.png]

在创建文件或目录的时候指定属主，或者修改远程主机上的文件或目录的属主。

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/a state=touch owner=cl"

结果：

![在这里插入图片描述][20200323122141733.png]

在创建文件或目录的时候指定属组，或者修改远程主机上的文件或目录的属组。

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/b state=touch group=cl"

结果：  
![在这里插入图片描述][20200323122314964.png]当文件存在时只修改属组：

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/a state=touch group=cl"

![在这里插入图片描述][20200323122432554.png]  
指定目录的属组：

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/c state=directory group=cl"

![在这里插入图片描述][2020032312254884.png]修改目录的属主：

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/c state=directory owner=cl"

![在这里插入图片描述][20200323122646868.png]

在创建文件或目录的时候指定权限，或者修改远程主机上的文件或目录的权限。

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/c mode=666"

![在这里插入图片描述][20200323122822649.png]

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/d state=directory mode=0644"

![在这里插入图片描述][20200323122930272.png]指定特殊权限：

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/d state=directory mode=4700"

![在这里插入图片描述][20200323123020287.png]

当操作远程主机中的目录时，同时递归的创建目录并将目录中的文件的属主属组都设置为cl。

[root@server4 testdir]# ansible testB -m file -a "path=/testdir/1/2 state=directory owner=cl group=cl recurse=yes"

![在这里插入图片描述][20200323123146323.png]

# 三、blockinfile模块 #

## 模块介绍 ##

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

## 模块参数 ##

此处我们介绍一些blockinfile模块的常用参数，你可以先对这些参数有一个大概了解，然后再看小示例。

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

## 模块示例 ##

对应上述参数的ad-hoc示例命令如下：

为了方便举例，我们将/etc/rc.d/rc.local文件复制到/testdir目录中，以做测试  
![在这里插入图片描述][20200323160336736.png]

假如，我们想要在testB(server3)主机中的/testdir/rc.local文件尾部插入如下两行

systemctl start mariadb
    systemctl start nfs

可以使用如下命令:

[root@server4 testdir]# ansible testB -m blockinfile -a 'path=/testdir/rc.local block="systemctl start mariadb\nsystemctl start nfs"'

使用path参数指定要操作的文件，使用block参数指定文本块内容，由于我们使用了ad-hoc命令，所以我们使用\\n表示换行，在写ansible剧本时则可以直接将文本块写在多行中，但是我们还没有介绍剧本的编写，所以此处不用在意，当执行上述命令后，/testdir/rc.local的文件尾部会多出如下文本块：

# BEGIN ANSIBLE MANAGED BLOCK
    systemctl start mariadb
    systemctl start nfs
    # END ANSIBLE MANAGED BLOCK

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 2]

正如之前所说，blockinfile模块的作用就是在文件中添加、更新、或者删除"被标记的文本块"，而上述被标记的文本块就是我们添加进文件的，**\# BEGIN ANSIBLE MANAGED BLOCK 和 \# END ANSIBLE MANAGED BLOCK 就是blockinfile模块自动为我们添加的文本块标记，一个是开始标记，一个是结束标记。**

我们也可以**自定义标记**，但是自定义的标记仍然要"成对出现"，需要有开始标记和结束标记，示例如下

[root@server4 testdir]# ansible testB -m blockinfile -a 'path=/testdir/rc.local block="systemctl start mariadb\nsystemctl start nfs" marker="#{mark} service to start"'

使用marker可以自定义文本块的标记， 上例中的"\{mark\}" 会自动被替换成开始标记中的"BEGIN" 和结束标记中的 “END”，如果文件中不存在同名标记的文本块，那么文件的末尾将会出现如下文本块。

#BEGIN serivce to start
    systemctl start mariadb
    systemctl start nfs
    #END serivce to start

![在这里插入图片描述][20200323160904955.png]  
在执行完上述命令的基础上，执行如下命令

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

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

#BEGIN serivce to start
    systemctl start mariadb
    #END serivce to start

![在这里插入图片描述][20200323161027880.png]  
在执行完上述命令的基础上，执行如下命令

[root@server4 testdir]# ansible testB -m blockinfile -a 'path=/testdir/rc.local block="" marker="#{mark} service to start"'

因为在执行此命令时，"\#\{mark\} serivce to start"标记对应的文本块已经存在于文件中，而同时，block参数对应的内容为空，这时，blockinfile模块会删除对应标记的文本块，我们还可以使用如下命令删除对应的文本块，它们的效果是相同的。

[root@server4 testdir]# ansible testB -m blockinfile -a 'path=/testdir/rc.local marker="#{mark} service to start" state=absent'

![在这里插入图片描述][20200323161141473.png]  
是的，使用将state的值设置为absent，表示删除对应标记的文本块

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

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

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

![在这里插入图片描述][20200323161300805.png]

如果使用如下命令，表示将文本块插入到文档的结尾，与默认操作相同，将insertafter参数设置为EOF表示End Of File，注意：做这个示例的时候需要将上个示例插入在开头的三行内容删除，否则由于幂等性，文件内容不会改变。

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

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 3]结果：  
![在这里插入图片描述][20200323161545676.png]

使用如下命令表示使用正则表达式匹配行，将文本块插入到 “以\#!/bin/bash开头的行” 之后（同样需要将上个示例的内容删除）

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

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 4]

![在这里插入图片描述][20200323161642641.png]

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

[root@server4 testdir]# ansible testB -m blockinfile -a 'path=/testdir/rc.local block="#######blockinfile test#####test ####" marker="#{mark} test" insertafter="^#!/bin/bash" backup=yes'

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 5]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 6]![在这里插入图片描述][20200323161956377.png]  
![在这里插入图片描述][20200323162040111.png]

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

[root@server4 testdir]# ansible testB -m blockinfile -a 'path=/testdir/test block="###test!!!!" marker="#{mark} test" create=yes'

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 7]![在这里插入图片描述][20200323162152421.png]

# 四、lineinfile模块 #

## 模型介绍 ##

我们可以借助lineinfile模块，**确保"某一行文本"存在于指定的文件中，或者确保从文件中删除指定的"文本"（即确保指定的文本不存在于文件中），还可以根据正则表达式，替换"某一行文本"。**

## 模型参数 ##

此处我们介绍一些lineinfile模块的常用参数，你可以先对这些参数有一个大概了解，然后再看小示例。

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th align="left">示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>path参数</td> 
   <td align="left">必须参数，<strong>指定要操作的文件</strong>。</td> 
  </tr> 
  <tr> 
   <td>line参数</td> 
   <td align="left">使用此参数<strong>指定文本内容</strong>。</td> 
  </tr> 
  <tr> 
   <td>regexp参数</td> 
   <td align="left"><strong>使用正则表达式匹配对应的行</strong>，<strong>当替换文本时，如果有多行文本都能被匹配，则只有最后面被匹配到的那行文本才会被替换，当删除文本时，如果有多行文本都能被匹配，这么这些行都会被删除。</strong></td> 
  </tr> 
  <tr> 
   <td>state参数</td> 
   <td align="left">当想要<strong>删除对应的文本</strong>时，需要将<strong>state参数的值设置为absent</strong>，absent为缺席之意，表示删除，state的默认值为present</td> 
  </tr> 
  <tr> 
   <td>backrefs参数</td> 
   <td align="left">默认情况下，当根据正则替换文本时，即使regexp参数中的正则存在分组，在line参数中也不能对正则中的分组进行引用，除非将backrefs参数的值设置为yes，backrefs=yes表示开启后向引用，这样，line参数中就能对regexp参数中的分组进行后向引用了，这样说不太容易明白，参考下面的示例命令比较直观一点，backrefs=yes除了能够开启后向引用功能，还有另一个作用，<strong>默认情况下，当使用正则表达式替换对应行时，如果正则没有匹配到任何的行，那么line对应的内容会被插入到文本的末尾</strong>，不过，<strong>如果使用了backrefs=yes，情况就不一样了，当使用正则表达式替换对应行时，同时设置了backrefs=yes，那么当正则没有匹配到任何的行时，则不会对文件进行任何操作</strong>，相当于保持原文件不变，如果没有理解，就按照下面的示例命令，动手操作一下吧，那样更加直观。</td> 
  </tr> 
  <tr> 
   <td>insertafter参数</td> 
   <td align="left">借助insertafter参数可以<strong>将文本插入到“指定的行”之后</strong>，insertafter参数的值可以设置为EOF或者正则表达式，EOF为End Of File之意，表示插入到文档的末尾，默认情况下insertafter的值为EOF，如果将insertafter的值设置为正则表达式，表示将文本插入到匹配到正则的行之后，如果正则没有匹配到任何行，则插入到文件末尾，当使用backrefs参数时，此参数会被忽略。</td> 
  </tr> 
  <tr> 
   <td>insertbefore参数</td> 
   <td align="left">借助insertbefore参数可以<strong>将文本插入到“指定的行”之前</strong>，insertbefore参数的值可以设置为BOF或者正则表达式，BOF为Begin Of File之意，表示插入到文档的开头，如果将insertbefore的值设置为正则表达式，表示将文本插入到匹配到正则的行之前，如果正则没有匹配到任何行，则插入到文件末尾，当使用backrefs参数时，此参数会被忽略。</td> 
  </tr> 
  <tr> 
   <td>backup参数</td> 
   <td align="left">是否在修改文件之前<strong>对文件进行备份</strong>。</td> 
  </tr> 
  <tr> 
   <td>create参数</td> 
   <td align="left">当要操作的文件并不存在时，<strong>是否创建对应的文件</strong>。</td> 
  </tr> 
 </tbody> 
</table>

## 模型示例 ##

对应上述参数的ad-hoc示例命令如下：

为了方便举例，我们使用/testdir/test文件作为被操作的文件，test文件内容如下

# cat /testdir/test
    Hello ansible,Hiiii
    lineinfile -
    Ensure a particular line is in a file,
    lineinfile -
    or replace an existing line using a back-referenced regular expression.

确保指定的"一行文本"存在于文件中，如果指定的文本本来就存在于文件中，则不做任何操作，如果不存在，默认在文件的末尾插入这行文本，如下命令表示确保"test test"这行文本存在于/testdir/test文件中。

[root@server4 testdir]# ansible testB -m lineinfile -a 'path=/testdir/test line="test test"'

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 8]![在这里插入图片描述][20200323164501959.png]

如下命令表示根据正则表达式替换"某一行"，如果不止一行能够匹配正则，那么**只有最后一个匹配正则的行才会被替换**，被匹配行会被替换成line参数指定的内容，但是如果指定的表达式没有匹配到任何一行，那么line中的内容会被添加到文件的最后一行。

[root@server4 testdir]# ansible testB -m lineinfile -a 'path=/testdir/test regexp="^line" line="test test"'			#表示以line开头的那行替换为test test

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 9]

![在这里插入图片描述][20200323164854462.png]  
如上命令表示根据正则表达式替换"某一行"，如果不止一行能够匹配正则，那么只有最后一个匹配正则的行才会被替换，被匹配行会被替换成line参数指定的内容，但是如果指定的表达式没有匹配到任何一行，那么则不对文件进行任何操作。

根据line参数的内容删除行，如果文件中有多行都与line参数的内容相同，那么这些相同的行都会被删除。

**根据正则表达式删除对应行，如果有多行都满足正则表达式，那么所有匹配的行都会被删除**

将测试文件更改为：

[root@server3 testdir]# cat test
    hello ansible,Hiiii
    lineinfile -
    Ensure a particular line is in a file,
    test test
    or replace an existing line using a back-referenced regular expression.
    test test
    lineinfile -
    lineinfile -
    lineinfile -
    lineinfile -
    Ensure a particular line is in a file,
    Ensure a particular line is in a file,
    Ensure a particular line is in a file,
    Ensure a particular line is in a file,

执行以下命令：

[root@server4 testdir]# ansible testB -m lineinfile -a 'path=/testdir/test regexp="^line" state=absent'

执行结果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 10]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 11]  
即所有匹配到的行都被删除了。

默认情况下，lineinfile模块不支持后向引用。

如果将backrefs设置为yes，表示开启支持后向引用，使用如下命令，可以将test示例文件中的"Hello ansible,Hiiii"替换成"Hiiii"，如果不设置backrefs=yes，则不支持后向引用，那么"Hello ansible,Hiiii"将被替换成"\\2"

ansible testB -m lineinfile -a 'path=/testdir/test regexp="(H.{4}).*(H.{4})" line="\2" backrefs=yes'

其他参数与之前的内容相同，就不再举例。

[20200322213120788.png]: /images/20230528/74e4803a20f74b159a32bd565ab3f057.png
[20200322213234856.png]: /images/20230528/e134eddb60364f8e93eb3aabef154b72.png
[20200322213451896.png]: /images/20230528/b3dca73dba934763abac2304aa5684e4.png
[20200322213604608.png]: /images/20230528/bb8c7e6d115f46ff929cfea4ef276dff.png
[20200322213646803.png]: /images/20230528/f14023cb96d247b38f152bd195f56284.png
[20200322213721794.png]: /images/20230528/5525330b4c9d42d9b1554167fd048517.png
[20200322213901293.png]: /images/20230528/127d741c012e4a8bbcb2ab6f6fdb8a63.png
[20200322214002666.png]: /images/20230528/b3c87a7400ed46ef93bef48d70bb3fb3.png
[20200322214106956.png]: /images/20230528/5a9a401a4c1f49fbb696ffbb8099ae7e.png
[20200322214156888.png]: /images/20230528/82e6d4e907a24d56968dd40e53015da6.png
[20200322214245375.png]: /images/20230528/d44d778ad9a44be5952ee2726b3f7289.png
[20200322214344740.png]: /images/20230528/3dac58f9afd74a4d836c9f8b3529ceb0.png
[20200323120200696.png]: /images/20230528/0304dd5cd9134820b54c587e3128f912.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2020032312040332.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2,size_16,color_FFFFFF,t_70
[20200323120438843.png]: /images/20230528/0e9c2896189948b7a4799e8ddbf45228.png
[20200323121057196.png]: /images/20230528/3e9ace69d2b348c0ad70c0ab14256a77.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200323121139251.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2,size_16,color_FFFFFF,t_70
[20200323121213430.png]: /images/20230528/c2dee1a92d16494bb77b8c56b8aeb594.png
[20200323121344559.png]: /images/20230528/6b5198f3918b4e8fa3e2ceaa69eb73e3.png
[20200323121635481.png]: /images/20230528/fc1ad54e209a44ecb0c4fed40f001142.png
[20200323121837425.png]: /images/20230528/058d9d104b094106b474957c8a26944f.png
[20200323121944407.png]: /images/20230528/3910641ca057437f91244efc2a70bc0c.png
[20200323122141733.png]: /images/20230528/b05338e0456f4644b00251b8029448bb.png
[20200323122314964.png]: /images/20230528/4f46393f07754e7b9c71f585bb6a159a.png
[20200323122432554.png]: /images/20230528/96e0ba6bea0c4ff7ba76abe7e29adecb.png
[2020032312254884.png]: /images/20230528/c19b82121e6b43aeb39051288f807750.png
[20200323122646868.png]: /images/20230528/e85baffd69a9454d9008caa0277eb58b.png
[20200323122822649.png]: /images/20230528/cee022a4e5434771931343e72daac366.png
[20200323122930272.png]: /images/20230528/25b609d24d004d4caad7e17ef0f461bb.png
[20200323123020287.png]: /images/20230528/328f7b72cd0040d3bb9ee0d618d6a482.png
[20200323123146323.png]: /images/20230528/13af693073ce4c70a3a706ea981156b7.png
[20200323160336736.png]: /images/20230528/0b9b58bce18248c1abfeac348ded4db3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 2]: /images/20230528/8e1ca2d5629e43f781a1bd96576e32bb.png
[20200323160904955.png]: /images/20230528/e2b3decdcdc44da7bb66aad8ca4d3a33.png
[20200323161027880.png]: /images/20230528/2348aef9a276468999394a55394484d0.png
[20200323161141473.png]: /images/20230528/e7cb1b29f7da40eeb7ad21beac3129ca.png
[20200323161300805.png]: /images/20230528/1ea732896d49449b8a91cac2f5aec6eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 3]: /images/20230528/c5ecd770e0504d79a3a3b6b84d0385f2.png
[20200323161545676.png]: /images/20230528/7731480e92e14a34a99097dce3052a4e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 4]: /images/20230528/318f4b5e0169413ea0b435c9542ddc6f.png
[20200323161642641.png]: /images/20230528/cc8dec5900ca4cb390c334a9f5788726.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 5]: /images/20230528/507e45bf31f042ab91730c5af92f8975.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20200323161853491.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2,size_16,color_FFFFFF,t_70
[20200323161956377.png]: /images/20230528/c515f550311449edaa648060cd36a13b.png
[20200323162040111.png]: /images/20230528/2f0ec9fb1fc14ab9b2321d9d7d478118.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20200323162115179.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2,size_16,color_FFFFFF,t_70
[20200323162152421.png]: /images/20230528/d4b3482cc8624c07878b32898613f84a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/2020032316435940.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2,size_16,color_FFFFFF,t_70
[20200323164501959.png]: /images/20230528/933ec43088354ecd97d1ecf541965d04.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 9]: /images/20230528/1ed5f04121bc49f2996d832f07fe3dde.png
[20200323164854462.png]: /images/20230528/506f96d0973942ff9386f7b724474898.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 10]: /images/20230528/364c4cce8ad142588933fd9889e4b89d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1ODg3NTQ2_size_16_color_FFFFFF_t_70 11]: /images/20230528/7174d4d2baa24288aefe0fdc737e8311.png