ansible 19个核心模块

梦里遇见小熊

已于 2024-06-19 09:59:04 修改

阅读量1.8k

点赞数 31

文章标签：服务器 ansible 运维 linux centos php

于 2024-06-19 09:55:20 首次发布

本文链接：https://blog.csdn.net/m0_65305739/article/details/139794101

版权

1.setup #/.收集远程主机的详细信息
例子:
[root@localhost ~]# ansible wusen -m setup #/.收集远程主机系统的所有信息可以填写IP也可以填写组名

[root@localhost ~]# ansible wusen -m setup --tree /tmp/facts #/.搜集系统信息并以主机名为文件名分别保存在 /tmp/facts 目录，--tree /tmp/facts：这个选项指定了收集到的 facts（事实）信息的存储位置。

[root@localhost ~]# ansible wusen -m setup -a 'filter=ansible_*_mb' #/.收集远程主机内存相关的信息

2.ping #/.测试网络的连通性，ping模块没有参数
例子:
[root@localhost ~]# ansible wusen -m ping #/.检查wusen组的网络连通性

3.file #/.文件属性设置
3.1 force：需要在两种情况下强制创建软链接，一种是源文件不存在，但之后会建立的情况下；另一种是目标软链接已存在，需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no
group：定义文件/目录的属组
mode：定义文件/目录的权限
owner：定义文件/目录的属主
path：必选项，定义文件/目录的路径
recurse：递归设置文件的属性，只对目录有效
src：被链接的源文件路径，只应用于state=link的情况
dest：被链接到的路径，只应用于state=link的情况
state包括以下：
directory：如果目录不存在，就创建目录
file：即使文件不存在，也不会被创建
link：创建软链接
hard：创建硬链接
touch：如果文件不存在，则会创建一个新的文件，如果文件或目录已存在，则更新其最后修改时间
absent：删除目录、文件或者取消链接文件
例子:
[root@localhost ~]# ansible wusen -m file -a "src=/etc/resolv.conf dest=/tmp/resolv.conf state=link" #/.创建远程主机的文件软连接 src：指定源文件的路径，这里是 /etc/resolv.conf。这是系统用于 DNS 解析的配置文件。dest：指定目标文件的路径，这里是 /tmp/resolv.conf。file 模块将会在这个位置创建软链接。state：指定期望的文件状态。在这个例子中，state=link 表示 Ansible 将会确保在 dest 指定的路径上存在一个指向 src 指定路径的软链接

[root@localhost ~]# ansible wusen -m file -a "src=/etc/resolv.conf dest=/tmp/resolv.conf state=absent" #/.删除软连接

[root@localhost ~]# ansible wusen -m file -a "path=/root/testfile group=root owner=root mode=700 state=directory" #/.创建目录 path=/root/testfile 定义文件目录的路径名字，group=root 定义文件目录的属组，owner=root 定义文件目录的属主，mode=700 定义文件目录的权限，state=directory 验证目录是否存在，如果没有就创建目录文件

4.copy #/.复制文件到远程主机
4.1backup： #在覆盖之前，将源文件备份，备份文件包含时间信息。有两个选项：yes|no
content： #用于替代“src”，可以直接设定指定文件的值
dest： #必选项。要将源文件复制到的远程主机的绝对路径，如果源文件是一个目录，那么该路径也必须是个目录
directory_mode： #递归设定目录的权限，默认为系统默认权限
force： #如果目标主机包含该文件，但内容不同，如果设置为yes，则强制覆盖，如果为no，则只有当目标主机的目标位置不存在该文件时，才复制。默认为yes
others：#所有的file模块里的选项都可以在这里使用
group # 复制到远程主机后，指定文件或目录的属
mode # 复制到远程主机后，指定文件或目录权限,类似与 `chmod’指明如 0644
owner # 复制到远程主机后，指定文件或目录属主
src：被复制到远程主机的本地文件，可以是绝对路径，也可以是相对路径。如果路径是一个目录，它将递归复制。在这种情况下，如果路径使用“/”来结尾，则只复制目录里的内容，如果没有用“/”来结尾，则包含目录在内的整个内容全部复制，类似于rsync。
例子:
[root@localhost ~]# ansible wusen -m copy -a "src=/etc/ansible/ansible.cfg dest=/tmp/ansible.cfg.bak owner=root group=root mode=777" #/.将本地文件 “/etc/ansible/ansible.cfg” 复制到远程服务器，设置属主和属组及文件权限

