中文教程：https://ansible-tran.readthedocs.io/en/latest/index.html

模块：https://docs.ansible.com/ansible/latest/modules/list_of_all_modules.html

前言

当下有许多的运维自动化工具( 配置管理 )，例如：Ansible、SaltStack、Puppet、Fabric 等。

Ansible 一种集成 IT 系统的配置管理、应用部署、执行特定任务的开源平台，是 AnsibleWorks 公司名下的项目，该公司由 Cobbler 及 Func 的作者于 2012 年创建成立。

Ansible 基于 Python 语言实现，由 Paramiko 和 PyYAML 两个关键模块构建。

Ansible 特点：

部署简单，只需在主控端部署 Ansible 环境，被控端无需做任何操作。
默认使用 SSH（Secure Shell）协议对设备进行管理。
主从集中化管理。
配置简单、功能强大、扩展性强。
支持 API 及自定义模块，可通过 Python 轻松扩展。
通过 Playbooks 来定制强大的配置、状态管理。
对云计算平台、大数据都有很好的支持。
提供一个功能强大、操作性强的 Web 管理界面和 REST API 接口 —- AWX 平台。

Ansible 与 SaltStack：

最大的区别是 Ansible 无需在被监控主机部署任何客户端代理，默认通过 SSH 通道进行远程命令执行或下发配置。
相同点是都具备功能强大、灵活的系统管理、状态配置，都使用 YAML 格式来描述配置，两者都提供丰富的模板及 API，对云计算平台、大数据都有很好的支持

ansible 命令执行过程

加载自己的配置文件，默认/etc/ansible/ansible.cfg；
查找对应的主机配置文件，找到要执行的主机或者组；
加载自己对应的模块文件，如 command；
通过ansible将模块或命令生成对应的临时py文件(python脚本)，并将该文件传输至远程服务器；
对应执行用户的家目录的.ansible/tmp/XXX/XXX.PY文件；
给文件 +x 执行权限；
执行并返回结果；
删除临时py文件，sleep 0退出；

ansible配置文件查找顺序

ansible与我们其他的服务在这一点上有很大不同，这里的配置文件查找是从多个地方找的，顺序如下：

检查环境变量ANSIBLE_CONFIG指向的路径文件(export ANSIBLE_CONFIG=/etc/ansible.cfg)；
~/.ansible.cfg，检查当前目录下的ansible.cfg配置文件；
/etc/ansible.cfg检查etc目录的配置文件。

ansible配置文件

ansible 的配置文件为/etc/ansible/ansible.cfg，ansible 有许多参数，下面我们列出一些常见的参数：

inventory = /etc/ansible/hosts：这个参数表示资源清单inventory文件的位置``
library = /usr/share/ansible：指向存放Ansible模块的目录，支持多个目录方式，只要用冒号（：）隔开就可以
forks = 5：并发连接数，默认为5
sudo_user = root：设置默认执行命令的用户
remote_port = 22：指定连接被管节点的管理端口，默认为22端口，建议修改，能够更加安全
host_key_checking = False：设置是否检查SSH主机的密钥，值为True/False。关闭后第一次连接不会提示配置实例
timeout = 60：设置SSH连接的超时时间，单位为秒
log_path = /var/log/ansible.log：指定一个存储ansible日志的文件（默认不记录日志）

ansible 命令集

/usr/bin/ansible：Ansibe AD-Hoc 临时命令执行工具，常用于临时命令的执行
/usr/bin/ansible-doc：Ansible 模块功能查看工具
/usr/bin/ansible-galaxy：下载/上传优秀代码或Roles模块的官网平台，基于网络的
/usr/bin/ansible-playbook：Ansible 定制自动化的任务集编排工具
/usr/bin/ansible-pull：Ansible远程执行命令的工具，拉取配置而非推送配置（使用较少，海量机器时使用，对运维的架构能力要求较高）
/usr/bin/ansible-vault：Ansible 文件加密工具
/usr/bin/ansible-console：Ansible基于Linux Consoble界面可与用户交互的命令执行工具

