ansible中 常用模块之文件操作
- 一、copy模块
- 模块介绍
- 模块参数
- 模块示例
- 二、file模块
- 模块介绍
- 模块参数
- 模块示例
- 三、blockinfile模块
- 模块介绍
- 模块参数
- 模块示例
- 四、lineinfile模块
- 模型介绍
- 模型参数
- 模型示例
一、copy模块
模块介绍
见名知义，copy模块的作用就是拷贝文件，它与之前介绍的fetch模块类似，不过，fetch模块是从远程主机中拉取文件到ansible主机，而copy模块是将ansible主机上的文件拷贝到远程主机中。
模块参数
此处我们介绍一些copy模块的常用参数，然后再给出对应示例。
参数 | 含义 |
src参数 | 用于指定需要copy的文件或目录 |
dest参数 | 用于指定文件将被拷贝到远程主机的哪个目录中，dest为必须参数 |
content参数 | 当不使用src指定拷贝的文件时，可以使用content直接指定文件内容，src与content两个参数必有其一，否则会报错。 |
force参数 | 当远程主机的目标路径中已经存在同名文件，并且与ansible主机中的文件内容不同时，是否强制覆盖，可选值有yes和no，默认值为yes，表示覆盖，如果设置为no，则不会执行覆盖拷贝操作，远程主机中的文件保持不变。 |
backup参数 | 当远程主机的目标路径中已经存在同名文件，并且与ansible主机中的文件内容不同时，是否对远程主机的文件进行备份，可选值有yes和no，当设置为yes时，会先备份远程主机中的文件，然后再将ansible主机中的文件拷贝到远程主机。 |
owner参数 | 指定文件拷贝到远程主机后的属主，但是远程主机上必须有对应的用户，否则会报错。 |
group参数 | 指定文件拷贝到远程主机后的属组，但是远程主机上必须有对应的组，否则会报错。 |
mode参数 | 指定文件拷贝到远程主机后的权限，如果你想将权限设置为"rw-r–r--"，则可以使用mode=0644表示，如果你想要在user对应的权限位上添加执行权限，则可以使用mode=u+x表示。 |
模块示例
对应上述参数的ad-hoc示例命令如下：
将ansible主机中/testdir/copytest文件复制到远程主机的/opt目录下，注意，如果copytest文件已经存在于远程主机的/opt目录中，并且远程主机中的copytest与ansible主机中copytest文件内容不同，那么使用如下命令时，远程主机中的copytest文件将被覆盖。
在server4中只执行：
ansible testB -m copy -a "src=/testdir/copytest dest=/opt/"
上图可以看出内容已经被覆盖
在远程主机的/opt目录下生成文件test，test文件中有两行文本，第一行文本为aaa，第二行为bbb，当使用content指定文件内容时，dest参数对应的值必须是一个文件，而不能是一个路径。
ansible testB -m copy -a 'content="aaa\nbbb\n" dest=/opt/test'
将ansible主机中/testdir/copytest文件复制到远程主机的/opt目录中时，如果远程主机中已经存在/opt/copytest文件，并且文件内容与ansible主机中的copytest文件的内容不一致，则不执行拷贝操作，远程主机中的/opt/copytest文件内容不会被改变。
ansible testB -m copy -a "src=/testdir/copytest dest=/opt/ force=no"
将ansible主机中/testdir/copytest文件复制到远程主机的/opt目录中时，如果远程主机中已经存在/opt/copytest文件，并且文件内容与ansible主机中的copytest文件的内容不一致，会执行拷贝操作，但是在执行拷贝操作之前，会将远程主机中的原文件重命名，以作备份，然后再进行拷贝操作。
ansible testB -m copy -a "src=/testdir/copytest dest=/opt/ backup=yes"
拷贝文件时，指定文件的属主，需要注意，远程主机上必须存在对应的用户。
ansible testB -m copy -a "src=/testdir/westos dest=/opt/ owner=cl"
如果拷贝的文件在目标主机存在且相同时，只会更改文件所属用户：
执行：
ansible testB -m copy -a "src=/testdir/copytest dest=/opt owner=cl"执行后：
拷贝文件时，指定文件的属组，需要注意，远程主机上必须存在对应的组。
ansible testB -m copy -a "src=/testdir/copytest dest=/opt/ group=cl"执行后：
拷贝文件时，指定文件的权限
ansible testB -m copy -a "src=/testdir/pp dest=/opt mode=0640"执行后：
当目标文件存在且相同时，只会更改权限：
执行前：
执行：
ansible testB -m copy -a "src=/testdir/copytest dest=/opt mode=0640"执行后：
可以看出权限已经更改为0640。
二、file模块
模块介绍
file模块可以帮助我们完成一些对文件的基本操作，比如，创建文件或目录、删除文件或目录、修改文件权限等
模块参数
此处我们介绍一些file模块的常用参数，然后再给出对应示例。
参数 | 含义 |
path参数 | 必须参数，用于指定要操作的文件或目录，在之前版本的ansible中，使用dest参数或者name参数指定要操作的文件或目录，为了兼容之前的版本，使用dest或name也可以。 |
state参数 | 此参数非常灵活，此参数对应的值需要根据情况设定，比如，当我们需要在远程主机中创建一个目录的时候，我们需要使用path参数指定对应的目录路径，假设，我想要在远程主机上创建/testdir/a/b目录，那么我则需要设置path=/testdir/a/b，但是，我们无法从"/testdir/a/b"这个路径看出b是一个文件还是一个目录，ansible也同样无法单单从一个字符串就知道你要创建文件还是目录，所以，我们需要通过state参数进行说明，当我们想要创建的/testdir/a/b是一个目录时，需要将state的值设置为directory，"directory"为目录之意，当它与path结合，ansible就能知道我们要操作的目标是一个目录，同理，当我们想要操作的/testdir/a/b是一个文件时，则需要将state的值设置为touch，当我们想要创建软链接文件时，需将state设置为link，想要创建硬链接文件时，需要将state设置为hard，当我们想要删除一个文件时（删除时不用区分目标是文件、目录、还是链接），则需要将state的值设置为absent，"absent"为缺席之意，当我们想让操作的目标"缺席"时，就表示我们想要删除目标。 |
src参数 | 当state设置为link或者hard时，表示我们想要创建一个软链或者硬链，所以，我们必须指明软链或硬链链接的哪个文件，通过src参数即可指定链接源 。 |
force参数 | 当state=link的时候，可配合此参数强制创建链接文件，当force=yes时，表示强制创建链接文件，不过强制创建链接文件分为两种情况，情况一：当你要创建的链接文件指向的源文件并不存在时，使用此参数，可以先强制创建出链接文件。情况二：当你要创建链接文件的目录中已经存在与链接文件同名的文件时，将force设置为yes，会将同名文件覆盖为链接文件，相当于删除同名文件，创建链接文件。情况三：当你要创建链接文件的目录中已经存在与链接文件同名的文件，并且链接文件指向的源文件也不存在，这时会强制替换同名文件为链接文件。 |
owner参数 | 用于指定被操作文件的属主，属主对应的用户必须在远程主机中存在，否则会报错。 |
group参数 | 用于指定被操作文件的属组，属组对应的组必须在远程主机中存在，否则会报错。 |
mode参数 | 用于指定被操作文件的权限，比如，如果想要将文件权限设置为"rw-r-x—"，则可以使用mode=650进行设置，或者使用mode=0650，效果也是相同的，如果你想要设置特殊权限，比如为二进制文件设置suid，则可以使用mode=4700，很方便吧。 |
recurse参数 | 当要操作的文件为目录，将recurse设置为yes，可以递归的修改目录中文件的属性。 |
模块示例
对应上述参数的ad-hoc示例命令如下：
在testB（server3）主机上创建一个名为westos的文件，如果testfile文件已经存在，则会更新文件的时间戳，与touch命令的作用相同。
在server4：
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/westos state=touch"结果：
当远程主机中文件已经从在再次执行命令依然会成功，会修改远程主机文件的时间戳：
在testB（server3）主机上创建一个名为westosdir的目录，如果westosdir目录已经存在，则不进行任何操作。
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/westosdir state=directory"结果：
当目录已经存在时：
在testB（server3）上为westos文件创建软链接文件，软链接名为linkwestos，执行下面命令的时候，westos已经存在。
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/linkwestos state=link src=/testdir/westos"结果：
在testB（server3）上为westos文件创建硬链接文件，硬链接名为hardwestos，执行下面命令的时候，westos已经存在。
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/hardwestos state=hard src=/testdir/westos"
在创建链接文件时，如果源文件不存在，或者链接文件与其他文件同名时，强制覆盖同名文件或者创建链接文件，参考上述force参数的解释。
源文件不存在并且链接文件与其他文件同名：
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/linkwestos state=link src=westos-cl force=yes"结果：
删除远程机器上的指定文件或目录
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/linkwestos state=absent"
在创建文件或目录的时候指定属主，或者修改远程主机上的文件或目录的属主。
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/a state=touch owner=cl"结果：
在创建文件或目录的时候指定属组，或者修改远程主机上的文件或目录的属组。
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/b state=touch group=cl"结果：
当文件存在时只修改属组：
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/a state=touch group=cl"
指定目录的属组：
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/c state=directory group=cl"
修改目录的属主：
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/c state=directory owner=cl"
在创建文件或目录的时候指定权限，或者修改远程主机上的文件或目录的权限。
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/c mode=666"
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/d state=directory mode=0644"
指定特殊权限：
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/d state=directory mode=4700"
当操作远程主机中的目录时，同时递归的创建目录并将目录中的文件的属主属组都设置为cl。
[root@server4 testdir]# ansible testB -m file -a "path=/testdir/1/2 state=directory owner=cl group=cl recurse=yes"
三、blockinfile模块
模块介绍
blockinfile模块可以帮助我们在指定的文件中插入"一段文本"，这段文本是被标记过的，换句话说就是，我们在这段文本上做了记号，以便在以后的操作中可以通过"标记"找到这段文本，然后修改或者删除它，单单这样描述不是特别容易理解，结合下面的小例子动手做做立马就能够明白了。
模块参数
此处我们介绍一些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参数 | 当要操作的文件并不存在时，是否创建对应的文件。 |
模块示例
对应上述参数的ad-hoc示例命令如下：
为了方便举例，我们将/etc/rc.d/rc.local文件复制到/testdir目录中，以做测试
假如，我们想要在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
正如之前所说，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
在执行完上述命令的基础上，执行如下命令
[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
在执行完上述命令的基础上，执行如下命令
[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'
是的，使用将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'
如果使用如下命令，表示将文本块插入到文档的结尾，与默认操作相同，将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'
结果：
使用如下命令表示使用正则表达式匹配行，将文本块插入到 “以#!/bin/bash开头的行” 之后（同样需要将上个示例的内容删除）
[root@server4 testdir]# ansible testB -m blockinfile -a 'path=/testdir/rc.local block="#######blockinfile test#####" marker="#{mark} test" insertafter="^#!/bin/bash"'
使用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'
使用create参数，如果指定的文件不存在，则创建它，示例如下
[root@server4 testdir]# ansible testB -m blockinfile -a 'path=/testdir/test block="###test!!!!" marker="#{mark} test" create=yes'
四、lineinfile模块
模型介绍
我们可以借助lineinfile模块，确保"某一行文本"存在于指定的文件中，或者确保从文件中删除指定的"文本"（即确保指定的文本不存在于文件中），还可以根据正则表达式，替换"某一行文本"。
模型参数
此处我们介绍一些lineinfile模块的常用参数，你可以先对这些参数有一个大概了解，然后再看小示例。
参数 | 示例 |
path参数 | 必须参数，指定要操作的文件。 |
line参数 | 使用此参数指定文本内容。 |
regexp参数 | 使用正则表达式匹配对应的行，当替换文本时，如果有多行文本都能被匹配，则只有最后面被匹配到的那行文本才会被替换，当删除文本时，如果有多行文本都能被匹配，这么这些行都会被删除。 |
state参数 | 当想要删除对应的文本时，需要将state参数的值设置为absent，absent为缺席之意，表示删除，state的默认值为present |
backrefs参数 | 默认情况下，当根据正则替换文本时，即使regexp参数中的正则存在分组，在line参数中也不能对正则中的分组进行引用，除非将backrefs参数的值设置为yes，backrefs=yes表示开启后向引用，这样，line参数中就能对regexp参数中的分组进行后向引用了，这样说不太容易明白，参考下面的示例命令比较直观一点，backrefs=yes除了能够开启后向引用功能，还有另一个作用，默认情况下，当使用正则表达式替换对应行时，如果正则没有匹配到任何的行，那么line对应的内容会被插入到文本的末尾，不过，如果使用了backrefs=yes，情况就不一样了，当使用正则表达式替换对应行时，同时设置了backrefs=yes，那么当正则没有匹配到任何的行时，则不会对文件进行任何操作，相当于保持原文件不变，如果没有理解，就按照下面的示例命令，动手操作一下吧，那样更加直观。 |
insertafter参数 | 借助insertafter参数可以将文本插入到“指定的行”之后，insertafter参数的值可以设置为EOF或者正则表达式，EOF为End Of File之意，表示插入到文档的末尾，默认情况下insertafter的值为EOF，如果将insertafter的值设置为正则表达式，表示将文本插入到匹配到正则的行之后，如果正则没有匹配到任何行，则插入到文件末尾，当使用backrefs参数时，此参数会被忽略。 |
insertbefore参数 | 借助insertbefore参数可以将文本插入到“指定的行”之前，insertbefore参数的值可以设置为BOF或者正则表达式，BOF为Begin Of File之意，表示插入到文档的开头，如果将insertbefore的值设置为正则表达式，表示将文本插入到匹配到正则的行之前，如果正则没有匹配到任何行，则插入到文件末尾，当使用backrefs参数时，此参数会被忽略。 |
backup参数 | 是否在修改文件之前对文件进行备份。 |
create参数 | 当要操作的文件并不存在时，是否创建对应的文件。 |
模型示例
对应上述参数的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"'
如下命令表示根据正则表达式替换"某一行"，如果不止一行能够匹配正则，那么只有最后一个匹配正则的行才会被替换，被匹配行会被替换成line参数指定的内容，但是如果指定的表达式没有匹配到任何一行，那么line中的内容会被添加到文件的最后一行。
[root@server4 testdir]# ansible testB -m lineinfile -a 'path=/testdir/test regexp="^line" line="test test"' #表示以line开头的那行替换为test test
如上命令表示根据正则表达式替换"某一行"，如果不止一行能够匹配正则，那么只有最后一个匹配正则的行才会被替换，被匹配行会被替换成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'执行结果：
即所有匹配到的行都被删除了。
默认情况下，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'其他参数与之前的内容相同，就不再举例。