5.command #/.在远程主机上执行命令注意：Command 不适用于有 shell 变量的情况，也不适用于有管道符或者 && 的情况，如果要使用此种情况，那么可以使用 shell 模块。
5.1creates：一个文件名，当该文件存在，则该命令不执行
free_form：要执行的linux指令
chdir：在执行指令之前，先切换到该目录
removes：一个文件名，当该文件不存在，则该选项不执行
executable：切换shell来执行指令，该执行路径必须是一个绝对路径
例子:
[root@localhost ~]# ansible wusen -m command -a 'uptime' #/.远程执行查看wusen群组的系统负载

6.shell #/.切换到某个shell执行指定的指令切换到某个 shell 执行指定的指令，与 command 不同的是，此模块可以支持命令管道，同时还有另一个模块也具备此功能：raw
6.1chdir # 执行之前，先cd到指定目录在执行命令
creates # 一个文件名，当这个文件存在，则该命令不执行
executable # 切换shell来执行命令，需要使用命令的绝对路径
free_form= # 执行的命令
removes # 一个文件名，这个文件不存在，则该命令不执行
下面是shell模块和command模块的优缺点
6.2 Ansible 的 shell 模块和 command 模块都用于在远程主机上执行命令，但它们在使用方式和功能上有一些区别：
Shell 模块：
○shell 模块默认使用登录用户的 shell 来执行命令。
○它允许使用管道（|）、重定向（>、<）和其他 shell 特性。
○shell 模块可以执行多条命令，并且可以接收包含换行符的复杂命令。
○它更适合执行那些需要 shell 特性的复杂命令或者脚本。
○shell 模块执行命令时，会输出命令的执行结果，包括标准输出和标准错误。
Command 模块：
○command 模块直接在 shell 中执行命令，不解析 shell 特性，这意味着它不支持管道、重定向等 shell 特性。
○它主要用于执行简单的命令或者命令序列，不支持复杂的 shell 脚本。
○command 模块一次只能执行一条命令，如果需要执行多条命令，必须使用分号（;）或者逻辑（&&）来连接。
○它不输出执行命令的过程，只返回命令执行的结果。
○command 模块在执行命令时，通常会更加直接和快速，因为它避免了 shell 解析命令的开销。
在实际使用中，如果你需要执行的命令不涉及复杂的 shell 特性，推荐使用 command 模块，因为它更简单、直接。如果你需要执行复杂的命令或者脚本，那么 shell 模块将是一个更好的选择。
例子:
[root@localhost ~]# ansible wusen -m shell -a "cat /etc/passwd | grep root" #/.查看用户存放路径过滤到root用户

[root@localhost ~]# ansible wusen -m shell -a 'bash /tmp/echo.sh' #/.远程执行脚本文件

7.script #/.指定本地的脚本文件，到远程主机运行一次注意：和 shell 模块的不同，shell 模块是要求客户端上有这个脚本才能执行；script 是要求 ansible 服务端有这个脚本就可以了，执行的时候是不会拷贝这个脚本到客户端的。
7.1creates # 一个文件名，当这个文件存在，则该命令不执行
free_form= # 本地脚本路径
removes # 一个文件名，这个文件不存在，则该命令不执行
例子:
[root@localhost ~]# ansible wusen -m script -a '/root/hello.sh' #/.ansible 端的已有脚本，就只有一条 /tmp/testscript 命令，该脚本被拿到客户端上执行，并返回结果

