Ansible---playbook的使用

本章主要介绍如何在ansible中写脚本。

• playbook的语法
• 在写playbook时如何进行错误处理

ansible的许多模块都是在命令行中执行的，每次只能执行一个模块。如果需要执行多个模块，且要写判断语句，判断模块是否执行成功了，如果没成功会怎么处理等。这时就需要写脚本了，ansible中的脚本叫作 playbook，每个 playbook中可以包含多个play。

---

playbook的写法?

playbook是以 yaml 或 yml 作为后缀的，每个play都可以使用两种格式来写。?

• 参数写在模块后面，语法如下。?

1. ‐ name: play的名称
2. hosts:主机组1,主机组2,... #‐‐列出主机组
3. tasks:
4. ‐ name: 提示信息1
5. 模块1: argx1=vx1 argz2=vx2 #这种写法，“=”两边不要有空格
6. ‐ name: 提示信息x
7. 模块x: rgxl=vxl argx2=vx2?

一个 play 中可以包含多个 tasks，每个 task调用一个模块。

• 参数分行写，一行一个参数，语法如下。?

1. ‐ hosts:主机组1，主机组2,... #‐‐列出主机组
2. tasks:
3. ‐ name:描述语句1
4. 模块1:
5. argxl: vxl #这里指定模块的参数,注意冒号后面的空格
6. argx2: vx2
7. ‐ name:描述语句2
8. 模块x:
9. argxl:vx1
10. argx2:vx2?

需要注意的是，YAML文件对缩进有极严格的要求,每个缩进都是两个空格，不要按 【Tab】键。?

一个完整的playbook中至少要包含一个 play，下面是一个包含两个play的playbook，命令如下。?

• ‐‐‐
• ‐ name: 第一个play的名称
• hosts: 主机组1，主机组2，...#‐‐列出主机组
• tasks:
• ‐ name:提示信息1
• 模块1:argxl‐vxl argx2=vx2
• ‐ name:提示信息×
• 模块x:rgxl=vxl argx2=vx2
• ‐ name: 第二个play的名称
• hosts: 主机组3,主机组4,...#‐‐列出主机组
• gather facts: false
• tasks:
• ‐ name: 提示信息1
• 模块1: argxl=vxl argx2=vx2
• ‐ name: 提示信息×
• 模块x: rgxl=vxl argx2=Vx2?

在写playbook时，一定要先写好框架，然后往框架中写内容。如果在多个主机组上做的是相同的操作，可以把它们放在同一个play中。如果在不同的主机组上做的是不同的操作， 可以通过不同的play分别来实现。?

这里第二个play中加了一句gather_facts: false，意思是在执行此play时不需要通过setup 获取主机组的信息。所以，如果在tasks中没有使用到fact变量，建议加上这句，可以提升执行的速度。?

写好之后运行playbook的方法是ansible playbook文件。?

本章实验都在/home/bdqn/demo1下操作，先把demo1目录创建出来并把 ansible.cfg 和hosts拷贝进去，命令如下。?

[bdqn@rhel01 ~]$ mkdir demo1
[bdqn@rhel01 ~]$ cp ansible.cfg hosts demo1/
[bdqn@rhel01 ~]$ cd demo1/
[bdqn@rhel01 demo1]$ ls
ansible.cfg  hosts
[bdqn@rhel01 demo1]$

练习1：写一个playbook文件test1.yaml，在server2和server3上打印主机名和IP。

分析：因为在server2和 server3上做的是相同的操作，所以只要一个play即可。这个play 中包含两个task: 一个用于打印主机名，另一个用于打印IP，命令如下。?

[bdqn@rhel01 demo1]$ cat test1.yaml 
---
- hosts: server2,server3
  tasks:
  - name: 打印主机名
    debug: msg={{ansible_fqdn}}
  - name: 打印ip
    debug: msg={{ansible_default_ipv4.address}}
[bdqn@rhel01 demo1]$

运行此playbook，命令如下。?

[bdqn@rhel01 demo1]$ ansible-playbook test1.yaml 

PLAY [server2,server3] ************************************************************************************************************************************

TASK [Gathering Facts] ************************************************************************************************************************************
ok: [server2]
ok: [server3]

TASK [打印主机名] **********************************************************************************************************************************************
ok: [server2] => {
    "msg": "rhel02"
}
ok: [server3] => {
    "msg": "rhel03"
}

