ansible常用模块介绍

文章目录

1 commend
2 shell
3 script
4 copy
5 file
6 find
7 service
8 yum
9 fetch
10 cron

commend

常用参数

free_form参数：必须参数，指定需要远程执行的命令。需要说明一点，free_form 参数与其他参数（如果想要使用一个参数，那么则需要为这个参数赋值，也就是name=value模式）并不相同。比如，当我们想要在远程主机上执行 ls 命令时，我们并不需要写成”free_form=ls” ，这样写反而是错误的，因为并没有任何参数的名字是 free_form，当我们想要在远程主机中执行 ls 命令时，直接写成 ls 即可。因为 command 模块的作用是执行命令，所以，任何一个可以在远程主机上执行的命令都可以被称为 free_form。

chdir参数 : 此参数的作用就是指定一个目录，在执行对应的命令之前，会先进入到 chdir 参数指定的目录中。

creates参数：看到 creates，你可能会从字面上理解这个参数，但是使用这个参数并不会帮助我们创建文件，它的作用是当指定的文件存在时，就不执行对应命令，比如，如果 /testdir/test文件存在，就不执行我们指定的命令。

removes参数：与 creates 参数的作用正好相反，它的作用是当指定的文件不存在时，就不执行对应命令，比如，如果 /testdir/tests 文件不存在，就不执行我们指定的命令，此参数并不会帮助我们删除文件。

示例

# 执行ls
ansible ansible-demo3 -m command -a "ls"
# 进入远程主机/tmp目录执行 ls
ansible ansible-demo3 -m command -a "chdir=tmp ls"
# 文件存在于远程主机中，则不执行对应命令
ansible ansible-demo3 -m command -a "creates=/testdir/testfile1 echo test"
# 文件不存在于远程主机中，则执行对应命令
ansible ansible-demo3 -m command -a "creates=/testdir/testfile1 echo test"

shell

常用参数

free_form参数：必须参数，指定需要远程执行的命令，但是并没有具体的一个参数名叫free_form，具体解释参考 command 模块。

chdir参数 : 此参数的作用就是指定一个目录，在执行对应的命令之前，会先进入到 chdir 参数指定的目录中。

creates参数：使用此参数指定一个文件，当指定的文件存在时，就不执行对应命令，可参考command 模块中的解释。

removes参数：使用此参数指定一个文件，当指定的文件不存在时，就不执行对应命令，可参考 command 模块中的解释。

executable参数：默认情况下，shell 模块会调用远程主机中的 /bin/sh 去执行对应的命令，通常情况下，远程主机中的默认 shell 都是 bash。如果你想要使用其他类型的 shell 执行命令，则可以使用此参数指定某种类型的 shell 去执行对应的命令。指定 shell 文件时，需要使用绝对路径。

示例

shell 模块中 chdir、creates、removes 参数的作用与 command 模块中的作用都是相同的，此处不再举例。

script

在远程主机上执行ansible主机上的脚本，且不需要将脚本复制到被执行的远程主机上

常用参数

free_form参数：必须参数，指定需要执行的脚本，脚本位于 ansible 管理主机本地，并没有具体的一个参数名叫 free_form，具体解释请参考 command 模块。

chdir参数 : 此参数的作用就是指定一个远程主机中的目录，在执行对应的脚本之前，会先进入到 chdir 参数指定的目录中。

creates参数：使用此参数指定一个远程主机中的文件，当指定的文件存在时，就不执行对应脚本，可参考 command 模块中的解释。

removes参数：使用此参数指定一个远程主机中的文件，当指定的文件不存在时，就不执行对应脚本，可参考 command 模块中的解释。

示例

远程主机，执行本地主机的 testscript.sh脚本

[root@ansible-manager ~]# ansible ansible-demo3 -m script -a "chdir=/opt /testdir/testscript.sh"
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "rc": 0, 
    "stderr": "Shared connection to ansible-demo3 closed.\r\n", 
    "stdout": "testscript\r\n", 
    "stdout_lines": [
        "testscript"
    ]
}

其中 testscript.sh 脚本为打印 ‘testscript’ 字符串。

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表示。

示例

