Ansible常用模块详解
一、Ansible简介
1、Ansible是什么？
ansible 自动化运维工具，也叫机器管理工具。可以实现批量管理成百上千的多台主机，是应用级别的跨主机编排工具。
2、Ansible是怎么工作的？
Ansible是基于模块工作的，它只是提供了一种运行框架，它本身没有完成任务的能力，真正执行操作的是Ansible的模块， 比如copy模块用于拷贝文件到远程主机上，service模块用于管理服务的启动、停止、重启等。
3、Ansible的特性
1）无客户端agent的存在，不需要在被控制的节点上安装任何客户端应用。
2）通过ssh协议与被控制节点通信
3）基于模块工作的，可以通过模块实现在被控制节点上执行相应的命令操作
4）很多模块具有幂等性，即可实现多次模块操作的状态如果没有发生改变，则不会重复执行
二、Ansible 环境安装部署
| 主机 | IP地址 | 安装 |
|---|---|---|
| 管理端 | 192.168.210.101 | ansible |
| 被管理端 | 192.168.210.102 | |
| 被管理端 | 192.168.210.103 |
//管理端安装 ansible
yum install -y epel-release //先安装 epel 源
yum install -y ansible
//配置主机清单
cd /etc/ansible
vim hosts
[webservers] #配置组名
192.168.210.102 #组里包含的被管理的主机IP地址或主机名（主机名需要先修改/etc/hosts文件）
[dbservers]
192.168.210.103
//配置密钥对验证
#生成空密码的密钥对
ssh-keygen -t rsa -P '' -f ~/.ssh/id_rsa
sshpass -p '123123' ssh-copy-id -o StrictHostKeyChecking=no root@192.168.210.102
sshpass -p '123123' ssh-copy-id -o StrictHostKeyChecking=no root@192.168.210.103
三、Ansible 命令行模块
命令格式：ansible <组名> -m <模块> -a <参数列表>
ansible-doc -l #列出所有已安装的模块，按q退出
1、command 模块
在远程主机执行命令，不支持管道，重定向等shell的特性。
ansible-doc -s command #-s 列出指定模块的描述信息和操作动作
ansible 192.168.210.101 -m command -a 'date' #指定 ip 执行 date
ansible webservers -m command -a 'ifconfig' #指定组执行 ifconfig
ansible dbservers -m command -a 'ifconfig' #显示目标主机的网卡配置信息
ansible all -m command -a 'date' #all 代表所有 hosts 主机
ansible all -a 'ls /' #如省略 -m 模块，则默认运行 command 模块
| 常用参数 | 功能 |
|---|---|
| chdir | 在远程主机上运行命令前提前进入目录 |
| creates | 判断指定文件是否存在，如果存在，不执行后面的操作 |
| removes | 判断指定文件是否存在，如果存在，执行后面的操作 |
#chdir 切换到相关目录然后执行相关命令
ansible dbservers -m command -a "chdir=/home ls ./"
#判断abc.txt文件是否存在，如果存在就会跳到后面的命令操作，如果不存在就会执行后面的命令操作
ansible dbservers -m command -a "creates=/opt/abc.txt touch /opt/123.txt"
ansible dbservers -m command -a "creates=/opt/123.txt touch /opt/abc.txt"
#判断指定文件是否存在，如果存在，执行后面的操作,如果不存在，跳过后面的操作
ansible dbservers -m command -a "removes=/opt/123.txt touch /opt/abc.txt"
ansible dbservers -m command -a "removes=/opt/123.txt rm -rf /opt/abc.txt"
ansible dbservers -m command -a "removes=/opt/abc.txt rm -rf /opt/123.txt"
2、shell 模块
在远程主机执行命令，相当于调用远程主机的shell进程，然后在该shell下打开一个子shell运行命令（支持管道符号等功能）
ansible-doc -s shell #列出指定模块的描述信息和操作动作
ansible dbservers -m shell -a 'ifconfig'
ansible dbservers -m shell -a 'ifconfig ens33 | awk "NR==2{print}"'
ansible dbservers -m shell -a 'ifconfig ens33 | awk "NR==2{print \$2}"'
#重定向输出
ansible dbservers -m shell -a 'echo 123abc > /opt/123.txt'
3、cron 模块
在远程主机定义任务计划。其中有两种状态（state）：present表示添加（可以省略），absent表示移除。
| 常用参数 | 功能 |
|---|---|
| minute/hour/day/month/weekday | 分/时/日/月/周 |
| job | 任务计划要执行的命令 |
| name | 任务计划的名称 |
| user | 指定计划任务属于哪个用户，默认是root用户 |
ansible-doc -s cron #按 q 退出
#每周二的凌晨2：30做一次系统日志备份到opt目录里
ansible webservers -m cron -a 'minute=30 hour=2 weekday=2 job="/bin/cp -f /var/log/messages /opt/" name="backup syslog"'
ansible webservers -a 'crontab -l'
#删除crontab任务
ansible webservers -m cron -a 'name="backup syslog" state=absent'
4、user 模块
用户管理的模块
| 常用参数 | 功能 |
|---|---|
| name | 用户名，必选参数 |
| state=present|absent | 创建账号或者删除账号，present表示创建，absent表示删除 |
| system=yes|no | 是否为系统账号 |
| group | 用户基本组 |
| groups | 用户所属附加组 |
| shell | 默认使用的shell |
| create_home=yes|no | 是否创建家目录 |
| password：用户的密码 | 用户的密码，建议使用加密后的字符串 |
| remove=yes|no | 当state=absent时，是否删除用户的家目录 |
| uid | 用户uid |
//用户管理的模块
ansible-doc -s user #列出指定模块的描述信息和操作动作
ansible dbservers -m user -a 'name="test01" uid=9527 groups=wheel' #创建用户test01
ansible dbservers -m command -a 'tail /etc/passwd' #查看
ansible dbservers -m user -a 'name="test01" state=absent' #删除用户test01
5、group 模块
用户组管理的模块
ansible-doc -s group #列出指定模块的描述信息和操作动作
ansible dbservers -m group -a 'name=mysql gid=306 system=yes' #创建mysql组
ansible dbservers -a 'tail /etc/group'
ansible dbservers -m user -a 'name=test01 uid=306 system=yes group=mysql' #将test01用户添加到mysql组中
ansible dbservers -a 'tail /etc/passwd'
ansible dbservers -a 'id test01'
6、copy 模块
用于复制指定主机文件到远程主机
| 常用参数 | 功能 |
|---|---|
| dest | 指出复制文件的目标及位置，使用绝对路径，如果源是目录，指目标也要是目录，如果目标文件已经存在会覆盖原有的内容 |
| src | 指出源文件的路径，可以使用相对路径或绝对路径，支持直接指定目录，如果源是目录则目标也要是目录 |
| mode | 指出复制时，目标文件的权限 |
| owner | 指出复制时，目标文件的属主 |
| group | 指出复制时，目标文件的属组 |
| content | 指出复制到目标主机上的内容，不能与src一起使用 |
ansible-doc -s copy #列出指定模块的描述信息和操作动作
#将/etc/fstab文件复制到/opt目录下
ansible dbservers -m copy -a 'src=/etc/fstab dest=/opt/fstab.bak owner=root mode=640'
ansible dbservers -a 'ls -l /opt'
ansible dbservers -a 'cat /opt/fstab.bak'
#源目标后面不加/复制的是目录，加/复制的是目录下的文件
ansible dbservers -m copy -a 'src=/etc/yum.repos.d dest=/opt/rh/'
ansible dbservers -a 'ls /opt/rh/'
ansible dbservers -m copy -a 'src=/etc/yum.repos.d/ dest=/opt/rh/'
ansible dbservers -a 'ls /opt/rh/'
#将helloworld写入/opt/hello.txt文件中
ansible dbservers -m copy -a 'content="helloworld" dest=/opt/hello.txt'
ansible dbservers -a 'cat /opt/hello.txt'
7、file 模块
设置文件属性
ansible-doc -s file #列出指定模块的描述信息和操作动作
ansible dbservers -m file -a 'owner=test01 group=mysql mode=644 path=/opt/fstab.bak' #修改文件的属主属组权限等
ansible dbservers -a 'ls -l /opt'
#创建一个空文件
ansible dbservers -m file -a "path=/opt/abc.txt state=touch"
ansible dbservers -a 'cat /opt/abc.txt'
#创建一个空目录
ansible dbservers -m file -a "path=/opt/abc state=directory"
ansible dbservers -a 'ls /opt/abc'
#删除一个文件
ansible dbservers -m file -a "path=/opt/abc.txt state=absent"
ansible dbservers -a 'ls /opt'
ansible dbservers -m file -a 'path=/opt/fstab.link src=/opt/fstab.bak state=link' #设置/opt/fstab.link为/opt/fstab.bak的链接文件
ansible dbservers -a 'ls -l /opt'
8、hostname 模块
用于管理远程主机上的主机名
ansible dbservers -m hostname -a "name=ansible-agent02"
ansible dbservers -a 'hostname'
9、ping 模块
检测远程主机的连通性
ansible dbservers -m ping #检测dbservers组的连通性
ansible all -m ping #检测所有组的连通性
10、yum 模块
在远程主机上安装与卸载软件包
ansible-doc -s yum #列出指定模块的描述信息和操作动作
ansible webservers -m yum -a 'name=httpd state=present' #安装服务
ansible webservers -m yum -a 'name=httpd state=absent' #卸载服务
#安装nginx
ansible webservers -m copy -a 'src=/etc/yum.repos.d/nginx.repo dest=/etc/yum.repos.d/nginx.repo'
ansible webservers -m yum -a 'name=nginx state=latest'
11、service/systemd 模块
用于管理远程主机上的管理服务的运行状态
ansible-doc -s service #列出指定模块的描述信息和操作动作
| 常用参数 | 功能 |
|---|---|
| name | 被管理的服务名称 |
| state=started|stopped|restarted | 动作包含启动关闭或者重启 |
| enabled=yes|no | 表示是否设置该服务开机自启 |
| runlevel | 如果设定了enabled开机自启去，则要定义在哪些运行目标下自启动 |
ansible webservers -a 'systemctl status nginx' #查看web服务器nginx运行状态
ansible webservers -m service -a 'enabled=yes name=nginx state=started' #启动nginx服务
12、script 模块
实现远程批量运行本地的 shell 脚本
ansible-doc -s script #列出指定模块的描述信息和操作动作
#准备一个脚本
vim test.sh
#!/bin/bash
echo "hello ansible from script" > /opt/script.txt
chmod +x test.sh
ansible webservers -m script -a 'test.sh'
ansible webservers -a 'cat /opt/script.txt'
#脚本传参的方式
vim test.sh
#!/bin/bash
MYNAME=$1
MYLIKE=$2
MYFILE=$3
echo "$MYNAME like $MYLIKE" > /opt/$MYFILE
ansible webservers -m script -a 'test.sh abc 123! test.txt'
ansible webservers -a 'cat /opt/test.txt'
13、 mount 模块
挂载文件系统
ansible-doc -s mount #列出指定模块的描述信息和操作动作
| 常用参数 | 功能 |
|---|---|
| src | 定义挂载设备的路径 |
| path | 定义挂载到哪个目录，必须指定 |
| fstype | 指定挂载文件的系统类型，必须指定，xfs、iso9660、nfs… |
| opts | 定义挂载的参数，defaults、rw、ro… |
| state | 定义挂载的状态，mounted（进行挂载，修改/etc/fstab信息）、absent（永久性卸载，并修改 /etc/fstab信息）、unmounted（临时卸载，不修改/etc/fstab信息） |
#给192.168.210.102主机添加一块硬盘
echo "- - -" > /sys/class/scsi_host/host0/scan #刷新
echo "- - -" > /sys/class/scsi_host/host1/scan
echo "- - -" > /sys/class/scsi_host/host2/scan
lsblk #查看
mkfs -t xfs /dev/sdb #格式化
#创建一个目录
ansible webservers -m file -a "path=/data state=directory"
#挂载
ansible webservers -m mount -a 'src=/dev/sdb path=/data state=mounted fstype=xfs'
#查看
ansible webservers -a 'df -Th'
#解挂载
ansible webservers -m mount -a 'src=/dev/sdb path=/data state=unmounted'
ansible webservers -m mount -a 'path=/data state=absent' #absent解挂载，/etc/fstab文件里的配置也就没有了，unmounted解挂载/etc/fstab里的配置还有
#查看
ansible webservers -a 'df -Th'
14、archive 模块
打包压缩
ansible-doc -s archive #列出指定模块的描述信息和操作动作
| 常用参数 | 功能 |
|---|---|
| path | 必须参数，远程主机上需要被打包压缩的源文件/目录 |
| dest | 打包压缩后的包文件路径(包文件的父目录必须存在);如果包文件已存在，则会被覆盖 |
| format | 指定压缩类型，包括: bz2、gz（默认）、tar、xz、zip |
| remove=yes|no | 是否删除源文件 |
#压缩/opt目录下的文件
ansible dbservers -m archive -a "path=/opt/123.txt,/opt/hello.txt dest=/opt/wyx.tar.gz format=gz remove=yes"
#查看
ansible dbservers -a 'ls /opt'
#对/opt/下的rh目录进行压缩
ansible dbservers -m archive -a "path=/opt/rh dest=/opt/rh.zip format=zip"
ansible dbservers -a 'ls /opt'
15、unarchive 模块
解包解压缩
ansible-doc -s unarchive #列出指定模块的描述信息和操作动作
| 常用参数 | 功能 |
|---|---|
| copy | 默认为 copy=yes ，拷贝的文件从 ansible 主机复制到远程主机，copy=no 表示在远程主机上寻找源文件解压 |
| src | tar包源路径，可以是 ansible 主机上的路径，也可以是远程主机上的路径，如果是远程主机上的路径，则需设置 copy=no |
| dest | 解压后文件的目标绝对路径 |
| remote_src | 和 copy 功能一样且互斥，设置 remote_src=yes 表示文件在远程主机上，设置为 remote_src=no 表示文件在 ansible 主机上 |
#在远程主机解包
ansible dbservers -m unarchive -a "src=/opt/wyx.tar.gz dest=/root copy=no"
或者
ansible dbservers -m unarchive -a "src=/opt/wyx.tar.gz dest=/root remote_src=yes"
#查看
ansible dbservers -a 'ls /root'
tar zcf /opt/yum.tar.gz /etc/yum.repos.d
tar tf yum.tar.gz
#将 ansible 主机的压缩文件拷贝到到远程主机并解压
ansible dbservers -m unarchive -a "src=/opt/yum.tar.gz dest=/root copy=yes"
或者
ansible dbservers -m unarchive -a "src=/opt/yum.tar.gz dest=/root remote_src=no"
16、replace 模块
类似于sed命令，主要也是基于正则进行匹配和替换
ansible-doc -s replace #列出指定模块的描述信息和操作动作
| 常用参数 | 功能 |
|---|---|
| path | 必须参数，指定要修改的文件 |
| regexp | 必须参数，指定一个正则表达式 |
| replace | 替换regexp参数匹配到的字符串 |
| backup=yes|no | 修改源文件前创建一个包含时间戳信息的备份文件 |
| before | 如果指定，则仅替换/删除此匹配之前的内容，可以和after参数结合使用 |
| after | 如果指定，则仅替换/删除此匹配之后的内容，可以和before参数结合使用 |
| owner | 修改文件用户名 |
| group | 修改文件组名 |
| mode | 修改文件权限 |
vim /opt/test.txt
11 22 33 44 55 66
aa bb cc dd ee ff
1a 2b 3c 4d 5e 6f
#匹配 33 并修改为 cc
ansible dbservers -m replace -a "path=/opt/test.txt regexp='33' replace='cc'"
#匹配到任意一个或多个开头的行增加注释
ansible dbservers -m replace -a "path=/opt/test.txt regexp='^(.*)' replace='#\1'"
#取消注释
ansible dbservers -m replace -a "path=/opt/test.txt regexp='^#(.*)' replace='\1'"
#匹配以 a 开头的后面有一个或者多个字符的行，并在前面添加 # 注释
ansible dbservers -m replace -a "path=/opt/test.txt regexp='^(a.*)' replace='#\1'"
#匹配cc前面有3的行，把3替换为three
ansible dbservers -m replace -a "path=/opt/test.txt regexp='3' replace='three' before=cc"
17、setup 模块
facts 组件是用来收集被管理节点信息的，使用 setup 模块可以获取这些信息
ansible-doc -s setup #列出指定模块的描述信息和操作动作
ansible webservers -m setup #获取mysql组主机的facts信息
ansible dbservers -m setup -a 'filter=*ipv4' #使用filter可以筛选指定的facts信息
1409
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
