Ansible Playbook 變量與 register 詳解

ansible 定義變量方式與[多層]變量引用，以及 register 詳解

主機規劃

主機名稱	操作系統版本	內網IP	外網IP(模擬)	安裝軟件
ansi-manager	CentOS7.5	172.16.1.180	10.0.0.180	ansible
ansi-haproxy01	CentOS7.5	172.16.1.181	10.0.0.181
ansi-haproxy02	CentOS7.5	172.16.1.182	10.0.0.182
ansi-web01	CentOS7.5	172.16.1.183	10.0.0.183
ansi-web02	CentOS7.5	172.16.1.184	10.0.0.184
ansi-web03	CentOS7.5	172.16.1.185	10.0.0.185

添加用戶賬號

說明：

1、 運維人員使用的登錄賬號；

2、 所有的業務都放在 /app/ 下「yun用戶的家目錄」，避免業務數據亂放；

3、 該用戶也被 ansible 使用，因爲幾乎所有的生產環境都是禁止 root 遠程登錄的（因此該 yun 用戶也進行了 sudo 提權）。

# 使用一個專門的用戶，避免直接使用root用戶
# 添加用戶、指定家目錄並指定用戶密碼
# sudo提權
# 讓其它普通用戶可以進入該目錄查看信息
useradd -u 1050 -d /app yun && echo '123456' | /usr/bin/passwd --stdin yun
echo "yun  ALL=(ALL)       NOPASSWD: ALL" >>  /etc/sudoers
chmod 755 /app/

Ansible 配置清單Inventory

之後文章都是如下主機配置清單

[yun@ansi-manager ansible_info]$ pwd
/app/ansible_info
[yun@ansi-manager ansible_info]$ cat hosts_key 
# 方式1、主機 + 端口 + 密鑰
[manageservers]
172.16.1.180:22

[proxyservers]
172.16.1.18[1:2]:22

# 方式2：別名 + 主機 + 端口 + 密碼
[webservers]
web01 ansible_ssh_host=172.16.1.183 ansible_ssh_port=22
web02 ansible_ssh_host=172.16.1.184 ansible_ssh_port=22
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 清單文件中定義變量「瞭解」

[yun@ansi-manager object02]$ pwd
/app/ansible_info/object02
[yun@ansi-manager object02]$ cat ../hosts_key 
# 方式1、主機 + 端口 + 密鑰
[manageservers]
172.16.1.180:22

[proxyservers]
172.16.1.18[1:2]:22
[proxyservers:vars]
zabbix_version=2.2
zabbix_rpm=zabbix-release-2.2-1.el7.noarch.rpm
### ************ 定義變量如上

# 方式2：別名 + 主機 + 端口 + 密碼
[webservers]
web01 ansible_ssh_host=172.16.1.183 ansible_ssh_port=22
web02 ansible_ssh_host=172.16.1.184 ansible_ssh_port=22
web03 ansible_ssh_host=172.16.1.185 ansible_ssh_port=22

[yun@ansi-manager object02]$ cat test_vars.yml 
---
# 下載 zabbix rpm包
- hosts: proxyservers

  tasks:
    - name: "download zabbix rpm"
      get_url:
        url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }}
        dest: /tmp/

