Ansible常用模块
- 一、Ansible
- 二、Ansible环境安装部署
- 三、Ansible的模块（很重要)
一、Ansible
1.1 简介
Ansible是自动化运维工具，能实现跨主机对应用编排管理部署。
Ansible能批量配置、部署、管理上千台主机，是应用级别的跨主机编排工具。
比如以前需要切换到每个主机上执行的一或多个操作，使用Ansible只需在固定的一台Ansible控制节点上去完成所有主机的操作。
1.2 工作原理
基于模块工作，通过模块实现在被控制节点上执行相应的命令操作。
1.3 Ansible的特性
1.3.1 特性一：Agentless，即无Agent的存在
1）无客户端agent存在，不需要在被控制的节点上安装额外的客户端应用；
2）通过ssh协议与被控制节点通信。
1.3.2 特性二：幂等性
所谓幂等性，指的是无论执行多少次同样的运算，结果都是相同的，即一条命令，任意多次执行所产生的影响均与一次执行的影响相同。
Ansible的很多模块具有幂等性，如果多次模块操作的状态没有发生改变，则不会重复执行。
1.4 Ansible的基本组件
-
Inventory：Ansible管理的主机清单
/etc/anaible/hosts，需要管理的服务清单 ; -
Modules：Ansible执行命令的功能模块，多数为内置核心模块，也可自定义；
-
Plugins：模块功能的补充，如连接类型插件、循环插件、变量插件、过滤插件等，该功能不常用；
-
API：供第三方程序调用的应用程序编程接口。
-
Playbook：基于YAML格式的文件，用于定义和描述一系列任务。
二、Ansible环境安装部署
| 角色 | IP | 安装工具 |
|---|---|---|
| 管理端 | 192.168.2.100 | ansible |
| 被管理端1 | 192.168.2.102 | 无需安装 |
| 被管理端2 | 192.168.2.103 | 无需安装 |
2.1 安装ansible
在管理端安装 ansible。
#先安装 epel 源
yum install -y epel-release
#yum安装ansible
yum install -y ansible
#可选操作，修改被管理端的主机名，方便管理区分
hostnamectl set-hostname webserver
hostnamectl set-hostname dbserver
2.2 查看基本信息
ansible --version
#查看ansible 目录结构
tree /etc/ansible
├── ansible.cfg #ansible的配置文件，一般无需修改
├── hosts #ansible的主机清单，用于存储需要管理的远程主机的相关信息
└── roles/ #公共角色目录
2.3 配置远程主机清单
cd /etc/ansible
vim hosts
[webservers] #配置组名
192.168.2.102 #组里包含的被管理的主机IP地址或主机名（主机名需要先修改/etc/hosts文件）
[dbservers]
192.168.2.103
#配置密钥对验证
ssh-keygen -t rsa -P '' -f ~/.ssh/id_rsa
yum install -y sshpass
sshpass -p '123123' ssh-copy-id -o StrictHostKeyChecking=no [email protected]
sshpass -p '123123' ssh-copy-id -o StrictHostKeyChecking=no [email protected]
#免密登录测试，以被管理端1为例
ssh 192.168.2.102
三、Ansible的模块（很重要)
3.1 ansible的命令格式
#ansible命令格式
ansible 组名 -m 模块名 -a '参数'
#-a 用于向模块传递参数
#查看当前系统中的ansible模块
ansible-doc -l
#查看特定模块的摘要信息
ansible-doc -s <module_name>
3.2 Command模块
功能：在远程主机执行命令，此为默认模块，可忽略 -m 选项。
注意：此命令不支持 $VARNAME < > | ; & 等，即不支持管道符、重定向符号。
注意：此模块不具有幂等性
3.2.1 基本格式和常用参数
#基本格式
ansible <组名/IP> [-m command] -a '[参数] 命令'
| 常用参数 | 功能 |
|---|---|
| chdir | 在远程主机上运行命令前，提前进入目录 |
| creates | 判断指定文件是否存在，如果存在，不执行后面的操作 |
| removes | 判断指定文件是否存在，如果存在，执行后面的操作 |
3.2.2 举个例子
#指定组/IP执行命令
ansible 192.168.2.102 -m command -a 'date'
ansible webservers -a 'date'
#忽略-m选项，默认使用command格式
#chdir参数
ansible all -m command -a "chdir=/home ls ./"
#creates参数
ansible all -m command -a "creates=/opt/test.txt ls ./"
#removes参数
ansible all -m command -a "removes=/opt/test.txt ls ./"
3.3 shell模块
功能：和command模块类似，在远程主机执行命令，相当于调用远程主机的shell进程，然后在该shell下打开一个子shell运行命令。
注意：此模块不具有幂等性
注意：此模块支持管道符号等功能
3.3.1 基本格式和常用参数
ansible <组/IP/all> -m shell -a ' '
| 常用参数 | 功能 |
|---|---|
| chdir | 在远程主机上运行命令前，提前进入目录 |
| creates | 判断指定文件是否存在，如果存在，不执行后面的操作 |
| removes | 判断指定文件是否存在，如果存在，执行后面的操作 |
3.3.2 举个例子
#shell模块能够使用管道符
ansible dbservers -m shell -a "ifconfig | awk 'NR==2 {print \$2}'"
3.4 cron模块
功能：在远程主机定义crontab任务计划。
ansible-doc -s cron #按 q 退出
3.4.1 基本格式和常用参数
#基本格式
ansible <组/IP/all> -m cron -a ' '
| 常用参数 | 功能 |
|---|---|
| minute/hour/day/month/weekday | 分/时/日/月/周 |
| job | 任务计划要执行的命令 |
| name | 任务计划的名称 |
| user | 指定计划任务属于哪个用户，默认是root用户 |
| state | present表示添加（可以省略），absent表示移除。 |
3.4.2 举个例子
1）周一到周五早八点半和晚八点半 执行 复制/var/log/messages 到 /opt
ansible dbservers -m cron -a 'minute=30 hour="8,20" weekday="1-5" job="/usr/bin/cp -f /var/log/message /opt" name="backup1"'
2）每两个月的5 15 25 执行复制
ansible webservers -m cron -a 'day="5-25/10" month="*/2" job="/usr/bin/cp -f /var/log/message /opt" name="backup1"'
5-15/10 #隔十天
3）删除
指定状态为absent就行
ansible webservers -m cron -a 'name="backup1" state=absent'
3.5 user模块
功能：在远程主机管理用户账户
3.5.1 基本格式和常用参数
ansible <组/IP/all> -m user -a ' '
| 常用参数 | 功能 |
|---|---|
| name | 用户名，必选参数 |
| state=present|absent | 创建账号或者删除账号，present表示创建，absent表示删除 |
| system=yes|no | 是否为系统账号 |
| uid | 用户uid |
| group | 用户基本组 |
| groups | 用户所属附加组 |
| shell | 默认使用的shell |
| create_home=yes|no | 是否创建家目录 |
| password | 是否用户的密码，建议使用加密后的字符串 |
| remove=yes|no | 当state=absent时，是否删除用户的家目录 |
3.5.2 举个例子
ansible dbservers -m user -a 'name="test01"' #创建用户test01
ansible dbservers -m command -a 'tail -n1 /etc/passwd'
ansible dbservers -m user -a 'name="test01" state=absent' #删除用户test01
ansible dbservers -a 'tail -n1 /etc/passwd'
3.6 group模块
功能：在远程主机进行用户组管理的模块
3.6.1 常用参数
ansible <组/IP/all> -m group -a ' '
name：用户名，必选参数
state=present|absent：创建账号或者删除账号，present表示创建，absent表示删除
system=yes|no：是否为系统账号
gid:组id
3.6.2 举个例子
ansible dbservers -m group -a 'name=mysql gid=306 system=yes' #创建mysql组
ansible dbservers -m user -a 'name=test01 uid=306 system=yes group=mysql' #将test01用户添加到mysql组中
ansible dbservers -a 'id test01'
3.7 copy模块 （面试常问）
功能：从ansible服务器主控端复制文件到远程主机
注意：src=file 如果是没指明路径,则为当前目录或当前目录下的files目录下的file文件
3.7.1 基本格式和常用参数
#基本格式
ansible < > -m copy -a 'src= dest= [owner= ] [mode=] '
| 常用参数 | 功能 | 注意事项 |
|---|---|---|
| src | 指出源文件的路径，可以使用相对路径或绝对路径，支持直接指定目录 | 如果源是目录则目标也要是目录 |
| dest | 指出复制文件的目标及位置，使用绝对路径 | 如果源是目录，指目标也要是目录，如果目标文件已经存在会覆盖原有的内容 |
| mode | 指出复制时，目标文件的权限 | |
| owner | 指出复制时，目标文件的属主 | |
| group | 指出复制时，目标文件的属组 | |
| content | 指出复制到目标主机上的内容 | 不能与src一起使用 |
3.7.2 举个例子
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 'content="helloworld" dest=/opt/hello.txt'
#将helloworld写入/opt/hello.txt文件中
ansible dbservers -a 'cat /opt/hello.txt'
3.8 file模块
功能：在远程主机管理文件属性、创建软链接等
3.8.1 常用参数
#基本格式
ansible < > -m file -a ''
| 常用参数 | 功能 |
|---|---|
| path | 指定远程服务器的路径，也可以写成"dest"，“name” |
| state | 状态，可以将值设定为directory表示创建目录，设定为touch表示创建文件，设定为link表示创建软链接，设定为hard表示创建硬连接，设定为absent表示删除目录文件或链接 |
| mode | 文件复制到远程并设定权限，默认file=644，directory=755 |
| owner | 文件复制到远程并设定属主，默认为root |
| group | 文件复制到远程并设定属组，默认为root |
| recurese | 递归修改 |
| src | 指的是目标主机上的源文件。与copy模块不同。 |
3.8.2 举个例子
#修改文件的属主属组权限等
ansible dbservers -m file -a 'owner=test01 group=mysql mode=644 path=/opt/fstab.bak'
#软连接 state=link
ansible dbservers -m file -a 'path=/opt/fstab.link src=/opt/fstab.bak state=link'
#创建一个空文件,state=touch
ansible dbservers -m file -a "path=/opt/abc.txt state=touch"
#创建一个空目录,state=directory
ansible dbservers -m file -a "path=/data state=directory"
#删除一个文件,state=absent
ansible dbservers -m file -a "path=/opt/abc.txt state=absent"
ansible dbservers -a 'removes=/opt/abc.txt ls ./'
3.9 hostname模块
功能：用于管理远程主机上的主机名
#修改主机名
ansible dbservers -m hostname -a "name=mysql01"
3.10 ping模块
功能：测试远程主机的连通性。
ansible all -m ping
3.11 yum/apt 模块
功能：在远程主机上安装与卸载软件包
| 常用参数 | 功能 |
|---|---|
| name | 需要安装的服务名 |
| state=present(缺省值)/absent | 状态，abasent表示卸载服务 |
ansible webservers -m yum -a 'name=httpd' #安装服务
#卸载服务
ansible webservers -m yum -a 'name=httpd state=absent'
3.12 service/systemd 模块
功能：用于管理远程主机上的管理服务的运行状态。
| 常用参数 | 功能 |
|---|---|
| name | 指定需要控制的服务名称 |
| state | 指定服务状态，其值可以为stopped、started、reloaded、restarted、status |
| enabled | 指定服务是否为开机启动，yes为启动，no为不启动 |
| daemon_reload | yes：重启systemd服务，让unit文件生效 |
#先安装服务
ansible webservers -m yum -a 'name=httpd'
#启动httpd服务
ansible webservers -m service -a 'enabled=true name=httpd state=started'
#查看web服务器httpd运行状态
ansible webservers -a 'systemctl status httpd'
3.13 script 模块
功能：在远程主机执行shell脚本。
注意：script模块不具有幂等性，所以建议用剧本来执行。
#在本地写一个脚本
vim test.sh
#!/bin/bash
echo "hello ansible from script" > /opt/test2.txt、
chmod +x test.sh #给脚本执行权限
ansible dbservers -m script -a '/opt/test.sh' #远程运行本地脚本
ansible dbservers -a 'cat /opt/test2.txt' #查看生成的文件内容
3.14 mount 模块
功能：在远程主机挂载目录/设备文件
| 常用参数 | 功能 |
|---|---|
| src | 指定要挂载的设备或分区路径。 |
| path | 指定要挂载到的目标路径。 |
| fstype | 指定要挂载的文件系统类型。 |
| state | 指定挂载状态，可选值为 mounted、unmounted 或 absent。 |
| opts | 指定挂载选项，例如挂载选项或参数。 |
ansible dbservers -m mount -a 'src=/dev/sr0 path=/mnt state=mounted fstype=iso9660'
#使用 Ansible 的 mount 模块将设备 /dev/sr0 的内容挂载到目标路径 /mnt。
#文件系统类型为 iso9660，并将该设备标记为已挂载状态
3.15 archive 模块
功能：在远程主机压缩文件。
3.15.1 常用参数
| 常用参数 | 功能 |
|---|---|
| path | 指定要打包的源目录或文件的路径。 |
| dest | 指定打包文件的输出路径。 |
| format | 指定打包文件的格式，可以是 zip、tar、gz 或 bzip2。默认为 tar格式。 |
| remove | 指定是否在打包文件之后，删除源目录或文件。可选值为 yes 或 no。默认为 no，即不删除源目录或文件。 |
3.15.2 举个例子
ansible dbservers -m archive -a "path=/etc/yum.repos.d/ dest=/opt/repo.zip format=zip"
#remove参数的使用，压缩后删除源文件
ansible dbservers -m archive -a "path=/opt/test2.txt,/opt/123.txt dest=/opt/abc123.tar.gz format=gz remove=yes"
3.16 unarchive 模块
功能：将本地或远程主机的压缩包在远程主机解压缩 。
3.16.1 常用参数
| 常用参数 | 功能 |
|---|---|
| copy | 指定是否将打包文件复制到远程节点以进行解压缩。 |
| remote_src | (已弃用)改用 copy 参数。 |
| src | 指定要解压缩的打包文件路径，可以是本地路径或远程路径。 |
| dest | 指定要将文件解压缩到的目标目录。 |
| creates | 指定一个文件路径，如果该文件已经存在，则不进行解压缩操作。 |
| remote_tmp | 用于制定远程节点上的临时目录。默认为 /tmp。 |
#copy参数
copy参数的可选值为 `yes` 或 `no`。
默认为 `yes`，即先将文件从控制节点复制到远程节点，然后在远程节点上进行解压缩。
如果已经将文件分发到了目标节点并想要提高效率，可以将该值设置为 `no`。
反效果的参数为 `remote_src`。
3.16.2 举个例子
#现在ansible主机建立压缩包
tar cf test.tar.gz test.sh
#将 ansible 主机的压缩文件拷贝到到远程主机并解压，修改文件所属组和用户
ansible dbservers -m unarchive -a "src=/opt/test.tar.gz dest=/root copy=yes"
3.17 replace 模块
功能：在远程主机修改文件内容 。
类似于sed命令，主要也是基于正则进行匹配和替换。
3.17.1 常用参数
| 常用参数 | 功能 |
|---|---|
| path | 指定需要处理的文件路径 |
| regexp | 用于匹配需要替换内容的正则表达式 |
| replace | 用于替换匹配内容的字符串 |
| after | 在哪个字符串之后进行替换，默认为空 |
| before | 在哪个字符串之前进行替换，默认为空 |
| backup | 是否备份文件，选项为 yes 或 no |
3.17.2 举个例子
#在db服务器的主机下创建测试文件
vim /opt/test.txt
11 22 33 44 55 66
aa bb cc dd ee ff
1a 2b 3c 4d 5e 6f
#匹配 33 并修改为 ccc
ansible dbservers -m replace -a "path=/opt/test.txt regexp='33' replace='cc'"
#查看
ansible dbservers -a "cat /opt/test.txt"
#匹配到任意一个或多个开头的行增加注释
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'"
3.18 setup 模块
功能：使用facts组件获取远程主机的系统信息(facts信息)
| 常用参数 | 功能 |
|---|---|
| filter | 指定需要过滤的条件，仅返回满足条件的主机信息，默认为空 |
ansible webservers -m setup #获取mysql组主机的facts信息
ansible dbservers -m setup -a 'filter=*ipv4' #使用filter可以筛选指定的facts信息
facts信息
主机的各种信息，包括硬件、操作系统、网络等。
运行命令后，会返回一个包含主机 facts 信息的 JSON 格式输出。