ansible查看帮助文档

ansible-doc 命令常用于获取模块信息及其使用帮助，一般用法如下：

ansible-doc -l：获取全部模块的信息
ansible-doc -s MOD_NAME：获取指定模块的使用帮助

hosts文件

远程主机定义

 # 定义域名
www.abc.com

 # 定义 IP
192.168.1.100

# 指定端口号
192.168.1.150:37268

定义分组

[group1]           # 定义分组
192.168.1.10
192.168.1.20
192.168.1.30

[group2]           # 定义分组
192.168.1.40
192.168.1.50

主机名支持正则描述

#www01.example.com-www50.example.com
[webservers]
www[01:50].example.com

#db-a.example.com-db-f.example.com
[dbservers]
db-[a:f].example.com

定义别名

# Monitor是别名
Monitor ansible_ssh_port=12378 ansible_ssh_host=192.168.1.200

# ansible_ssh_host 连接目标主机的地址
# ansible_ssh_port 连接目标主机的端口，默认 22 时无需指定
# ansible_ssh_user 连接目标主机默认用户
# ansible_ssh_pass 连接目标主机默认用户密码
# ansible_ssh_connection 目标主机连接类型，可以是 local 、ssh 或 paramiko
# ansible_ssh_private_key_file 连接目标主机的 ssh 私钥
# ansible_*_interpreter 指定采用非 Python 的其他脚本语言，如 Ruby 、Perl 或其他类似 ansible_python_interpreter 解释器

参数

# vars底下为群组共同便变量，包括已定义变量和自定义变量
[test1]
name1 ansible_ssh_host=192.168.1.[20:50]
[test1:vars]
ansible_ssh_user=root
ansible_ssh_pass="1234"
testvar="test" #自定义

群组整合

# children底下为父群组test的子群组，调用方式为ansible test -m ping：
[dbtest]
name1 ansible_ssh_host=192.168.1.[20:50] ansible_ssh_user="root" ansible_ssh_pass="1234" ansible_ssh_port=22

[webtest]
name2 ansible_ssh_host=192.168.2.[20:50] ansible_ssh_user="root" ansible_ssh_pass="1234" ansible_ssh_port=22

[test:children]
dbtest
webtest

[test:var]
testvar="test"

主机调用

# win_ping模块  ping

# 调用两个主机组的写法，以下webservers和dbservers都会被调用：
ansible webservers:dbservers -m win_ping

# 在webservers组中但不在dbsersers中的调用：
ansible webservers:!dbservers -m win_ping

# 在webservers组中并且在dbservers组中的才会调用：
ansible webservers:&dbservers -m win_ping

# 在调用前加~，代表正则表达式：
ansible ~(web|db).*.91it.org -m win_ping

# 组合的例子：
ansible webserver:dbservers:&nginx:!ntp -m win_ping

# -m 		  指定执行 ping 模块
# -i          指定 hosts 文件位置
# -u username 指定 SSH 连接的用户名
# -k          指定远程用户密码
# -f          指定并发数
# -s          如需要 root 权限执行时使用 ( 连接用户不是 root 时 )
# -K          -s 时，-K 输入 root 密码

ansible 命令详解

命令的具体格式如下：

1	ansible <host-pattern> [-f forks] [-m module_name] [-a args]

也可以通过ansible -h来查看帮助，下面我们列出一些比较常用的选项，并解释其含义：

