Ansible中常用的模块

目录

一、Ansible  Ad-Hoc命令集

1 Ad-hoc 使用场景

2 Ansible的并发特性

3 Ansible-doc用法

4 ansible命令运行方式及常用参数

5 ansible的基本颜色代表

6 ansible中的常用模块

command模块

shell模块

script模块

copy模块

fetch模块

unarchive模块

archive模块

hostname模块

cron模块

yum模块

dnf模块

service模块

firewalld模块

user模块

group模块

lineinfile模块

replace模块

setup模块

debug模块

mysql_user模块

file模块

---

一、Ansible  Ad-Hoc命令集

1 Ad-hoc 使用场景

Ansible提供两种方式去完成任务,一是 ad-hoc 命令,一是写 Ansible playbook。

Ad-hoc更注重于解决一些简单或者平时工作中临时遇到的任务，相当于Linux系统命令行下的Shell命令，后者更适合于解决复杂或需固化下来的任务，相当于Linux系统的Shell Scripts。
使用场景：
关闭所有不必要的服务器
临时更新Apache或Nginx的配置文件

2 Ansible的并发特性

Ansible和Ansible-playbook默认会fork 5个线程并发执行命令，如果同时操作的主机数比较多的话，可以调整到一个更大的值。
Ansible为我们提供了便捷的选项，-f指定线程数。默认是5个

ansible webserver -m ping -f 3**

ansible有许多模块,默认是 command，也就是命令模块,我们可以通过 -m 选项来指定不同的模块。 

3 Ansible-doc用法

ansible的模块非常之多，Ansible也提供了类似于man功能的help说明工具ansible-doc。
正式学习Ansible模块使用前，有必要先了解ansible-doc用法：

显示所有可用模块

ansible-doc -l

显示指定模块的playbook片段

ansible-doc -s

获取yum模块帮助

ansible-doc yum

4 ansible命令运行方式及常用参数

格式：

ansible 清单 -m 模块 -a 模块参数

常用参数

--version                                   显示版本
-m module                                指定模块，默认为command模块
-v                                              详细过程 -vv -vvv更详细过程
--list                                          显示主机列表，也可以用--list-hosts
-k                                              提示输入ssh连接密码，默认key认证
-C                                             预执行检测
-T                                              执行命令的超时时间，默认10s
-u                                              指定远程执行的用户
-b                                              执行sudo切换身份操作
-become-user=USERNAME    指定sudo的用户
-K                                             提示输入sudo密码

5 ansible的基本颜色代表

绿色   执行成功但为对远程主机做任何改变
黄色   执行成功并对远程主机做改变
红色   执行失败

6 ansible中的常用模块

command模块

功能: 在远程主机执行命令，此模块为默认模块

常用参数

chdir              执行命令前先进入到指定目录
cmd               运行命令指定
creates          如果文件存在将不运行
removes        如果文件存在在将运行
free_form      在远程主机中执行的命令，此参数不需要加

 可以用命令 ansible-doc command -s 来查看其参数及含义

 注意：Linux 中的很多通配符在 command 模块中不支持

shell模块

功能：和command功能类似

常用参数

chdir              执行命令前先进入到指定目录
cmd               运行命令指定
creates          如果文件存在将不运行
removes        如果文件存在将运行
free_form      在远程主机中执行的命令，此参数不需要加
executable    指定执行环境，默认为sh

可以使用ansible-doc shell -s 查看其参数及含义

script模块

功能：在 ansible 主机中写好的脚本在受控主机中执行

常用参数:

copy模块

功能：从 ansible 主机复制文件到受控主机

常用参数

src                  源文件
dest                目的地文件
owner             指定目的地文件所有人
group              指定目的地文件所有组
mode              指定目的地文件权限
backup=yes    当受控主机中存在文件时备份原文件
content            指定文本内容直接在受控主机中生成文件

fetch模块

功能：从受控主机把文件复制到 ansible 主机，但不支持目录

常用参数

src        受控主机的源文件
dest      本机目录
flat        基本名称功能

unarchive模块

功能：解压缩

常用参数

copy                 默认为yes 从ansible主机复制文件到受控主机
                        设定为no 从受控主机中寻找src源文件

remote_src      功能同copy且相反
                        设定为yes 表示包在受控主机
                        设定为no表示包在ansible主机

src                   包路径，可以使ansible主机也可以使受控主机
dest                 受控主机目录
mode               加压后文件权限 <copy=yes>

archive模块

功能：压缩

常用参数

path           打包目录名称
dest           声称打包文件名称
format        打包格式
owner        指定文件所属人
mode         指定文件权限

hostname模块

作用：管理主机名称

常用参数

name 指定主机名称

 

cron模块

功能：计划任务

常用参数

minute               分钟
hour                   小时
day                    天
month                月
weekday            周
name                任务名称
job                     任务脚本或命令
disabled            yes 禁用计划任务
                         no 启动计划任务
