Ansible Playbook 变量与 register 详解
ansible 定义变量方式与[多层]变量引用，以及 register 详解
主机规划
添加用户账号
说明：
1、 运维人员使用的登录账号；
2、 所有的业务都放在 /app/ 下「yun用户的家目录」，避免业务数据乱放；
3、 该用户也被 ansible 使用，因为几乎所有的生产环境都是禁止 root 远程登录的（因此该 yun 用户也进行了 sudo 提权）。
1 # 使用一个专门的用户，避免直接使用root用户 2 # 添加用户、指定家目录并指定用户密码 3 # sudo提权 4 # 让其它普通用户可以进入该目录查看信息 5 useradd -u 1050 -d /app yun && echo '123456' | /usr/bin/passwd --stdin yun 6 echo "yun ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers 7 chmod 755 /app/
Ansible 配置清单Inventory
之后文章都是如下主机配置清单
1 [yun@ansi-manager ansible_info]$ pwd 2 /app/ansible_info 3 [yun@ansi-manager ansible_info]$ cat hosts_key 4 # 方式1、主机 + 端口 + 密钥 5 [manageservers] 6 172.16.1.180:22 7 8 [proxyservers] 9 172.16.1.18[1:2]:22 10 11 # 方式2：别名 + 主机 + 端口 + 密码 12 [webservers] 13 web01 ansible_ssh_host=172.16.1.183 ansible_ssh_port=22 14 web02 ansible_ssh_host=172.16.1.184 ansible_ssh_port=22 15 web03 ansible_ssh_host=172.16.1.185 ansible_ssh_port=22
ansible 定义变量的三种方式
1、命令行中定义，通过 -e EXTRA_VARS, --extra-vars=EXTRA_VARS 定义
2、在 playbook 的 yml 文件中定义
3、在 inventory 清单中定义
4、变量名可以有下划线，但不能有中横线。
优先级：命令行定义变量 > playbook定义变量 > inventory 定义变量
如下内容也是按照优先级从低到高写的，如果是为了测试优先级那么你可以直接按照如下步骤测验。
测验内容：在不同的位置定义相同的变量，但变量值不同，然后在阿里云镜像源下载不同版本的 zabbix rpm 包。
地址：https://mirrors.aliyun.com/zabbix/zabbix/
在 inventory 清单中定义
有三种定义方式：
1、直接在 inventory 清单文件中定义变量「了解即可，不推荐使用」
2、通过 group_vars 定义变量
3、通过 host_vars 定义变量
自身内部的优先级：host_vars/主机名【或别名】 定义变量 > group_vars/清单组名 定义变量 > group_vars/all 定义变量> inventory 文件中直接定义变量
在 inventory 清单文件中定义变量「了解」
1 [yun@ansi-manager object02]$ pwd 2 /app/ansible_info/object02 3 [yun@ansi-manager object02]$ cat ../hosts_key 4 # 方式1、主机 + 端口 + 密钥 5 [manageservers] 6 172.16.1.180:22 7 8 [proxyservers] 9 172.16.1.18[1:2]:22 10 [proxyservers:vars] 11 zabbix_version=2.2 12 zabbix_rpm=zabbix-release-2.2-1.el7.noarch.rpm 13 ### ************ 定义变量如上 14 15 # 方式2：别名 + 主机 + 端口 + 密码 16 [webservers] 17 web01 ansible_ssh_host=172.16.1.183 ansible_ssh_port=22 18 web02 ansible_ssh_host=172.16.1.184 ansible_ssh_port=22 19 web03 ansible_ssh_host=172.16.1.185 ansible_ssh_port=22 20 21 [yun@ansi-manager object02]$ cat test_vars.yml 22 --- 23 # 下载 zabbix rpm包 24 - hosts: proxyservers 25 26 tasks: 27 - name: "download zabbix rpm" 28 get_url: 29 url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }} 30 dest: /tmp/ 31 32 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml # 语法检测 33 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml # 预执行，测试执行 34 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key test_vars.yml # 执行
然后就可以在目标机器 172.16.1.181、172.16.1.182 查看下载的 zabbix-release-2.2-1.el7.noarch.rpm 包了。
通过 group_vars 定义变量
注意事项：
1、要创建的 group_vars 目录要与 inventory 清单文件在同一个目录，或者与要执行的 playbook 的 yml 文件在同一个目录。
2、group_vars 目录下的文件名是 inventory 清单文件中的组名。或者文件名为 all「特殊组」，表示对所有机器主机生效。
在 group_vars/all 定义变量
1 [yun@ansi-manager object02]$ pwd 2 /app/ansible_info/object02 3 [yun@ansi-manager object02]$ ll /app/ansible_info/ 4 total 4 5 drwxrwxr-x 2 yun yun 17 Oct 15 14:55 group_vars 6 -rw-rw-r-- 1 yun yun 348 Oct 11 20:36 hosts_key 7 drwxrwxr-x 2 yun yun 27 Oct 11 20:56 object02 8 [yun@ansi-manager object02]$ cat /app/ansible_info/group_vars/all # all「特殊组」变量文件 9 zabbix_version: 2.4 10 zabbix_rpm: zabbix-release-2.4-1.el7.noarch.rpm 11 12 [yun@ansi-manager object02]$ cat test_vars.yml 13 --- 14 # 下载 zabbix rpm包 15 - hosts: proxyservers 16 17 tasks: 18 - name: "download zabbix rpm" 19 get_url: 20 url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }} 21 dest: /tmp/ 22 23 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml # 语法检测 24 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml # 预执行，测试执行 25 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key test_vars.yml # 执行
然后就可以在目标机器 172.16.1.181、172.16.1.182 查看下载的 zabbix-release-2.4-1.el7.noarch.rpm 包了。
在 group_vars/组 定义变量
1 [yun@ansi-manager object02]$ pwd 2 /app/ansible_info/object02 3 [yun@ansi-manager object02]$ ll /app/ansible_info/ 4 total 4 5 drwxrwxr-x 2 yun yun 17 Oct 15 14:55 group_vars 6 -rw-rw-r-- 1 yun yun 348 Oct 11 20:36 hosts_key 7 drwxrwxr-x 2 yun yun 27 Oct 11 20:56 object02 8 [yun@ansi-manager object02]$ cat /app/ansible_info/group_vars/proxyservers # inventory 清单文件中的组名 变量文件 9 zabbix_version: 3.0 10 zabbix_rpm: zabbix-release-3.0-1.el7.noarch.rpm 11 12 [yun@ansi-manager object02]$ cat test_vars.yml 13 --- 14 # 下载 zabbix rpm包 15 - hosts: proxyservers 16 17 tasks: 18 - name: "download zabbix rpm" 19 get_url: 20 url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }} 21 dest: /tmp/ 22 23 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml # 语法检测 24 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml # 预执行，测试执行 25 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key test_vars.yml # 执行
然后就可以在目标机器 172.16.1.181、172.16.1.182 查看下载的 zabbix-release-3.0-1.el7.noarch.rpm 包了。
通过 host_vars 定义变量
注意事项：
1、要创建的 host_vars 目录要与 inventory 清单文件在同一目录，或者与要执行的 playbook 的 yml 文件在同一个目录。
2、host_vars 目录下的文件名是 inventory 清单文件中的主机名或别名。如果有别名那么文件名为别名
1 [yun@ansi-manager object02]$ pwd 2 /app/ansible_info/object02 3 [yun@ansi-manager object02]$ ll /app/ansible_info/ 4 total 4 5 -rw-rw-r-- 1 yun yun 348 Oct 11 20:36 hosts_key 6 drwxrwxr-x 2 yun yun 26 Oct 15 15:50 host_vars 7 drwxrwxr-x 2 yun yun 27 Oct 11 20:56 object02 8 [yun@ansi-manager object02]$ cat /app/ansible_info/host_vars/172.16.1.181 # inventory 清单文件中的主机名或别名 变量文件 9 zabbix_version: 3.4 10 zabbix_rpm: zabbix-release-3.4-2.el7.noarch.rpm 11 12 [yun@ansi-manager object02]$ cat test_vars.yml 13 --- 14 # 下载 zabbix rpm包 15 - hosts: proxyservers 16 17 tasks: 18 - name: "download zabbix rpm" 19 get_url: 20 url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }} 21 dest: /tmp/ 22 23 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml # 语法检测 24 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml # 预执行，测试执行 25 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key test_vars.yml # 执行
然后就可以在目标机器 172.16.1.181 查看下载的 zabbix-release-3.4-2.el7.noarch.rpm 包了。
使用 playbook 定义变量
使用 playbook 定义变量有两种方式：
1、直接在要执行的 playbook 文件中定义变量。缺点是：这些变量无法与其他 playbook 共用。
2、将 playbook 中的变量抽出来，单独一个或多个文件 yml 文件。其他 playbook 文件要使用变量时，可以调用这些变量文件。好处是：可对变量集中管理，降低后期维护成本。「推荐使用」
自身内部优先级：playbook 引用文件变量 > 直接定义在要执行的 yml 文件中
直接在 playbook 中定义变量
变量写在要使用变量的 playbook 文件中。
1 [yun@ansi-manager object02]$ pwd 2 /app/ansible_info/object02 3 [yun@ansi-manager object02]$ ll 4 total 4 5 -rw-rw-r-- 1 yun yun 323 Oct 15 16:06 test_vars.yml 6 [yun@ansi-manager object02]$ cat test_vars.yml 7 --- 8 # 下载 zabbix rpm包 9 - hosts: proxyservers 10 # 变量定义 11 vars: 12 - zabbix_version: 3.5 13 - zabbix_rpm: zabbix-release-3.5-1.el7.noarch.rpm 14 15 tasks: 16 - name: "download zabbix rpm" 17 get_url: 18 url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }} 19 dest: /tmp/ 20 21 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml # 语法检测 22 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml # 预执行，测试执行 23 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key test_vars.yml # 执行
然后就可以在目标机器 172.16.1.181、172.16.1.182 查看下载的 zabbix-release-3.5-1.el7.noarch.rpm 包了。
playbook 引用变量文件
将 playbook 变量抽出来，使用单独的文件进行管理
1 [yun@ansi-manager object02]$ pwd 2 /app/ansible_info/object02 3 [yun@ansi-manager object02]$ ll /app/ansible_info/ 4 total 8 5 -rw-rw-r-- 1 yun yun 456 Oct 15 15:56 hosts_key 6 drwxrwxr-x 2 yun yun 27 Oct 15 16:08 object02 7 -rw-rw-r-- 1 yun yun 69 Oct 15 16:11 playbood_vars.yml 8 [yun@ansi-manager object02]$ cat /app/ansible_info/playbood_vars.yml # 单独文件定义的变量 9 zabbix_version: 4.0 10 zabbix_rpm: zabbix-release-4.0-1.el7.noarch.rpm 11 12 [yun@ansi-manager object02]$ cat test_vars.yml 13 --- 14 # 下载 zabbix rpm包 15 - hosts: proxyservers 16 # 变量引用 17 vars_files: ../playbood_vars.yml 18 19 # 变量定义 20 vars: 21 - zabbix_version: 3.5 22 - zabbix_rpm: zabbix-release-3.5-1.el7.noarch.rpm 23 24 tasks: 25 - name: "download zabbix rpm" 26 get_url: 27 url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }} 28 dest: /tmp/ 29 30 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml # 语法检测 31 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml # 预执行，测试执行 32 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key test_vars.yml # 执行
然后就可以在目标机器 172.16.1.181、172.16.1.182 查看下载的 zabbix-release-4.0-1.el7.noarch.rpm 包了。
使用命令行定义变量
优先级别最高，但只是临时使用。
1 [yun@ansi-manager object02]$ pwd 2 /app/ansible_info/object02 3 [yun@ansi-manager object02]$ ll 4 total 4 5 -rw-rw-r-- 1 yun yun 393 Oct 15 16:14 test_vars.yml 6 [yun@ansi-manager object02]$ cat test_vars.yml 7 --- 8 # 下载 zabbix rpm包 9 - hosts: proxyservers 10 # 变量引用 11 vars_files: ../playbood_vars.yml 12 13 # 变量定义 14 vars: 15 - zabbix_version: 3.5 16 - zabbix_rpm: zabbix-release-3.5-1.el7.noarch.rpm 17 18 tasks: 19 - name: "download zabbix rpm" 20 get_url: 21 url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }} 22 dest: /tmp/ 23 24 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -e "zabbix_version=4.1 zabbix_rpm=zabbix-release-4.1-1.el7.noarch.rpm" --syntax-check test_vars.yml # 语法检测 25 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -e "zabbix_version=4.1 zabbix_rpm=zabbix-release-4.1-1.el7.noarch.rpm" -C test_vars.yml # 预执行，测试执行 26 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -e "zabbix_version=4.1 zabbix_rpm=zabbix-release-4.1-1.el7.noarch.rpm" test_vars.yml # 执行
然后就可以在目标机器 172.16.1.181、172.16.1.182 查看下载的 zabbix-release-4.1-1.el7.noarch.rpm 包了。
多层级变量写法与引用
层级变量的写法与两种引用方式。
1 [yun@ansi-manager object02]$ pwd 2 /app/ansible_info/object02 3 [yun@ansi-manager object02]$ ll /app/ansible_info/ 4 total 12 5 -rw-rw-r-- 1 yun yun 456 Oct 15 15:56 hosts_key 6 drwxrwxr-x 2 yun yun 27 Oct 15 16:14 object02 7 -rw-rw-r-- 1 yun yun 76 Oct 15 16:26 playbood_vars_mult.yml 8 [yun@ansi-manager object02]$ cat /app/ansible_info/playbood_vars_mult.yml 9 # 多层级变量书写 10 zabbix_rpm_info: 11 version: 4.2 12 rpm: zabbix-release-4.2-1.el7.noarch.rpm 13 14 [yun@ansi-manager object02]$ cat test_vars_mult.yml # 具体的 playbook 信息 15 --- 16 # 下载 zabbix rpm包 17 - hosts: proxyservers 18 # 变量引用 19 vars_files: ../playbood_vars_mult.yml 20 21 tasks: 22 - name: "download zabbix rpm" 23 get_url: 24 # 下面写了两种方式引用变量，推荐使用后一种引用方式 25 url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_rpm_info.version }}/rhel/7/x86_64/{{ zabbix_rpm_info['rpm'] }} 26 dest: /tmp/ 27 28 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars_mult.yml # 语法检测 29 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars_mult.yml # 预执行，测试执行 30 [yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key test_vars_mult.yml # 执行
然后就可以在目标机器 172.16.1.181、172.16.1.182 查看下载的 zabbix-release-4.2-1.el7.noarch.rpm 包了。
register 注册变量
如何使用 register 注册变量
1 [yun@ansi-manager ansible_info]$ pwd 2 /app/ansible_info 3 [yun@ansi-manager ansible_info]$ ll 4 total 24 5 -rw-rw-r-- 1 yun yun 483 Aug 18 09:12 hosts_key 6 -rw-rw-r-- 1 yun yun 245 Aug 18 21:55 test_debug_register.yml 7 [yun@ansi-manager ansible_info]$ cat test_debug_register.yml 8 --- 9 # 如何使用 debug 模块与 register 变量 10 - hosts: proxyservers 11 12 tasks: 13 - name: "get host port info" 14 shell: netstat -lntp 15 register: host_port 16 17 - name: "print host port" 18 debug: 19 #msg: "{{ host_port }}" # 输出全部信息 20 #msg: "{{ host_port.cmd }}" # 引用方式一 21 msg: "{{ host_port['stdout_lines'] }}" # 引用方式二 22 23 [yun@ansi-manager ansible_info]$ ansible-playbook -b -i ./hosts_key test_debug_register.yml # 执行
第一个 task 中，使用了 register 注册变量，名为 host_port ；当 shell 模块执行完毕后，会将数据放到该变量中。
第二给 task 中，使用了 debug 模块，并从 host_port 中获取数据。
———END———
如果觉得不错就关注下呗 (-^O^-) ！