-a MODULE_ARGS：模块的参数，如果执行默认COMMAND的模块，即是命令参数，如： “date”，“pwd”等等
-k，--ask-pass：ask for SSH password。登录密码，提示输入SSH密码而不是假设基于密钥的验证
--ask-su-pass：ask for su password。su切换密码
-K，--ask-sudo-pass：ask for sudo password。提示密码使用sudo，sudo表示提权操作
--ask-vault-pass：ask for vault password。假设我们设定了加密的密码，则用该选项进行访问
-B SECONDS：后台运行超时时间
-C：模拟运行环境并进行预运行，可以进行查错测试
-c CONNECTION：连接类型使用
-f FORKS：并行任务数，默认为5
-i INVENTORY：指定主机清单的路径，默认为/etc/ansible/hosts
--list-hosts：查看有哪些主机组
-m MODULE_NAME：执行模块的名字，默认使用 command 模块，所以如果是只执行单一命令可以不用 -m参数
-o：压缩输出，尝试将所有结果在一行输出，一般针对收集工具使用
-S：用 su 命令
-R SU_USER：指定 su 的用户，默认为 root 用户
-s：用 sudo 命令
-U SUDO_USER：指定 sudo 到哪个用户，默认为 root 用户
-T TIMEOUT：指定 ssh 默认超时时间，默认为10s，也可在配置文件中修改
-u REMOTE_USER：远程用户，默认为 root 用户
-v：查看详细信息，同时支持-vvv，-vvvv可查看更详细信息

ansible 常用模块

1）ping模块

检查指定节点机器是否还能连通，用法很简单，不涉及参数
ansible erp -m ping

2）command 模块

这个模块可以直接在远程主机上执行命令，并将结果返回本主机。

命令模块接受命令名称，后面是空格分隔的列表参数。给定的命令将在所有选定的节点上执行。它不会通过shell进行处理，比如$HOME和操作如"<"，">"，"|"，";"，"&" 工作（需要使用（shell）模块实现这些功能）。注意，该命令不支持| 管道命令。

下面来看一看该模块下常用的几个命令：

chdir：在执行命令之前，先切换到该目录
executable：切换shell来执行命令，需要使用命令的绝对路径
free_form：要执行的Linux指令，一般使用Ansible的-a参数代替。
creates：一个文件名，当这个文件存在，则该命令不执行,可以用来做判断
removes：一个文件名，这个文件不存在，则该命令不执行
stdin：将命令的stdin设置为指定的值
warn：如果在ansible.cfg中存在告警，如果设定了false，不会告警该行

示例

ansible web -m command -a 'ss -ntl'

#先切换到/data/ 目录，再执行“ls”命令
ansible web -m command -a 'chdir=/data/ ls'

#如果/data/aaa.jpg存在，则不执行“ls”命令
ansible web -m command -a 'creates=/data/aaa.jpg ls'

#如果/data/aaa.jpg存在，则执行“cat /data/a”命令
ansible web -m command -a 'removes=/data/aaa.jpg cat /data/a'

3）shell 模块

shell模块可以在远程主机上调用shell解释器运行命令，支持shell的各种功能，例如管道等。

chdir：在运行命令之前，切换到此目录。
executable：更改用于执行命令的shell（bash，sh）。应该是可执行文件的绝对路径。

示例

1	ansible web -m shell -a 'cat /etc/passwd \|grep "keer"'

4）copy 模块

这个模块用于将文件复制到远程主机，同时支持给定内容生成文件和修改权限等。类似于 scp 功能
其相关选项如下：

src：被复制到远程主机的本地文件。可以是绝对路径，也可以是相对路径。如果路径是一个目录，则会递归复制，用法类似于"rsync"，空目录不复制
content：用来替代src，用于将指定文件的内容复制到远程文件内
dest：必选项，将源文件复制到的远程主机的绝对路径
backup：当文件内容发生改变后，在覆盖之前把源文件备份，备份文件包含时间信息
directory_mode：递归设定目录的权限，默认为系统默认权限
follow：支持link文件复制
force：当目标主机包含该文件，但内容不同时，设为"yes"，表示强制覆盖；设为"no"，表示目标主机的目标位置不存在该文件才复制。默认为"yes"
group：设定远程主机目录的组名
mode：设定远程主机文件及目录的权限
owner：设定远程主机目录的用户名
others：所有的 file 模块中的选项可以在这里使用

示例

# 复制文件
ansible web -m copy -a 'src=~/hello dest=/data/hello'

# 给定内容生成文件，并制定权限
ansible web -m copy -a 'content="I am keer\n" dest=/data/name mode=666' 

