ansible 常用模块
主机连通性测试
ansible web1 -m ping
command 模块
这个模块可以直接在远程主机上执行命令,并将结果返回本主机
[root@pa1 ~]#ansible web1 -m command -a 'df -h'
- command模块一些常用命令
chdir # 在执行命令之前,先切换到该目录
executable # 切换shell来执行命令,需要使用命令的绝对路径
free_form # 要执行的Linux指令,一般使用Ansible的-a参数代替。
creates # 一个文件名,当这个文件存在,则该命令不执行,可以用来做判断
removes # 一个文件名,这个文件不存在,则该命令不执行
- 错误示范 chdir
[root@pa1 ~]#ansible web1 -m command -a 'chdir=/etc ll'
120.78.202.71 | FAILED | rc=2 >>
[Errno 2] No such file or directory
58.87.104.81 | FAILED | rc=2 >>
[Errno 2] No such file or directory
- 解释 command模块里面的命令不可以使用别名
正确示范 chdir
[root@pa1 ~]#ansible pa -m command -a 'chdir=/data ls'
120.78.202.71 | success | rc=0 >>
58.87.104.81 | success | rc=0 >>
111.txt
222.txt
[root@pa1 ~]#ansible pa -m command -a 'chdir=/data ls -l'
120.78.202.71 | success | rc=0 >>
total 0
58.87.104.81 | success | rc=0 >>
total 0
-rw-r--r-- 1 root root 0 Feb 22 17:41 111.txt
-rw-r--r-- 1 root root 0 Feb 22 17:41 222.txt
- 示范 creates 和removes
[root@server ~]# ansible web1 -m command -a 'creates=/data/aaa.jpg ls' #如果/data/aaa.jpg存在,则不执行“ls”命令
120.78.202.71| SUCCESS | rc=0 >>
skipped, since /data/aaa.jpg exists
58.87.104.81 | SUCCESS | rc=0 >>
skipped, since /data/aaa.jpg exists
[root@server ~]# ansible web1 -m command -a 'removes=/data/aaa.jpg cat /data/a' #如果/data/aaa.jpg存在,则执行“cat /data/a”命令
120.78.202.71| SUCCESS | rc=0 >>
hello
58.87.104.81| SUCCESS | rc=0 >>
hello
shell 模块
shell模块可以在远程主机上调用shell解释器运行命令,支持shell的各种功能,例如管道等
示范
[root@pa1 ~]#ansible web1 -m shell -a 'cat /etc/passwd |grep "root"'
120.78.202.71 | success | rc=0 >>
root❌0:0:root:/root:/bin/bash
58.87.104.81 | success | rc=0 >>
root❌0:0:root:/root:/bin/bash
lijinghua❌1001:1001::/home/lijinghua:/root/jumpserver-master/init.sh
只要是我们的shell命令,都可以通过这个模块在远程主机上运行
copy 模块
这个模块用于将文件复制到远程主机,同时支持给定内容生成文件和修改权限等
- 相关参数 src #被复制到远程主机的本地文件。可以是绝对路径,也可以是相对路径。如果路径是一个目录,则会递归复制,用法类似于"rsync"
content #用于替换"src",可以直接指定文件的值
dest #必选项,将源文件复制到的远程主机的绝对路径
backup #当文件内容发生改变后,在覆盖之前把源文件备份,备份文件包含时间信息
directory_mode #递归设定目录的权限,默认为系统默认权限
force #当目标主机包含该文件,但内容不同时,设为"yes",表示强制覆盖;设为"no",表示目标主机的目标位置不存在该文件才复制。默认为"yes"
others #所有的 file 模块中的选项可以在这里使用
复制文件示范
[root@pa1 ~]#ansible pa -m copy -a 'src=/root/tale.txt dest=/root/lijinghua.txt'
-
注意 dest文件可以没有,但是rsc文件必须有,注意加上路径
-
给定内容生成文件,并制定权限 示范
[root@pa1 ~]#ansible pa -m copy -a 'content="i am lijinghua!" dest=/root/lijinghua.txt mode=666' #指定文件lijinghua.txt内容为i am lijinghua!,并设置权限为666
- 关于覆盖示范
我们把文件的内容修改一下,然后选择覆盖备份:
[root@pa1 ~]#ansible pa -m copy -a 'content="I am \tlijinghua\n" backup=yes dest=/data/name.txt mode=666'
file模块
该模块主要用于设置文件的属性,比如创建文件、创建链接文件、删除文件等
force #需要在两种情况下强制创建软链接,一种是源文件不存在,但之后会建立的情况下;另一种是目标软链接已存在,需要先取消之前的软链,然后创建新的软链,有两个选项:yes|no
group #定义文件/目录的属组。后面可以加上mode:定义文件/目录的权限
owner #定义文件/目录的属主。后面必须跟上path:定义文件/目录的路径
recurse #递归设置文件的属性,只对目录有效,后面跟上src:被链接的源文件路径,只应用于state=link的情况
dest #被链接到的路径,只应用于state=link的情况
state #状态,有以下选项:
directory:如果目录不存在,就创建目录
file:即使文件不存在,也不会被创建
link:创建软链接
hard:创建硬链接
touch:如果文件不存在,则会创建一个新的文件,如果文件或目录已存在,则更新其最后修改时间
absent:删除目录、文件或者取消链接文件
- 创建目录 示范
[root@pa1 ~]#ansible pa -m file -a 'path=/root/lijinghua state=directory' 创建一个目录在/root/下 叫lijinghua
- 创建链接文件 示范
[root@pa1 ~]#ansible pa -m file -a 'path=/data/tale.txt src=/root/tale.txt state=link'
-
注意 这里的src文件是目标机器里的文件
-
删除文件 示范
[root@pa1 ~]#ansible pa -m file -a 'path=/data/tale.txt state=absent'
fetch 模块
该模块用于从远程某主机获取(复制)文件到本地
dest:用来存放文件的目录
src:在远程拉取的文件,并且必须是一个file,不能是目录
- 示范
[root@pa1 ~]#ansible pa -m fetch -a 'src=/data/hello dest=/data'
cron 模块
该模块适用于管理cron计划任务的。 其使用的语法跟我们的crontab文件中的语法一致,同时,可以指定以下选项:
day= #日应该运行的工作( 1-31, , /2, )
hour= # 小时 ( 0-23, , /2, )
minute= #分钟( 0-59, , /2, )
month= # 月( 1-12, *, /2, )
weekday= # 周 ( 0-6 for Sunday-Saturday,, )
job= #指明运行的命令是什么
name= #定时任务描述
reboot # 任务在重启时运行,不建议使用,建议使用special_time
special_time #特殊的时间范围,参数:reboot(重启时),annually(每年),monthly(每月),weekly(每周),daily(每天),hourly(每小时)
state #指定状态,present表示添加定时任务,也是默认设置,absent表示删除定时任务
user # 以哪个用户的身份执行
- 增加一个 cron示范
[root@pa1 ~]#ansible web -m cron -a 'name="ntp update every 5 min" minute=*/5 job="/sbin/ntpdate time.nist.gov &> /dev/null"'
- 删除一个cron (得先知道机器上 cron是什么)
[root@pa1 ~]#ansible pa -m cron -a 'name="df everyday" hour=15 job="df -lh >> /tmp/disk_total &> /dev/null" state=absent'
yum模块
顾名思义,该模块主要用于软件的安装,但是要注意,该模块只适用于Centos机器
选项如下 name= #所安装的包的名称
state= #present--->安装, latest--->安装最新的, absent---> 卸载软件。
update_cache #强制更新yum的缓存
conf_file #指定远程yum安装时所依赖的配置文件(安装本地已有的包) 。 disable_pgp_check #是否禁止GPG checking,只用于presentor latest。
disablerepo #临时禁止使用yum库。 只用于安装或更新时。
enablerepo #临时使用的yum库。只用于安装或更新时
- 安装示范
[root@pa1 log]#ansible web1 -m yum -a 'name=htop state=present'
user 模块
该模块主要是用来管理用户账号。 其主要选项如下:
comment # 用户的描述信息
createhome # 是否创建家目录
force # 在使用state=absent时, 行为与userdel –force一致.
group # 指定基本组
groups # 指定附加组,如果指定为(groups=)表示删除所有组
home # 指定用户家目录
move_home # 如果设置为home=时, 试图将用户主目录移动到指定的目录
name # 指定用户名
non_unique # 该选项允许改变非唯一的用户ID值
password # 指定用户密码
remove # 在使用state=absent时, 行为是与userdel –remove一致
shell # 指定默认shell
state # 设置帐号状态,不指定为创建,指定值为absent表示删除
system # 当创建一个用户,设置这个用户是系统用户。这个设置不能更改现有用户
uid # 指定用户的uid
- 添加用户示范
[root@pa1 log]#ansible pa -m user -a 'name=lijinghua password=oaihdHFVUVonhn2342c uid=11111'
- 删除用户示范
[root@pa1 log]#ansible pa -m user -a 'name=lijinghua state=absent'
group 模块
该模块主要用于添加或删除组。 常用的选项如下:
gid= #设置组的GID号
name= #指定组的名称
state= #指定组的状态,默认为创建,设置值为absent为删除
system= #设置值为yes,表示创建为系统组
此处不示范了,和user模块一样一样的
script 模块
该模块用于将本机的脚本在被管理端的机器上运行。 该模块直接指定脚本的路径即可,我们通过例子来看一看到底如何使用的: 首先,我们写一个脚本,并给其加上执行权限: 很简单
- 示范
[root@pa1 ~]#cat df.sh
#!/bin/bash
df -h
[root@pa1 ~]#ansible pa -m script -a '/root/df.sh'
setup 模块
该模块主要用于收集信息,是通过调用facts组件来实现的。 facts组件是Ansible用于采集被管机器设备信息的一个功能,我们可以使用setup模块查机器的所有facts信息,可以使用filter来查看指定信息。整个facts信息被包装在一个JSON格式的数据结构中,ansible_facts是最上层的值。 facts就是变量,内建变量 。每个主机的各种信息,cpu颗数、内存大小等。会存在facts中的某个变量中。调用后返回很多对应主机的信息,在后面的操作中可以根据不同的信息来做不同的操作。如redhat系列用yum安装,而debian系列用apt来安装软件
保存信息 我们的setup模块还有一个很好用的功能就是可以保存我们所筛选的信息至我们的主机上,同时,文件名为我们被管制的主机的IP,这样方便我们知道是哪台机器出的问题
- 查看内存示范
[root@pa1 ~]#ansible pa -m setup -a 'filter="*mem*"'
- 保存信息到本地示范
[root@pa1 facts]ansible pa -m setup -a 'filter="*mem*"' --tree /tmp/facts
[root@pa1 facts]#pwd
/tmp/facts
[root@pa1 facts]#ll
total 16
-rw-r--r-- 1 root root 551 Feb 23 00:13 101.200.228.69
-rw-r--r-- 1 root root 549 Feb 23 00:13 120.78.202.78
-rw-r--r-- 1 root root 551 Feb 23 00:13 120.78.205.288
-rw-r--r-- 1 root root 542 Feb 23 00:13 58.87.104.80
setup一些参数补充
关键字 说明 返回值例子
ansible_nodename ========================= 节点名 "6-dns-1.hunk.tech"
ansible_fqdn ================================FQDN名 "6-dns-1.hunk.tech"
ansible_hostname ==========================================主机短名称 "6-dns-1"
ansible_domain ============================================主机域名后缀 "hunk.teh"
ansible_memtotal_mb ===========================================总物理内存 "ansible_memtotal_mb": 222
ansible_swaptotal_mb =======================================SWAP总大小 "1023"
ansible_processor ==========================CPU信息 Intel(R) Core(TM) i5-5200U CPU @ 2.20GHz
ansible_processor_cores =================================================CPU核心 4
ansible_all_ipv4_addresses ==========================================所有IPV4地址
ansible_all_ipv6_addresses ==========================================所有IPV6地址
ansible_default_ipv4 ==============================默认网关的网卡配置信息
ansible_eth2 ====================================具体某张网卡信息 不同系统名称需要变化
ansible_dns ==================================DNS设置信息
ansible_architecture ========================================系统架构 x86_64
ansible_machine ========================================主机类型 x86_64
ansible_kernel ===========================================内核版本 "2.6.32-696.el6.x86_64"
ansible_distribution ============================================================发行版本 "CentOS"
ansible_distribution_major_version =========================操作系统主版本号 "6"
ansible_distribution_release =======================发行版名称 "Final"
ansible_distribution_version ==============================完整版本号 "7.4.1708"
ansible_pkg_mgr ===========================================软件包管理方式 "yum"
ansible_service_mgr =======================================进行服务方式 "systemd"
ansible_os_family =======================================家族系列 "RedHat"
ansible_cmdline ============================================内核启动参数
ansible_selinux ============================================SElinux状态 "disabled"
ansible_env =================================================当前环境变量参数
ansible_date_time =========================================时间相关
ansible_python_version =====================================python版本 "2.6.6"
ansible_lvm ================================================LVM卷相关信息
ansible_mounts =============================================所有挂载点
ansible_device_links ======================================所有挂载的设备的UUID和卷标名
ansible_devices ===============================================所有/dev/下的正在使用的设备的信息
ansible_user_dir ============================================执行用户的家目录 "/root"
ansible_user_gecos =============================================执行用户的描述信息 "The root "
ansible_user_gid ==============================================执行用户的的GID 0
ansible_user_id ===================================================执行用户的的用户名 "root"
ansible_user_shell ===============================================执行用户的shell类型 "/bin/bash"
ansible_user_uid ================================================执行用户的UID 0