state                  absent 删除计划任务

yum模块

功能：配置系统软件仓库源文件

常用参数

 name              指定仓库名称
baseurl            指定源路径
description      指定仓库描述
file                   指定仓库文件名称
enabled           仓库是否启用
gpgcheck        仓库是否检测gpgkey
state                默认值present 建立
                        absent 为删除

ansible server3 -m yum -a "name=http://172.25.0.250/rhel7.3/x86_64/dvd/Packages/vsftpd-3.0.2-21.el7.x86_64.rpm state=present"		
//在线安装ansible server3 -m yum -a "name=/mnt/vsftpd-3.0.2-21.el7.x86_64.rpm state=present"			
//本地安装ansible server3 -m yum -a "name=httpd state=absent"			
//卸载软件

dnf模块

作用：管理系统中的dnf仓库及管理软件

常用参数

name      指定包
state       指定动作
               present 安装
               latest 更新
               absent 删除
list    列出指定信息，httpd、 installed、 all、available
disable_gpg_check      禁用gpgkey检测
enablerepo       指定安装包来源
disablerepo      禁用安装包来源

service模块

功能：管理系统服务状态

常用参数

name    指定服务名称
state    指定对服务的动作，started、stoped、restarted、reloaded
enabled    设定服务开机是否启动,yes开启启动,no开机不启动

ansible webservers -m service -a "name=httpd state=started" 
//启动服务ansible webservers -m service -a "name=httpd state=restarted"
//重启服务ansible webservers -m service -a "name=httpd state=stopped 
//停止服务

firewalld模块

功能：某些服务在开启之后不一定可以直接使用，需要设定火墙策略才可以访问

常用参数

zone             火墙的域
service          服务名称
permanent    永久生效
state    状态
            enbaled 允许
            disabled 拒绝
immediate    立即生效

user模块

功能：模块可以帮助我们管理远程主机上的用户，比如创建用户、修改用户、删除用户、为用户创建密钥对等操作

常用参数

name          必须参数，用于指定要操作的用户名称
group          指定用户所在的基本组
gourps        指定用户所在的附加组
append       指定添加附加组默认值为no
shell           指定用户的默认 shell
uid              指定用户的 uid 号
comment    指定用户的注释信息
state    用于指定用户是否存在于远程主机
       present  建立
       absent   删除
remove        当删除用户是删除用户家目录，默认值为no
password     此参数用于指定用户的密码。但密码为明文，可以用openssl password -6 '密码’生成加密字符
generate_ssh_key    生成sshkey

group模块

作用：group 模块可以帮助我们管理远程主机上的组。

常用参数

name        必须参数，用于指定要操作的用户名称
state         用于指定组的状态
         present 建立
         absent 删除
gid    用于指定组的gid

lineinfile模块

path	指定要操作的文件
line	指定文本内容
regexp	使用正则表达式匹配对应的行当替换文本时,如果有多行文本都能被匹配,则只有最后面被匹配到的那行文本才会被替换,当删除文本时，如果有多行文本都能被匹配,这么这些行都会被删除
state	当想要删除对应的文本时需要将state参数的值设置为absent，state的默认值为present
backrefs	当内容无匹配规则时不对文件做任何更改,默认值为no，向后引用regexp变量信息
insertafter	借助insertafter参数可以将文本插入到“指定的行”之后，insertafter参数的值可以设置为EOF或者正则表达式
insertbefore	借助insertbefore参数可以将文本插入到“指定的行”之前，insertbefore参数的值可以设置为BOF或者正则表达式
backup	是否在修改文件之前对文件进行备份
create	当要操作的文件并不存在时，是否创建对应的文件

replace模块

作用：replace 模块可以根据我们指定的正则表达式替换文件中的字符串，文件中所有被匹配到的字符串都会被替换

常用参数

path    指定要操作的文件
regexp    指定一个正则表达式，文件中与正则匹配的字符串将会被替换。
replace    指定最终要替换成的字符串
backup    是否在修改文件之前对文件进行备份，最好设置为yes 

setup模块

作用：setup模块用于收集远程主机的一些基本信息

常用参数

filter	用于进行条件过滤。如果设置，仅返回匹配过滤条件的信息

debug模块

作用：调试模块，用于在调试中输出信息

常用参数

msg       调试输出的消息
var:        将某个任务执行的输出作为变量传递给debug模块，debug会直接将其打印输出
verbosity：    debug的级别（默认是0级，全部显示）

mysql_user模块

ansible server3 -m mysql_user -a "login_user=root name=wxh password=testpass priv='*.*:select' host='%' state=present"

远程主机需要安装MySQL-python

file模块

功能：设置文件的属性

常用参数

path        指定文件名称
state       指定操作状态touch            建立absent           删除directory        递归link             建立链接hardmode        设定权限
owner       设定文件用户
group       设定文件组
src         源文件
dest        目标文件
recurse=yes 递归更改