# 查看一下我们生成的文件及其权限
ansible web -m shell -a 'ls -l /data/'

# 覆盖备份
ansible web -m copy -a 'content="I am keerya\n" backup=yes dest=/data/name mode=666'

5）file 模块

该模块主要用于设置文件的属性，比如创建文件、创建链接文件、删除文件等。
下面是一些常见的命令：

force：需要在两种情况下强制创建软链接，一种是源文件不存在，但之后会建立的情况下；另一种是目标软链接已存在，需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no
group：定义文件/目录的属组。后面可以加上mode：定义文件/目录的权限
owner：定义文件/目录的属主。后面必须跟上path：定义文件/目录的路径
recurse：递归设置文件的属性，只对目录有效，后面跟上src：被链接的源文件路径，只应用于state=link的情况
dest：被链接到的路径，只应用于state=link的情况
state：状态，有以下选项：
- directory：如果目录不存在，就创建目录
- file：即使文件不存在，也不会被创建
- link：创建软链接
- hard：创建硬链接
- touch：如果文件不存在，则会创建一个新的文件，如果文件或目录已存在，则更新其最后修改时间
- absent：删除目录、文件或者取消链接文件

示例

# 创建目录
ansible web -m file -a 'path=/data/app state=directory'

# 创建链接文件
ansible web -m file -a 'path=/data/bbb.jpg src=aaa.jpg state=link'

# 删除文件
ansible web -m file -a 'path=/data/a state=absent'

6）fetch 模块

该模块用于从远程某主机获取（复制）文件到本地。
有两个选项：

dest：用来存放文件的目录
src：在远程拉取的文件，并且必须是一个file，不能是目录

示例

flat：允许您覆盖将目标文件添加到主机名/path/to/file的默认行为。

1	ansible web -m fetch -a 'src=/data/hello dest=/data'

7）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：以哪个用户的身份执行

示例

# 添加计划任务
ansible web -m cron -a 'name="ntp update every 5 min" minute=*/5 job="/sbin/ntpdate 172.17.0.1 &> /dev/null"'

# 查看计划任务
ansible web -m shell -a 'crontab -l'

# 删除计划任务
ansible web -m cron -a 'name="df everyday" hour=15 job="df -lh >> /tmp/disk_total &> /dev/null" state=absent'

8）yum 模块

该模块主要用于软件的安装。
其选项如下：

name：所安装的包的名称
state：present--->安装， latest--->安装最新的, absent---> 卸载软件。
update_cache：强制更新yum的缓存
conf_file：指定远程yum安装时所依赖的配置文件（安装本地已有的包）。
disable_pgp_check：是否禁止GPG checking，只用于presentor latest。
disablerepo：临时禁止使用yum库。只用于安装或更新时。
enablerepo：临时使用的yum库。只用于安装或更新时。

示例

1	ansible web -m yum -a 'name=htop state=present'

9）service 模块

该模块用于服务程序的管理。
其主要选项如下：

arguments：命令行提供额外的参数
enabled：设置开机启动。
name：服务名称
runlevel：开机启动的级别，一般不用指定。
sleep：在重启服务的过程中，是否等待。如在服务关闭以后等待2秒再启动。(定义在剧本中。)
state：有四种状态，分别为：started--->启动服务， stopped--->停止服务， restarted--->重启服务， reloaded--->重载配置

示例

# 开启服务并设置自启动
ansible web -m service -a 'name=nginx state=started enabled=true' 

# 关闭服务
ansible web -m service -a 'name=nginx state=stopped'

# 查端口
ansible web -m shell -a 'ss -ntl | grep 80'

10）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

示例

# 添加一个用户并指定其 uid
ansible web -m user -a 'name=keer uid=11111'

# 删除用户
ansible web -m user -a 'name=keer state=absent'

# 查用户
ansible web -m shell -a 'cat /etc/passwd |grep keer'

11）group 模块

该模块主要用于添加或删除组。
常用的选项如下：

