ansible模块介绍

Posted 2020-07-04

命令模块：

1：command模块在远程节点上执行命令：

    command模块后面紧跟要执行的命令，命令的参数以空格隔开。指定的命令会在所选的节点上执行。命令并不是通过shell执行的，所以并不能使用$HOME等环境变量和一些操作符（<,>,|,&).shell模块可以使用。

    1》chdir 在运行命令之前，先切换到指定的目录。

[[email protected] ansible]# ansible testhosts -m command -a "ls -l chdir=/tmp"
127.0.0.1 | success | rc=0 >>
total 4
drwx------ 2 root root 4096 Apr  5 21:27 pymp-eBJbzL

192.168.1.112 | success | rc=0 >>
total 4
drwxr-xr-x 2 root root 4096 Apr  2 02:04 rsync
/先切换到/tmp目录下，然后再执行命令！

    2》creates 后边可以直接指定一个文件名(目录名)，或者是以正则模式匹配一系列文件名。如果所指定的文件存在的话，则不执行指定的命令。

[[email protected] ansible]# ansible 192.168.1.112 -m command -a "ls -l /tmp creates=/tmp/test"
192.168.1.112 | success | rc=0 >>
total 4
drwxr-xr-x 2 root root 4096 Apr  2 02:04 rsync

/tmp/test不存在，所以执行命令

[[email protected] ansible]# ansible 192.168.1.112 -m command -a "ls -l /tmp creates=/tmp/rsync"
192.168.1.112 | success | rc=0 >>
skipped, since /tmp/rsync exists


/tmp/rsync文件存在，所以不执行命令

    3》removes 后边可以直接指定一个文件名(或目录名)，或者是以正则模式匹配一系列文件名。如果所指定的文件不存在的话，则不运行命令。（注意与creates的对比）

[[email protected] ~]# ansible 192.168.1.112 -m command -a "ls -l /tmp removes=/tmp/test"
192.168.1.112 | success | rc=0 >>
skipped, since /tmp/test does not exist

[[email protected] ~]# ansible 192.168.1.112 -m command -a "ls -l /tmp removes=/tmp/rsync"
192.168.1.112 | success | rc=0 >>
total 4
drwxr-xr-x 2 root root 4096 Apr  2 02:04 rsync

[[email protected] ~]# 

/注意与creates的对比

2.script模块在远程机器上运行本地脚本。

    script模块的-a选项直接跟一个本地脚本的绝对路径，脚本的参数以空格隔开。该模块首先将指定的脚本传到远程节点上，然后在远程节点的shell环境下执行该脚本。

[[email protected] ~]# ansible 192.168.1.112 -m script -a "/root/test.sh"
192.168.1.112 | success >> {
    "changed": true, 
    "rc": 0, 
    "stderr": "", 
    "stdout": "ok\n"
}

/注意的是，这是本地的脚本在远程执行，这样执行的时候，脚本文件必须得有可执行权限/

3.shell模块，在远程节点执行命令

    shell模块的参数为命令名称，命令本身的参数以空格隔开。像command模块那样在远程节点执行命令，但shell模块再远程节点是通过shell环境(/bin/bash)执行命令的,该模块也可以执行一个shell脚本，但该脚本必须在远程节点上存在。

    chdir、creates、removes参数与command模块的参数一样。

[[email protected] ~]# ansible 192.168.1.112 -m shell -a " echo $HOME"
192.168.1.112 | success | rc=0 >>
/root


shell执行脚本文件
[[email protected] ~]# ansible 192.168.1.112 -m command  -a " echo $HOME"
192.168.1.112 | success | rc=0 >>
/root

[[email protected] ~]# ansible 192.168.1.112 -m shell -a "/bin/bash /root/test1.sh"
192.168.1.112 | FAILED | rc=127 >>
/bin/bash: /root/test1.sh: No such file or directory

[[email protected] ~]# vim test1.sh   /在远程节点上创建脚本文件
[[email protected] ~]# cat test1.sh 
#!/bin/bash
echo oK
[[email protected] ~]# 

[[email protected] ~]# ansible 192.168.1.112 -m shell -a "/bin/bash /root/test1.sh"
192.168.1.112 | success | rc=0 >>
oK

/sehll执行脚本文件，脚本文件必须在远程节点上存在