8.cron #/.任务时间管理
8.1 backup # 如果设置，创建一个crontab备份
cron_file # 如果指定, 使用这个文件cron.d，而不是单个用户crontab
day # 日应该运行的工作( 1-31, *, */2, etc )
hour # 小时 ( 0-23, *, */2, etc )
job # 指明运行的命令是什么
minute # 分钟( 0-59, *, */2, etc )
month # 月( 1-12, *, */2, etc )
name # 定时任务描述
reboot # 任务在重启时运行，不建议使用，建议使用special_time
special_time # 特殊的时间范围，参数：reboot（重启时）,annually（每年）,monthly（每月）,weekly（每周）,daily（每天）,hourly（每小时）
state # 指定状态，prsent表示添加定时任务，也是默认设置，absent表示删除定时任务
user # 以哪个用户的身份执行
weekday # 周 ( 0-6 for Sunday-Saturday, *, etc )
例子:
[root@localhost ~]# ansible wusen -m cron -a 'name="ntp datatime job" minute=*/3 hour=* day=* month=* weekday=* job="echo `date` >> /tmp/linshidata.txt"' #/. -m cron：-m 选项用于指定要使用的模块。在这里，cron 模块被用来创建和管理 cron 任务。 -a：这个选项后面跟着的是模块的参数，用 JSON 格式表示。 name="ntp datetime job"：为创建的 cron 任务指定一个名称，这里名称为 ntp datetime job。这个名称用于在查看或管理 cron 任务时进行识别。 minute=*/3：设置任务的分钟字段为 */3，表示每隔 3 分钟执行一次。 hour=*：设置任务的小时字段为 *，表示每个小时都有效。 day=*：设置任务的日期字段为 *，表示每天的任何日期都有效。 month=*：设置任务的月份字段为 *，表示每个月都有效。 weekday=*：设置任务的工作日字段为 *，表示每周的任何一天都有效。 job="echo date >> /tmp/linshidata.txt"：设置任务要执行的命令。这个命令使用 date 命令获取当前的日期和时间，然后使用 echo 命令将这些信息追加到 /tmp/linshidata.txt 文件中。

群组主机验证

[root@localhost ~]# ansible wusen -m cron -a 'name="ntp datatime job" minute=*/3 hour=* day=* month=* weekday=* job="echo `date` >> /tmp/linshidata.txt" state=absent' #/.删除计划任务

再次验证计划任务会清空，但是输出到的文件会保留

9.yum #/.使用yum安装管理
9.1conf_file # yum的配置文件
disable_gpg_check # 关闭gpg_check
disablerepo # 不启用某个源
enablerepo # 启用某个源
List # 非幂等性命令
name= # 指定要安装的包，如果有多个版本需要指定版本，否则安装最新的包
state # 安装(`present’)，安装最新版(`latest’)，卸载程序包(`absent’)
例子:
[root@localhost ~]# ansible wusen -m yum -a "name=httpd state=present" #/.使用yum批量安装http服务

[root@localhost ~]# yum install epel-release #/.客户端因为阿里镜像没有nginx的安装包，需要先下载epel源
[root@localhost ~]# ansible wusen -m yum -a "name=nginx-1.20.1 state=latest" #/.指定安装最新的版本

[root@localhost ~]# ansible wusen -m yum -a "name=/root/elasticsearch-7.12.0-x86_64.rpm state=present" #/.指定rpm包路径进行批量安装

[root@localhost ~]# ansible wusen -m yum -a "name=https://artifacts.elastic.co/downloads/logstash/logstash-7.12.0-x86_64.rpm state=present"
#/.指定远程网址来安装服务

[root@localhost ~]# ansible wusen -m yum -a "name=nginx-1.20.1 state=absent" #/.卸载服务

