10. 使用变量¶

虽然自动化的存在是为了让事情更容易重复，但并非所有的系统都是完全相同的;有些可能需要的配置与其他的稍有不同。在某些情况下，所观察到的一个系统的行为或状态可能会影响您配置其他系统的方式。例如，您可能需要找到一个系统的IP地址，并将其用作另一个系统上的配置值。

Ansible使用 变量(variables ) 来帮助处理系统之间的差异。

创建有效的变量名¶

在使用变量之前，你要先知道什么是 有效 的变量名称, 以下是变量名的遵循规则

• 变量名称应为 字母，数字 和 下划线。

• 变量应始终 以字母开头。

• 变量名不应与python属性和方法名冲突。

YAML还支持将键映射到值的字典

foo:
  field1: one
  field2: two

然后，您可以使用方括号符号或点符号来引用字典中的特定字段

foo['field1']
foo.field2

变量使用¶

通过命令行传递变量(extra vars)¶

通过--extra-vars或-e选项来传递key=value变量

ansible-playbook release.yml -e "user=starbuck"

当然，也可以传递字典

ansible-playbook arcade.yml -e '{"pacman":"mrs","ghosts":["inky","pinky","clyde","sue"]}'

变量文件的话，也是可以的

ansible-playbook test.yml -e @variables.yaml

yaml格式的变量，也是可以传递的

ansible-playbook arcade.yml --extra-vars '
pacman: mrs
ghosts:
  - inky
  - pinky
  - clyde
  - sue'

在inventory 中定义变量（inventory vars)¶

通常，您需要为单个主机或清单中的一组主机设置变量。

host3 http_port=80                        # 定义主机变量
[webservers:vars]                        # 定义组的变量
ntp_server= ntp.example.com

在play中定义变量（play vars）¶

你可以通过play的vars 关键字来定义变量

- hosts: webservers
  vars:
    http_port: 80

在角色和文件包含中定义变量(play include_vars)¶

通过在playbook中定义include_vars 模块，来包含变量文件

- hosts: webservers
  tasks:
    include_vars: myvars.yml

在play中包含变量文件(play vars_files)¶

你可以通过play的vars_files 关键字来定义变量的文件

- hosts: webservers
  vars_files:
    - /vars/external_vars.yml

定义角色默认变量（role defaults vars）¶

在角色目录中添加一个defaults/main.yml文件。文件里存储着yaml或json格式的数据。

# file: roles/x/defaults/main.yml
http_port: 80

定义角色变量（role vars）¶

在角色目录中添加一个vars/main.yml文件。文件里存储着yaml或json格式的数据。

# file: roles/x/vars/main.yml
http_port: 80

以交互方式获取变量值( play vars_prompt)¶

---
- hosts: server
  vars_prompt:
    - name: web
      prompt: 'Please input the web server:'
      private: no

定义角色变量（role and include vars)¶

在引入角色的时候，可以像角色传递一些变量

roles:
  - { role: app_user, name: Ian    }

name 就是传递给角色的变量

注册变量（registered vars）¶

变量的另一个主要用途是运行命令并将该命令的结果注册为变量。当您执行一个任务并将返回值保存在一个变量中供以后的任务使用时，您将创建一个已注册的变量。

---
- hosts: all 
  tasks:

    - shell: uptime
      register: result

    - name: show uptime
      debug: var=result

此选项将任务的结果存储在变量中，结果参数可以用在模版中。名称为result，使用debug来输出result的信息。也可以使用 {{ hostvars[inventory_hostname].result.stdout }} 可以获得注册变量的

结果因模块而异。 每个模块的文档都包含一个RETURN部分，描述该模块的返回值。 要查看特定任务的值，请使用-v运行您的剧本。

注册变量仅存储在内存中, 当您用循环在任务中注册一个变量时，已注册的变量包含循环中每个项的值。在循环期间放置在变量中的数据结构将包含一个results属性，它是来自模块的所有响应的列表。

以下是一些重要的注册变量的组件：

• changed: 显示是否已更改
• cmd: 执行的命令
• rc: 命令的返回码
• stdout:命令的输出
• stdout_lines: 逐行输出
• stderr: 如果有错误，则输出错误的信息
• stderr_lines: 逐行输出错误信息

动态创建fact变量¶

使用set_fact 在运行中设置 facts 变量

tasks:
  - command: whoami
    register: result
  - set_fact: w={{result.stdout}}
  - debug: var=w

变量优先级¶

上面列出了大部分的变量定义位置，这些不同位置的变量都是有优先级的，在不同位置上同时设置时，高优先级的会覆盖掉低优先级的变量，

下面是优先级从最小到最大的顺序(最后列出的变量是最高优先级)

1. command line values (eg “-u user”)
2. role defaults
3. inventory file or script group vars
4. inventory group_vars/all
5. playbook group_vars/all
6. inventory group_vars/*
7. playbook group_vars/*
8. inventory file or script host vars
9. inventory host_vars/*
10. playbook host_vars/*
11. host facts / cached set_facts
12. play vars
13. play vars_prompt
14. play vars_files
15. role vars (defined in role/vars/main.yml)
16. block vars (only for tasks in block)
17. task vars (only for the task)
18. include_vars
19. set_facts / registered vars
20. role (and include_role) params
21. include params
22. extra vars (always win precedence) 命令行变量

变量范围¶

您可以根据希望的范围来决定在何处设置变量。Ansible有三个主要的范围

• 全局：这是由config，环境变量和命令行设置的

• play：每个play和包含的结构，vars条目(vars; vars_files; vars_prompt)，角色默认变量和vars。

• 主机：直接与主机相关联的变量，像inventory, include_vars, facts or registered

使用变量¶

在jinja2中使用¶

一旦定义了变量，就可以在使用Jinja2模板系统的剧本中使用它们。这是一个简单的Jinja2模板

My amp goes to {{ max_amp_value }}

这个表达式提供了最基本的变量替换形式。

您可以在剧本中使用相同的语法。例如

template: src=foo.cfg.j2 dest={{ remote_install_path }}/foo.cfg

使用Jinja2过滤器转换变量¶

Jinja2过滤器允许您在模板表达式中转换变量的值。例如，capitalize过滤器将传递给它的任何值都大写;to_yaml和to_json过滤器会更改变量值的格式。

YAML语法要求，如果您以{{foo}}开始一个值，则必须 用引号包裹整行，因为它希望确保您没有试图启动YAML字典。YAML语法文档对此进行了介绍。

下面这个时错误的写法

- hosts: app_servers
  vars:
      app_path: {{ base_path }}/22

这样写，才是对的。

- hosts: app_servers
  vars:
       app_path: "{{ base_path }}/22"

从系统中发现变量:Facts¶

还有其他地方可以使用变量，但是这些是被发现的变量类型，不是由用户设置的。

Facts是通过与远程系统对话而获得的信息。数据存储在ansible_facts变量中，你可以通过下列示例来获取变量中的信息

- debug: var=ansible_facts

或者使用setup模块

ansible hostname -m setup

访问复杂变量数据¶

使用嵌套数据结构访问变量

{{ ansible_facts["eth0"]["ipv4"]["address"] }}

或者使用.符号

{{ ansible_facts.eth0.ipv4.address }}

类似地，这是我们访问数组的第一个元素的方式

{{ foo[0] }}

使用内置变量¶

ansible 提供了许多内置变量，来帮助大家获取当前运行的诸多信息，通过内置变量，我们可以做更多的事情，比如获取主机的自定义fact，获取当前运行的主机等等。

魔术变量¶

Facts 变量¶

连接变量¶

评论