[root@ansible-manager ~]# ansible ansible-demo3 -m copy -a "src=/testdir/copytest dest=/testdir/"
ansible-demo3 | FAILED! => {
    "changed": false, 
    "checksum": "47ce3ac56f911ac44537d6a3802b72ceed71e152", 
    "msg": "Aborting, target uses selinux but python bindings (libselinux-python) aren't installed!"
}

file

常用参数

path参数：必须参数，用于指定要操作的文件或目录，在之前版本的ansible中，使用dest参数或者name参数指定要操作的文件或目录，为了兼容之前的版本，使用dest或name也可以。

state参数：此参数非常灵活，其对应的值需要根据情况设定。比如，我们想要在远程主机上创建/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，可以递归的修改目录中文件的属性。

示例

在 ansible-demo3 主机上创建一个名为 testfile1 的文件，如果 testfile1 文件已经存在，则会更新文件的时间戳，与 touch 命令的作用相同。

[root@ansible-manager ~]# ansible ansible-demo3 -m file -a "path=/testdir/testfile1 state=touch"
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "dest": "/testdir/testfile1", 
    "gid": 0, 
    "group": "root", 
    "mode": "0644", 
    "owner": "root", 
    "secontext": "unconfined_u:object_r:default_t:s0", 
    "size": 8, 
    "state": "file", 
    "uid": 0
}

2.在 ansible-demo3 主机上创建一个名为 /testdir/testdir 的目录，如果 /testdir/testdir 目录已经存在，则不进行任何操作。

[root@ansible-manager ~]# ansible ansible-demo3 -m file -a "path=/testdir/testdir state=directory"
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "gid": 0, 
    "group": "root", 
    "mode": "0755", 
    "owner": "root", 
    "path": "/testdir/testdir", 
    "secontext": "unconfined_u:object_r:default_t:s0", 
    "size": 6, 
    "state": "directory", 
    "uid": 0
}

3.在 ansible-demo3 上为 testfile1 文件创建软链接文件，软链接名为 linkfile1，执行下面命令的时候，testfile1 已经存在。

[root@ansible-manager ~]# ansible ansible-demo3 -m file -a "path=/testdir/linkfile1 state=link src=/testdir/testfile1"
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "dest": "/testdir/linkfile1", 
    "gid": 0, 
    "group": "root", 
    "mode": "0777", 
    "owner": "root", 
    "secontext": "unconfined_u:object_r:default_t:s0", 
    "size": 18, 
    "src": "/testdir/testfile1", 
    "state": "link", 
    "uid": 0
}

4.在 ansible-demo3 上为 testfile2 文件创建硬链接文件，硬链接名为 hardfile2，执行下面命令的时候，testfile2 已经存在。

[root@ansible-manager ~]# ansible ansible-demo3 -m file -a "path=/testdir/hardfile2 state=hard src=/testdir/testfile2"
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "dest": "/testdir/hardfile2", 
    "gid": 0, 
    "group": "root", 
    "mode": "0644", 
    "owner": "root", 
    "secontext": "unconfined_u:object_r:default_t:s0", 
    "size": 0, 
    "src": "/testdir/testfile2", 
    "state": "hard", 
    "uid": 0
}

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

[root@ansible-manager ~]# ansible ansible-demo3 -m file -a "path=/testdir/linkfile3 state=link src=/testdir/sourcefile force=yes"
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "dest": "/testdir/linkfile3", 
    "src": "/testdir/sourcefile", 
    "state": "absent"
}

返回的 state 为 absent，表示源文件不存在。

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

[root@ansible-manager ~]# ansible ansible-demo3 -m file -a "path=/testdir/testdir state=absent"
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "path": "/testdir/testdir", 
    "state": "absent"
}

find

常用参数

paths参数：必须参数，指定在哪个目录中查找文件，可以指定多个路径，路径间用逗号隔开，此参数有别名，使用别名 path 或者别名 name 可以代替 paths。

recurse参数 : 默认情况下，只会在指定的目录中查找文件，也就是说，如果目录中还包含目录，ansible 并不会递归的进入子目录查找对应文件，如果想要递归的查找文件，需要使用 recurse 参数，当 recurse 参数设置为 yes 时，表示在指定目录中递归的查找文件。