10.service #/.系统服务管理
10.1arguments # 向服务传递的命令行参数
enabled # 设置服务开机自动启动，参数为yes|no
name= # 控制服务的名称
pattern # 如果通过status指令来查看服务的状态时，没有响应，就会通过ps指令在进程中根据该模式进行查找，如果匹配到，则认为该服务依然在运行
runlevel # 设置服务自启动级别
sleep # 如果执行了restarted，则在stop和start之间沉睡几秒钟
state # 启动`started’ 关闭`stopped’ 重新启动 `restarted’ 重载 `reloaded’
例子:
[root@localhost ~]# ansible wusen -m service -a "name=httpd state=started enabled=yes" #/.name=httpd 指定服务的名称 state=started 启动服务 enabled=yes 设置开机自启

[root@localhost ~]# ansible wusen -m service -a "name=httpd state=restarted sleep=10" #/. 重启 httpd 服务，中间 sleep 10 秒钟

11.group #/.系统用户组管理
gid # 设置组的GID号
name= # 管理组的名称
state # 指定组状态，默认为创建，设置值为absent为删除
system # 设置值为yes，表示为创建系统组
例子:
[root@localhost ~]# ansible wusen -m group -a "name=foo gid=360 system=no" #/.创建组名叫foo 组GID号为360

[root@localhost ~]# ansible wusen -m group -a "name=foo gid=360 system=no state=absent" #/.删除用户管理组

12.user #/.系统用户账号管理
12.1 comment # 用户的描述信息
createhome # 是否创建家目录
force # 在使用`state=absent’时, 行为与`userdel –force’一致.
group # 指定基本组
groups # 指定附加组，如果指定为(‘groups=’)表示删除所有组
home # 指定用户家目录
login_class # 可以设置用户的登录类 FreeBSD, OpenBSD and NetBSD系统.
move_home # 如果设置为`home=’时, 试图将用户主目录移动到指定的目录
name= # 指定用户名
non_unique # 该选项允许改变非唯一的用户ID值
password # 指定用户密码
remove # 在使用 `state=absent’时, 行为是与 `userdel –remove’一致.
shell # 指定默认shell
state #设置帐号状态，不指定为创建，指定值为absent表示删除
system # 当创建一个用户，设置这个用户是系统用户。这个设置不能更改现有用户。
uid #指定用户的uid
update_password # 更新用户密码
例子:
[root@localhost ~]# ansible wusen -m user -a "name=foo password=123456 home=/home/foo shell=/sbin/nologin" #/.添加用户 foo，指定密码，设置家目录，不允许远程登录

[root@localhost ~]# ansible wusen -m user -a "name=foo remove=yes state=absent" 彻底删除用户包括用户组 name=foo 指定要删除的名字

13.stat #/.获取远程文件信息
[root@localhost ~]# ansible wusen -m stat -a "path=/etc/passwd"

14.mount #/.配置挂载点
14.1 fstype：必选项，挂载文件的类型
name：必选项，挂载点
opts：传递给mount命令的参数
src：必选项，要挂载的文件
state：必选项
present：只处理fstab中的配置
absent：删除挂载点
mounted：自动创建挂载点并挂载之
umounted：卸载
例子:
[root@localhost ~]# ansible wusen -m mount -a "name=/mnt src=/dev/sda5 fstype=ext4 opts=ro state=present"

15.fetch #/.将远程主机中的文件拷贝到本机中注意：和 copy 模块的作用刚刚相反，并且在保存的时候使用 hostname 来进行保存，当文件不存在的时候，会出现错误，除非设置了选项 fail_on_missing 为 yes。
15.1 Dest:用来存放文件的目录，例如存放目录为backup，源文件名称为/etc/profile在主机pythonserver中，那么保存为/backup/pythonserver/etc/profile
Fail_on_missing: Yes/no,当源文件不存在的时候，标识为失败
Flat: 允许覆盖默认行为从hostname/path到/file的，如果dest以/结尾，它将使用源文件的基础名称
Src: 在远程拉取的文件，并且必须是一个file，不能是目录
Validate_checksum Yes/no,当文件 fetch 之后进行 md5 检查
例子:
[root@localhost ~]# ansible wusen -m fetch -a "src=/root/xiaoxiong dest=/root" #/.src 表示为远程主机上需要传送的文件的路径，dest 表示为本机上的路径，在传送过来的文件，是按照 IP 地址或 hostname 进行分类，然后路径是源文件的路径，例如上面的最终路径为 /root/192.168.1.50/root/123 在拉取文件的时候，必须拉取的是文件，不能拉取文件夹