TASK [打印ip] ***********************************************************************************************************************************************
ok: [server2] => {
    "msg": "192.168.23.32"
}
ok: [server3] => {
    "msg": "192.168.23.33"
}

PLAY RECAP ************************************************************************************************************************************************
server2                    : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
server3                    : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[bdqn@rhel01 demo1]$ 

练习2：写一个playbook文件test2.yaml，在server2上打印主机名，在server3上打印IP。

分析:因为在server2和 server3上做的是不同的操作，所以这里写两个play，一个play在 server2上执行,另一个play在server3上执行。每个play中只要包含一个task即可，命令如下。?

[bdqn@rhel01 demo1]$ cat test2.yaml 
---
- name: 在server2上的操作
  hosts: server2
  tasks:
  - name: 打印主机名
    debug: msg={{ansible_fqdn}}
- name: 在server3上的操作
  hosts: server3
  tasks:
  - name: 打印ip
    debug: msg={{ansible_default_ipv4.address}}
[bdqn@rhel01 demo1]$ 

运行此playbook，命令如下。?

[bdqn@rhel01 demo1]$ ansible-playbook test2.yaml 

PLAY [在server2上的操作] ***************************************************************************************************************************************

TASK [Gathering Facts] ************************************************************************************************************************************
ok: [server2]

TASK [打印主机名] **********************************************************************************************************************************************
ok: [server2] => {
    "msg": "rhel02"
}

PLAY [在server3上的操作] ***************************************************************************************************************************************

TASK [Gathering Facts] ************************************************************************************************************************************
ok: [server3]

TASK [打印ip] ***********************************************************************************************************************************************
ok: [server3] => {
    "msg": "192.168.23.33"
}

PLAY RECAP ************************************************************************************************************************************************
server2                    : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
server3                    : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[bdqn@rhel01 demo1]$ 

练习3：写一个playbook 文件 test3.yaml，要求如下。?

1. 在server2上安装vsftpd，启动并开机自动启动vsftpd,设置防火墙开放ftp服务。
2. 在server3上安装 httpd，启动并开机自动启动httpd，设置防火墙开放http服务。?

分析：因为在server2和 server3上做的是不同的操作，所以这里写两个play.

第一个play在server2上执行，包含3个task，分别用于安装、服务管理、防火墙设置。

第二个 play在server3上执行，包含3个task，分别用于安装、服务管理、防火墙设置。?

[bdqn@rhel01 demo1]$ cat test3.yaml 
---
- name: 第一个play在server2上面的操作---安装vsftpd，启动服务，开启防火墙
  hosts: server2
  tasks:
  - name: 第一个操作安装vsftpd
    yum: name=vsftpd state=installed
  - name: 第二个操作启动服务
    service: name=vsftpd state=started enabled=yes
  - name: 第三个操作开启防火墙
    firewalld: service=ftp state=enabled immediate=yes permanent=yes

- name: 第二个play在server3上面的操作---安装httpd，启动服务，开启防火墙
  hosts: server3
  tasks:
  - name: 第一个操作安装httpd
    yum: name=httpd state=installed
  - name: 第二操作启动服务
    service: name=httpd state=started enabled=yes
  - name: 第三个操作开启防火墙
    firewalld: service=http state=enabled immediate=yes permanent=yes
[bdqn@rhel01 demo1]$ 

运行此playbook，命令如下。?

[bdqn@rhel01 demo1]$ ansible-playbook test3.yaml 

PLAY [第一个play在server2上面的操作---安装vsftpd，启动服务，开启防火墙] ***********************************************************************************************************

TASK [Gathering Facts] **************************************************************************************************************************************
ok: [server2]

TASK [第一个操作安装vsftpd] ****************************************************************************************************************************************
changed: [server2]

TASK [第二个操作启动服务] ********************************************************************************************************************************************
changed: [server2]

TASK [第三个操作开启防火墙] *******************************************************************************************************************************************
changed: [server2]

PLAY [第二个play在server3上面的操作---安装httpd，启动服务，开启防火墙] ************************************************************************************************************

TASK [Gathering Facts] **************************************************************************************************************************************
ok: [server3]

TASK [第一个操作安装httpd] *****************************************************************************************************************************************
changed: [server3]

TASK [第二操作启动服务] *********************************************************************************************************************************************
changed: [server3]

TASK [第三个操作开启防火墙] *******************************************************************************************************************************************
changed: [server3]