hidden参数：默认情况下，隐藏文件会被忽略，当 hidden 参数的值设置为 yes 时，才会查找隐藏文件。

file_type参数 : 默认情况下，ansible 只会根据条件查找”文件”，并不会查找”目录”或”软链接”等文件类型，如果想要指定查找的文件类型，可以通过 file_type 指定文件类型，可指定的文件类型有 any、directory、file、link 四种。

patterns参数：使用此参数指定需要查找的文件名称，支持使用 shell（比如通配符）或者正则表达式去匹配文件名称，默认情况下，使用 shell 匹配对应的文件名，如果想要使用 python 的正则去匹配文件名，需要将 use_regex 参数的值设置为 yes。

use_regex参数：默认情况下，find 模块不会使用正则表达式去解析 patterns 参数中对应的内容，当 use_regex 设置为 yes 时，表示使用 python 正则解析 patterns 参数中的表达式，否则，使用 glob 通配符解析 patterns 参数中的表达式。

contains参数：使用此参数可以根据文章内容查找文件，此参数的值为一个正则表达式，find 模块会根据对应的正则表达式匹配文件内容。

age参数：使用此参数可以根据时间范围查找文件，默认以文件的 mtime 为准与指定的时间进行对比，比如，如果想要查找 mtime 在3天之前的文件，那么可以设置 age=3d，如果想要查找 mtime 在3天以内的文件，可以设置 age=-3d，这里所说的3天是按照当前时间往前推3天，可以使用的单位有秒(s)、分(m)、时(h)、天(d)、星期(w)。

age_stamp参数：文件的时间属性中有三个时间种类，atime、ctime、mtime，当我们根据时间范围查找文件时，可以指定以哪个时间种类为准，当根据时间查找文件时，默认以 mtime 为准。

size参数：使用此参数可以根据文件大小查找文件，比如，如果想要查找大于3M的文件，那么可以设置 size=3m,如果想要查找小于50k的文件，可以设置 size=-50k，可以使用的单位有 t、g、m、k、b。

get_checksum参数：当有符合查找条件的文件被找到时，会同时返回对应文件的 sha1校验码，如果要查找的文件比较大，那么生成校验码的时间会比较长。

示例

待整理

service

注意：假如想要管理远程主机中的某个服务，那么这个服务必须能被 BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart 中的任意一种所管理，否则 service 模块也无法管理远程主机的对应服务。这样说可能不容易理解，那么我们换个方式来解释，假设你在使用 centos6，那么你的 centos6 中的 nginx 必须能够通过 “service nginx start” 启动，如果你的 nginx 无法通过 “service nginx start” 进行启动，那么它也同样无法通过 ansible 的 service 模块启动。假设你在使用 centos7，那么你的 centos7 中的 nginx 则必须能够通过 “systemctl start nginx” 启动，如果它无法通过 “systemctl start nginx” 进行启动，那么它也同样无法通过 ansible 的 service 模块进行启动。centos6 中默认通过 sysv 管理服务，centos7 中默认通过 systemd 管理服务。所以，如果服务无法通过 BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart 中的任意一种所管理，那么它也无法被ansible 的 service 模块管理。

常用参数

name参数：此参数用于指定需要操作的服务名称，比如 nginx。

state参数：此参数用于指定服务的状态，比如，我们想要启动远程主机中的 nginx，则可以将 state 的值设置为 started；如果想要停止远程主机中的服务，则可以将 state 的值设置为 stopped。此参数的可用值有 started、stopped、restarted、reloaded。

enabled参数：此参数用于指定是否将服务设置为开机启动项，设置为 yes 表示将对应服务设置为开机启动，设置为 no 表示不会开机启动。

示例

ansible ansible-demo3 -m service -a "name=nginx state=started"

yum

常用参数

name参数：必须参数，用于指定需要管理的软件包，比如 nginx。

state参数：用于指定软件包的状态，默认值为。present，表示确保软件包已经安装，除了。present，其他可用值有 installed、latest、absent、removed，其中 installed 与present 等效，latest 表示安装 yum 中最新的版本，absent 和 removed 等效，表示删除对应的软件包。