16.synchronize #/.将主控方/root/TZT目录推送到指定节点的/tmp目录下
16.1 archive # 是否采用归档模式同步，即以源文件相同属性同步到目标地址
checksum # 是否效验
compress # 开启压缩，默认为开启
copy_links # 同步的时候是否复制连接
delete # 删除源中没有而目标存在的文件（即以推送方为主）
dest= # 目标地址
dest_port # 目标接受的端口，ansible配置文件中的 ansible_ssh_port 变量优先级高于该 dest_port 变量
dirs # 以非递归的方式传输目录
existing_only #跳过在接收端创建新文件
group # 保留组
links # 将符号链接作为符号链接复制
mode # 模式，rsync 同步的方式 PUSH\PULL，默认都是推送push。如果你在使用拉取pull功能的时候，可以参考如下来实现mode=pull 更改推送模式为拉取模式
recursive # 是否递归 yes/no
rsync_opts # 使用rsync 的参数
rsync_path # 服务的路径，指定 rsync 命令来在远程服务器上运行。这个参考rsync命令的--rsync-path参数，--rsync-path=PATH # 指定远程服务器上的rsync命令所在路径信息
rsync_timeout # 指定 rsync 操作的 IP 超时时间，和rsync命令的 --timeout 参数效果一样.
set_remote_user # put user@ for the remote paths. If you have a custom ssh config to define the remote user forsrc=\‘#\‘" # 源，同步的数据源
times #控制是否在同步过程中保留文件的时间戳（修改时间、访问时间等）。
--exclude=.Git #忽略同步.git结尾的文件
注意:由于模块默认启用了 archive 参数，该参数默认开启了 recursive, links, perms, times, owner，group 和 -D 参数。如果你将该参数设置为 no，那么你将停止很多参数，比如会导致如下目的递归失败，导致无法拉取。
例子:
yum install rsync #/.主控点和被控点都需要安装，如果节点比较多可以使用YUM模块批量安装
[root@localhost ~]# ansible wusen -m synchronize -a 'src=/root/TZT dest=/tmp/ compress=yes' #/.压缩传输 TZT目录到被控节点

[root@localhost ~]# ansible wusen -m synchronize -a 'mode=pull src=/tmp/TZT dest=/root/ compress=yes' #/.将被控端的文件拉去到主控端

17.get_url #/.将某个 url 的文件下载到被控节点的某个位置
例子:
[root@localhost ~]# ansible wusen -m get_url -a "url=https://artifacts.elastic.co/downloads/kibana/kibana-7.12.0-x86_64.rpm dest=/tmp/"

18.hostname #/.批量修改主机名称
注:在查看的时候，主要查看文件 /etc/sysconfig/network，重启之后才能生效
[root@localhost ~]# ansible wusen -m hostname -a "name=ansible-test" #/.更改组内主机名称

19.wait_for #/.等待一个事件发生或处理完后，再继续运行下面的事情
19.1 connect_timeout #默认5秒，在下一个事情发生前等待链接的时间，单位是秒
delay #延时，在做下一个事情前延时多少秒
host #默认127.0.0.1，执行这个模块的host
path #当一个文件存在于文件系统中，下一步才继续。
port #端口号，如8080
state# 默认started，对象是端口的时候start状态会确保端口是打开的，stoped状态会确认端口是关闭的
present #对象是文件的时候present或者started会确认文件是存在的，而absent会确认文件是不存在的。
started #用于检查一个服务是否已经启动并正在运行
stopped #用于检查一个服务或进程是否已经停止运行
absent #删除
例子:
[root@localhost ~]# ansible wusen -m wait_for -a "port=80 delay=10" #/.10 秒后在当前主机开始检查 80 端口，直到端口启动后返回