看一个简单的playbook文件：

[[email protected] ansible]# vim test.yml 

---
- hosts: 192.168.1.112
  remote_user: root

  tasks:
   - name: lianxi module 1
#file on the remote
     shell: /bin/bash /root/test1.sh
     
/playbook脚本是以.yml为后缀的！下面为执行结果
[[email protected] ~]# cd /etc/ansible
[[email protected] ansible]# ansible-playbook test.yml 

PLAY [192.168.1.112] ********************************************************** 

GATHERING FACTS *************************************************************** 
ok: [192.168.1.112]

TASK: [lianxi module 1] ******************************************************* 
changed: [192.168.1.112]

PLAY RECAP ******************************************************************** 
192.168.1.112              : ok=2    changed=1    unreachable=0    failed=0

4.文件相关模块：

    

copy 复制本地文件到远程路径下

copy模块将本地文件复制到远程路径下。fetch模块将远程文件复制到本地。

copy的选项：

dest 必选参数，为目标文件指定远程节点上的一个绝对路径。如果src是一个目录，那么该参数也必须是个目录。

src 本地文件的绝对路径，或者相对路径。如果是个路径则会递归复制，路径是以/结尾的话，只复制目录里面的内容，如果不以/几位的话会复制目

录本身和里面的内容。类似Rsync那样。

backup 可选参数，为源文件创建一个备份文件，被给备份文件添加一个时间戳信息。值为：yes/no，默认为no。

[[email protected] ~]# ansible 192.168.1.112 -m copy -a "src=/root/test  dest=/root/ backup=yes"
192.168.1.112 | success >> {
    "changed": true, 
    "checksum": "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83", 
    "dest": "/root/test", 
    "gid": 0, 
    "group": "root", 
    "md5sum": "d8e8fca2dc0f896fd7cb4cb0031ba249", 
    "mode": "0644", 
    "owner": "root", 
    "size": 5, 
    "src": "/root/.ansible/tmp/ansible-tmp-1459869115.84-179543827108657/source", 
    "state": "file", 
    "uid": 0
}

content 可选参数，当使用该参数来代替src的时候，会将内容直接写入到目标文件中。

[[email protected] ~]# ansible 192.168.1.112 -m copy -a "content=‘test test‘ dest=/root/test"
192.168.1.112 | success >> {
    "changed": true, 
    "checksum": "abedc47a5ede3fab13390898c5160ec9afbb6ec3", 
    "dest": "/root/test", 
    "gid": 0, 
    "group": "root", 
    "md5sum": "4f4acc5d8c71f5fbf04dace00b5360c8", 
    "mode": "0644", 
    "owner": "root", 
    "size": 9, 
    "src": "/root/.ansible/tmp/ansible-tmp-1459869735.21-149102614709149/source", 
    "state": "file", 
    "uid": 0
}


查看一下：
[[email protected] ~]# cat test
test test[[email protected] ~]#

    directory_mode 可选参数，当递归复制的时候，为所创建的目录设置权限，如果没有指定则使用系统的默认权限。该参数只影响新创建的目录，不会影响已经存在的目录。

[[email protected] ~]# ansible webservers -m copy -a "src=/root/test/ dest=/root/ directory_mode=0777"

force ,该参数默认值为yes,当远程文件与本地文件内容不一致的时候会替换远程文件。只有当远程目标文件不存在的时候才会传输文件。

group 文件或目录的所属组.

[[email protected] ~]# ansible webservers -m copy -a "src=/root/test/testgroup dest=/root/test1/testgroup group=liuzhenwei"

mode 文件或目录的权限，如0644。

[[email protected] ~]# ansible webservers -m copy -a "src=/root/test/testgroup dest=/root/test1/testgroup mode=0755"

看一下copy模块的返回值，各代表的意思：

src 要复制到远程节点的源文件路径

backup_file 远程节点上的备份文件路径，backup=yes的时候才有

uid 文件的所有者ID

dest 目标文件在远程节点上的绝对路径,/root/file.txt

checksum 校验值

md5sum md5校验值

state 状态，如 file

gid 文件的所属组ID

mode 文件的权限

owner 文件所有者

group 文件所属组

size 文件大小

本文出自 “自定义” 博客，谢绝转载！