gid=：设置组的GID号
name：指定组的名称
state：指定组的状态，默认为创建，设置值为absent为删除
system：设置值为yes，表示创建为系统组

示例

# 创建组
ansible web -m group -a 'name=sanguo gid=12222'

# 删除组
ansible web -m group -a 'name=sanguo state=absent'

# 查组
ansible web -m shell -a 'cat /etc/group | grep 12222'

12）script 模块

该模块用于将本机的脚本在被管理端的机器上运行。
该模块直接指定脚本的路径即可，我们通过例子来看一看到底如何使用的：
首先，我们写一个脚本，并给其加上执行权限：

示例

1	ansible web -m script -a '/tmp/df.sh'

13）setup 模块

该模块主要用于收集信息，是通过调用facts组件来实现的。
facts组件是Ansible用于采集被管机器设备信息的一个功能，我们可以使用setup模块查机器的所有facts信息，可以使用filter来查看指定信息。整个facts信息被包装在一个JSON格式的数据结构中，ansible_facts是最上层的值。

facts就是变量，内建变量。每个主机的各种信息，cpu颗数、内存大小等。会存在facts中的某个变量中。调用后返回很多对应主机的信息，在后面的操作中可以根据不同的信息来做不同的操作。如redhat系列用yum安装，而debian系列用apt来安装软件。

示例

# 查看信息
ansible web -m setup -a 'filter="*mem*"' #查看内存

#保存信息
ansible web -m setup -a 'filter="*mem*"' --tree /tmp/facts

#查看一下内存的大小
ansible web -m shell -a 'free -m'

14）stat 模块

获取远程文件状态信息，atime/ctime/mtime/md5/uid/gid 等信息

示例

1	ansible Client -m stat -a "path=/etc/syctl.conf"

15）get_url 模块

实现在远程主机下载指定 URL 到本地，支持 sha256sum 文件校验，类似于wget

sha256sum：下载完成后进行sha256 check；
timeout：下载超时时间，默认10s
url：下载的URL
url_password、url_username：主要用于需要用户名密码进行验证的情况
dest：将文件下载到哪里的绝对路径。如果dest是目录，则使用服务器提供的文件名，或者如果没有提供，将使用远程服务器上的URL的基本名称。

示例

1	ansible Client -m get_url -a "url=http://www.baidu.com dest=/tmp/index.html mode=0440 force=yes"

16） mount 模块

远程主机分区挂载

1	ansible Client -m mount -a "name=/mnt/data src=/dev/sd0 fstype=ext4 opts=ro state=present"

17）firewalld 模块

首先开启防火墙

1	ansible db -m service -a 'name=firewalld state=started enabled=true'

把httpd服务加入防火墙白名单：

1	ansible db -m firewalld -a 'service=http state=enabled permanent=yes immediate

18）unarchive 模块

用于解压文件，模块包含如下选项：

copy：在解压文件之前，是否先将文件复制到远程主机，默认为yes。若为no，则要求目标主机上压缩包必须存在。
creates：指定一个文件名，当该文件存在时，则解压指令不执行
dest：远程主机上的一个路径，即文件解压的绝对路径。
group：解压后的目录或文件的属组
list_files：如果为yes，则会列出压缩包里的文件，默认为no，2.0版本新增的选项
mode：解压后文件的权限
src：如果copy为yes，则需要指定压缩文件的源路径
owner：解压后文件或目录的属主

19）apt 模块

这个模块是ubuntu作为远端节点的OS的时候，用的最多的。Ubuntu/Debian的包管理工具。

deb：用于安装远程机器上的.deb后缀的软件包（optional）
install_recommends：这个参数可以控制远程电脑上是否只是下载软件包，还是下载后安装，默认参数为true,设置为false的时候只下载软件包，不安装
update_cache：当这个参数为yes的时候等于apt-get update（optional）
name： apt要下载的软件包名字，支持name=git=1.6 这种制定版本的模式
state：状态（present，absent，latest），表示是安装还卸载
- present:默认的，表示为安装
- lastest: 安装为最新的版本
- absent：表示删除