disable_gpg_check参数：用于禁用对 rpm 包的公钥 gpg 验证。默认值为 no，表示不禁用验证，设置为 yes 表示禁用验证，即不验证包，直接安装。在对应的 yum 源没有开启 gpg 验证的情况下，需要将此参数的值设置为 yes，否则会报错而无法进行安装。

enablerepo参数：用于指定安装软件包时临时启用的 yum 源。假如你想要从A源中安装软件，但是你不确定A源是否启用了，你可以在安装软件包时将此参数的值设置为 yes，即使A源的设置是未启用，也可以在安装软件包时临时启用A源。

disablerepo参数：用于指定安装软件包时临时禁用的 yum 源。某些场景下需要此参数，比如，当多个 yum 源中同时存在要安装的软件包时，你可以使用此参数临时禁用某个源，这样设置后，在安装软件包时则不会从对应的源中选择安装包。

enablerepo 参数和 disablerepo 参数可以同时使用。

示例

ansible ansible-demo3 -m yum -a 'name=nginx state=present disable_gpg_check=yes'

fetch

常用参数

dest：指定拉取文件到本地以后，文件存放的位置

src：指定从受管主机中拉取哪个文件

示例

ansible ansible-demo3 -m yum -a 'src=/tmp/test1 dest=./test1'

注意 fetch 只支持拉取文件，且不支持通配符, 不过可以和find模块配合批量拉取文件

拉取远程主机 /tmp/test/主机下所有文件

- hosts: ansible-demo3 
  tasks:
    - name: find
      find: paths=/tmp/test/ patterns="*" recurse=yes
      register: file_list

    - name: get
      fetch:src="{{ item.path }}" dest=./
      #shell: "echo {{item.path}}"
      with_items: "{{ file_list.files }}"

cron

常用参数

minute参数：此参数用于设置计划任务中分钟设定位的值，比如，上述示例1中分钟设定位的值为5，即 minute=5，当不使用此参数时，分钟设定位的值默认为”*”。

hour参数：此参数用于设置计划任务中小时设定位的值，比如，上述示例1中小时设定位的值为1，即 hour=1，当不使用此参数时，小时设定位的值默认为”*”。

day参数：此参数用于设置计划任务中日设定位的值，当不使用此参数时，日设定位的值默认为”*”。

month参数：此参数用于设置计划任务中月设定位的值，当不使用此参数时，月设定位的值默认为”*”。

weekday参数：此参数用于设置计划任务中周几设定位的值，当不使用此参数时，周几设定位的值默认为”*”。

special_time参数：在上述示例3与示例4中，计划任务的时间设定格式为 @reboot 或者@hourly。@reboot 表示重启时执行，@hourly 表示每小时执行一次，相当于设置成”0 0 * * *” ，这种@开头的时间设定格式则需要使用 special_time 参数进行设置，special_time 参数的可用值有 reboot(重启后)、yearly(每年)、annually(每年，与yearly相同)、monthly(每月)、weekly(每周)、daily(每天)、hourly(每时)。

注意：当上述时间单位设定参数都未指定时，计划任务的时间设定默认会被设定为”* * * * *”，这样表示每秒都会执行一次计划任务，所以，在使用cron模块时，我们应该确定对应的时间参数设置正确。

user参数：此参数用于设置当前计划任务属于哪个用户，当不使用此参数时，默认为管理员用户。

job参数：此参数用于指定计划的任务中需要实际执行的命令或者脚本，比如上例中的 “echo test” 命令。

name参数：此参数用于设置计划任务的名称，计划任务的名称会在注释中显示，当不指定计划任务的名称时，ansible 会默认为计划任务加入注释，注释的内容为 #Ansible: None，假设指定计划任务的名称为 test，那么注释的内容为#Ansible: test，在一台机器中，计划任务的名称应该具有唯一性，方便我们以后根据名称修改或删除计划任务。

state参数：当计划任务有名称时，我们可以根据名称修改或删除对应的任务，当删除计划任务时，需要将 state 的值设置为 absent。