[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml  # 語法檢測
[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml  # 預執行，測試執行
[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 定義變量

[yun@ansi-manager object02]$ pwd
/app/ansible_info/object02
[yun@ansi-manager object02]$ ll /app/ansible_info/
total 4
drwxrwxr-x 2 yun yun  17 Oct 15 14:55 group_vars
-rw-rw-r-- 1 yun yun 348 Oct 11 20:36 hosts_key
drwxrwxr-x 2 yun yun  27 Oct 11 20:56 object02 
[yun@ansi-manager object02]$ cat /app/ansible_info/group_vars/all   # all「特殊組」變量文件
zabbix_version: 2.4
zabbix_rpm: zabbix-release-2.4-1.el7.noarch.rpm

[yun@ansi-manager object02]$ cat test_vars.yml 
---
# 下載 zabbix rpm包
- hosts: proxyservers

  tasks:
    - name: "download zabbix rpm"
      get_url:
        url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }}
        dest: /tmp/

[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml  # 語法檢測
[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml  # 預執行，測試執行
[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/組 定義變量

[yun@ansi-manager object02]$ pwd
/app/ansible_info/object02
[yun@ansi-manager object02]$ ll /app/ansible_info/
total 4
drwxrwxr-x 2 yun yun  17 Oct 15 14:55 group_vars
-rw-rw-r-- 1 yun yun 348 Oct 11 20:36 hosts_key
drwxrwxr-x 2 yun yun  27 Oct 11 20:56 object02 
[yun@ansi-manager object02]$ cat /app/ansible_info/group_vars/proxyservers   # inventory 清單文件中的組名 變量文件
zabbix_version: 3.0
zabbix_rpm: zabbix-release-3.0-1.el7.noarch.rpm

[yun@ansi-manager object02]$ cat test_vars.yml 
---
# 下載 zabbix rpm包
- hosts: proxyservers

  tasks:
    - name: "download zabbix rpm"
      get_url:
        url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }}
        dest: /tmp/

[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml  # 語法檢測
[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml  # 預執行，測試執行
[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 清單文件中的主機名或別名。如果有別名那麼文件名爲別名

[yun@ansi-manager object02]$ pwd
/app/ansible_info/object02
[yun@ansi-manager object02]$ ll /app/ansible_info/
total 4
-rw-rw-r-- 1 yun yun 348 Oct 11 20:36 hosts_key
drwxrwxr-x 2 yun yun  26 Oct 15 15:50 host_vars
drwxrwxr-x 2 yun yun  27 Oct 11 20:56 object02 
[yun@ansi-manager object02]$ cat /app/ansible_info/host_vars/172.16.1.181    # inventory 清單文件中的主機名或別名 變量文件
zabbix_version: 3.4
zabbix_rpm: zabbix-release-3.4-2.el7.noarch.rpm

[yun@ansi-manager object02]$ cat test_vars.yml 
---
# 下載 zabbix rpm包
- hosts: proxyservers

  tasks:
    - name: "download zabbix rpm"
      get_url:
        url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }}
        dest: /tmp/

[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml  # 語法檢測
[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml  # 預執行，測試執行
[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 文件中。

[yun@ansi-manager object02]$ pwd
/app/ansible_info/object02
[yun@ansi-manager object02]$ ll
total 4
-rw-rw-r-- 1 yun yun 323 Oct 15 16:06 test_vars.yml
[yun@ansi-manager object02]$ cat test_vars.yml 
---
# 下載 zabbix rpm包
- hosts: proxyservers
  # 變量定義
  vars:
    - zabbix_version: 3.5
    - zabbix_rpm: zabbix-release-3.5-1.el7.noarch.rpm

  tasks:
    - name: "download zabbix rpm"
      get_url:
        url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }}
        dest: /tmp/

[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml  # 語法檢測
[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml  # 預執行，測試執行
[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 變量抽出來，使用單獨的文件進行管理

[yun@ansi-manager object02]$ pwd
/app/ansible_info/object02
[yun@ansi-manager object02]$ ll /app/ansible_info/
total 8
-rw-rw-r-- 1 yun yun 456 Oct 15 15:56 hosts_key
drwxrwxr-x 2 yun yun  27 Oct 15 16:08 object02
-rw-rw-r-- 1 yun yun  69 Oct 15 16:11 playbood_vars.yml
[yun@ansi-manager object02]$ cat /app/ansible_info/playbood_vars.yml  # 單獨文件定義的變量
zabbix_version: 4.0
zabbix_rpm: zabbix-release-4.0-1.el7.noarch.rpm

[yun@ansi-manager object02]$ cat test_vars.yml 
---
# 下載 zabbix rpm包
- hosts: proxyservers
  # 變量引用
  vars_files: ../playbood_vars.yml

  # 變量定義
  vars:
    - zabbix_version: 3.5
    - zabbix_rpm: zabbix-release-3.5-1.el7.noarch.rpm

  tasks:
    - name: "download zabbix rpm"
      get_url:
        url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }}
        dest: /tmp/

[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars.yml  # 語法檢測
[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars.yml  # 預執行，測試執行
[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 包了。

使用命令行定義變量

優先級別最高，但只是臨時使用。

[yun@ansi-manager object02]$ pwd
/app/ansible_info/object02
[yun@ansi-manager object02]$ ll 
total 4
-rw-rw-r-- 1 yun yun 393 Oct 15 16:14 test_vars.yml
[yun@ansi-manager object02]$ cat test_vars.yml 
---
# 下載 zabbix rpm包
- hosts: proxyservers
  # 變量引用
  vars_files: ../playbood_vars.yml

  # 變量定義
  vars:
    - zabbix_version: 3.5
    - zabbix_rpm: zabbix-release-3.5-1.el7.noarch.rpm

  tasks:
    - name: "download zabbix rpm"
      get_url:
        url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_version }}/rhel/7/x86_64/{{ zabbix_rpm }}
        dest: /tmp/

[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  # 語法檢測
[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  # 預執行，測試執行
[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 包了。

多層級變量寫法與引用

層級變量的寫法與兩種引用方式。

[yun@ansi-manager object02]$ pwd
/app/ansible_info/object02
[yun@ansi-manager object02]$ ll /app/ansible_info/
total 12
-rw-rw-r-- 1 yun yun 456 Oct 15 15:56 hosts_key
drwxrwxr-x 2 yun yun  27 Oct 15 16:14 object02
-rw-rw-r-- 1 yun yun  76 Oct 15 16:26 playbood_vars_mult.yml
[yun@ansi-manager object02]$ cat /app/ansible_info/playbood_vars_mult.yml 
# 多層級變量書寫
zabbix_rpm_info:
  version: 4.2
  rpm: zabbix-release-4.2-1.el7.noarch.rpm

[yun@ansi-manager object02]$ cat test_vars_mult.yml  # 具體的 playbook 信息
---
# 下載 zabbix rpm包
- hosts: proxyservers
  # 變量引用
  vars_files: ../playbood_vars_mult.yml

  tasks:
    - name: "download zabbix rpm"
      get_url:
        # 下面寫了兩種方式引用變量，推薦使用後一種引用方式
        url: https://mirrors.aliyun.com/zabbix/zabbix/{{ zabbix_rpm_info.version }}/rhel/7/x86_64/{{ zabbix_rpm_info['rpm'] }}
        dest: /tmp/

[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key --syntax-check test_vars_mult.yml  # 語法檢測
[yun@ansi-manager object02]$ ansible-playbook -b -i ../hosts_key -C test_vars_mult.yml  # 預執行，測試執行
[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 註冊變量

[yun@ansi-manager ansible_info]$ pwd
/app/ansible_info
[yun@ansi-manager ansible_info]$ ll
total 24
-rw-rw-r-- 1 yun yun  483 Aug 18 09:12 hosts_key
-rw-rw-r-- 1 yun yun  245 Aug 18 21:55 test_debug_register.yml
[yun@ansi-manager ansible_info]$ cat test_debug_register.yml 
---
# 如何使用 debug 模塊與 register 變量
- hosts: proxyservers

  tasks:
    - name: "get host port info"
      shell: netstat -lntp
      register: host_port

    - name: "print host port"
      debug:
        #msg: "{{ host_port }}"   # 輸出全部信息
        #msg: "{{ host_port.cmd }}"   # 引用方式一
        msg: "{{ host_port['stdout_lines'] }}"  # 引用方式二

[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^-) ！