PLAY RECAP **************************************************************************************************************************************************
server2                    : ok=4    changed=3    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
server3                    : ok=4    changed=3    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

[bdqn@rhel01 demo1]$ 

---

错误处理?

在写playbook时，会遇到各种各样的问题，例如，命令出错了,或者引用的变量不存在等。playbook具备一定的错误处理能力。?

（1）ignore_errors

执行一个playbook时，如果其中的某个task出错，则后续的task就不再继续执行了。看 下面的例子，编写test4.yaml的内容如下。?

[bdqn@rhel01 demo1]$ cat test4.yaml 
---
- hosts: server2
  gather_facts:false
  tasks:
  - name: aa
    debug: msg={{ansible_xxx}}
  - name: bb
    debug: msg="22222"
[bdqn@rhel01 demo1]$ 

这里写了两个task，一个是aa，另一个是bb，aa这个 task 中引用了一个不存在的变量 default_xxx，所以导致aa这个task报错。如果某个task出错,则后续的task就不再继续执行 了，所以bb这个 task不会继续执行了。?

[bdqn@rhel01 demo1]$ ansible-playbook test4.yaml 

PLAY [server2] **********************************************************************************************************************************************

TASK [aa] ***************************************************************************************************************************************************
fatal: [server2]: FAILED! => {"msg": "The task includes an option with an undefined variable. The error was: 'ansible_xxx' is undefined\n\nThe error appears to be in '/home/bdqn/demo1/test4.yaml': line 5, column 5, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n  tasks:\n  - name: aa\n    ^ here\n"}

PLAY RECAP **************************************************************************************************************************************************
server2                    : ok=0    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0   

[bdqn@rhel01 demo1]$ 

如果想让task aa出错时不影响后续task的执行，那么可以在task aa中添加 ignore_errors:true来忽略这个报错继续往下执行，命令如下。?

[bdqn@rhel01 demo1]$ cat test4.yaml 
---
- hosts: server2
  gather_facts: false
  tasks:
  - name: aa
    debug: msg=i{{ansible_xxx}}
    ignore_errors: true
  - name: bb
    debug: msg="22222"
[bdqn@rhel01 demo1]$ 

这里添加了ignore_errors：true忽略报错信息。下面运行test4.yaml查看结果，如下所示。?

[bdqn@rhel01 demo1]$ ansible-playbook test4.yaml

PLAY [server2] ********************************************************************************************************************************************

TASK [aa] *************************************************************************************************************************************************
fatal: [server2]: FAILED! => {"msg": "The task includes an option with an undefined variable. The error was: 'ansible_xxx' is undefined\n\nThe error appears to be in '/home/bdqn/demo1/test4.yaml': line 5, column 5, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n  tasks:\n  - name: aa\n    ^ here\n"}
...ignoring

TASK [bb] *************************************************************************************************************************************************
ok: [server2] => {
    "msg": "22222"
}

PLAY RECAP ************************************************************************************************************************************************
server2                    : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=1   

[bdqn@rhel01 demo1]$

可以看到，即使task aa出错了，但是后续的 task bb仍然继续执行。

（2）fail 语句?

fail模块和debug模块一样，都是用来打印信息的，区别在于debug执行完成之后会继续进行后续模块的操作，而fail打印完报错信息之后会退出整个playbook。编写test5.yaml的 内容如下。?

[bdqn@rhel01 demo1]$ cat test5.yaml 
---
- hosts: server2
  gather_facts: false
  tasks:
  - name: aa
    debug: msg="111"
  - name: bb
    fail: msg="222"
  - name: cc
    debug: msg="333"
[bdqn@rhel01 demo1]$ 

这里写了3个task，其中task aa和 task cc使用debug打印信息, task bb使用fail打印信息。下面运行此playbook查看结果,如下所示。?

?

[bdqn@rhel01 demo1]$ ansible-playbook test5.yaml 

PLAY [server2] **********************************************************************************************************************************************

TASK [aa] ***************************************************************************************************************************************************
ok: [server2] => {
    "msg": "111"
}

TASK [bb] ***************************************************************************************************************************************************
fatal: [server2]: FAILED! => {"changed": false, "msg": "222"}

PLAY RECAP **************************************************************************************************************************************************
server2                    : ok=1    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0   

[bdqn@rhel01 demo1]$

可以看到，task aa正确执行之后，继续执行task bb。因为 task bb用的是fail来打印信, 所以执行完成之后就退出 playbook了，task cc并没有执行。?