disabled参数：当计划任务有名称时，我们可以根据名称使对应的任务”失效”（注释掉对应的任务）。注意，使用此参数时，除了需要指定任务的名称，还需要同时指定任务的job 以及任务的时间设定，而且任务的时间设定必须和对应任务完全相同，否则在注释任务的同时，任务的时间设定会被修改，除非你确定这样做。

backup参数：如果此参数的值设置为 yes，那么当修改或者删除对应的计划任务时，会先对计划任务进行备份，然后再对计划任务进行修改或者删除，cron 模块会在远程主机的 /tmp 目录下创建备份文件，以 crontab 开头并且随机加入一些字符，具体的备份文件名称会在返回信息的 backup_file 字段中看到，推荐将此此参数设置为 yes。

示例

在 ansible-demo3 主机上创建计划任务，任务名称为”crontab test”，任务于每天1点5分执行，任务内容为输出test字符。

[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='crontab test' minute=5 hour=1 job='echo test' "
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "envs": [], 
    "jobs": [
        "crontab test"
    ]
}

由于”special time test”已经存在，所以，当我们再次操作同名的任务时，ansible 将会认为是修改原来的任务。执行如下命令，原计划任务会被修改，因为启用了 backup，所以任务在修改前会被备份。

[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='special time test' special_time=hourly job='echo test' backup=yes "
ansible-demo3 | SUCCESS => {
    "backup_file": "/tmp/crontabX6CMO1", 
    "changed": true, 
    "envs": [], 
    "jobs": [
        "crontab test", 
        "crontab day test", 
        "special time test"
    ]
}

执行上述命令后，从返回信息的 backup_file 字段中可以看到备份文件的远程主机中的位置，内容如下：

[root@ansible-demo3 ~]# cat /tmp/crontabX6CMO1
#Ansible: crontab test
5 1 * * * echo test
#Ansible: crontab day test
1 1 */3 * * echo test
#Ansible: special time test
@reboot echo test

原来的”special time test”任务会变成如下设定：

#Ansible: special time test
@hourly echo test

任务”special time test”已经存在于 ansible-demo3 主机中，如果我们想要删除这个计划任务，可以执行如下命令，删除任务的同时可以进行备份。

[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='special time test' state=absent backup=yes "
ansible-demo3 | SUCCESS => {
    "backup_file": "/tmp/crontabiaObgL", 
    "changed": true, 
    "envs": [], 
    "jobs": [
        "crontab test", 
        "crontab day test"
    ]
}

命令执行后，从返回信息的 backup_file 字段中可以看到备份文件的远程主机中的位置。

默认操作的是 root 用户的计划任务，如果想要操作远程主机中其他用户的计划任务，可以指定要操作的用户。

[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a "user=ding name='special time test' special_time=hourly job='echo test' "
ansible-demo3 | SUCCESS => {
    "changed": true, 
    "envs": [], 
    "jobs": [
        "special time test"
    ]
}

上述命令执行后，可以在远程主机中使用 crontab -u ding -l 查看对应的计划任务。

[root@ansible-demo3 ~]# crontab -u ding -l
#Ansible: special time test
@hourly echo test

上文已经创建了名称为 “crontab test” 的计划任务，如果我们想要暂时注释这个计划任务，可以使用如下命令。但是需要注意，在注释任务时，所有设定需要跟原设定保持一致，否则计划任务的设置将会发生改变，示例如下：

比如，我们想要将 crontab day test 这个任务注释掉，则需要使用如下命令。注意，最好与 backup 参数同时使用。

[root@ansible-manager ~]# ansible ansible-demo3 -m cron -a " name='crontab day test' minute=1 hour=1 day=*/3 job='echo test' disabled=yes backup=yes"
ansible-demo3 | SUCCESS => {
    "backup_file": "/tmp/crontabx0pB5J", 
    "changed": true, 
    "envs": [], 
    "jobs": [
        "crontab test", 
        "crontab day test"
    ]
}

执行上述命令后，对应的计划任务将会被注释：

commend

shell

script

copy

file

find

service

yum

fetch

cron

young

ansible_playbook使用

Linux权限管理--su与sudo

标签

导航