Ansible（十三）-- ansible 中的变量（三）setup模块debug模块 fact事实变量

最新推荐文章于 2024-08-23 19:01:46 发布

chihtung_hsu

最新推荐文章于 2024-08-23 19:01:46 发布

阅读量1.3k

点赞数 1

分类专栏：企业实战之ansible

本文链接：https://blog.csdn.net/chitung_hsu/article/details/105505132

版权

企业实战之ansible 专栏收录该内容

22 篇文章

订阅专栏

本文深入解析Ansible的Facts机制，包括如何使用setup模块收集远程主机信息，自定义facts变量，利用debug模块进行调试，以及如何在playbook中有效利用这些信息。适合Ansible初学者及进阶用户。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、setup模块

当我们运行一个playbook时，默认都会运行一个名为”[Gathering Facts]”的任务，，ansible通过”[Gathering Facts]”这个默认任务收集远程主机的相关信息（例如远程主机的IP地址，主机名，系统版本，硬件配置等信息），其实，这些被收集到的远程主机信息会保存在对应的变量中，当我们想要使用这些信息时，我们可以获取对应的变量，从而使用这些信息。

如果想要查看”[Gathering Facts]”任务收集的信息内容，我们可以借助一个模块：setup模块

当执行playbook时，playbook其实就是自动调用了setup模块从而执行了”[Gathering Facts]”任务，所以我们可以通过手动执行setup模块查看”[Gathering Facts]”任务收集到的信息，示例如下

[root@server4 ~]# ansible testB -m setup

在这里插入图片描述上述ad-hoc命令表示收集testB主机的相关信息，执行上述命令后，远程主机testB的相关信息将会输出到ansible主机的控制台上，返回的信息的格式是json格式，返回信息如上图，是一个json格式的字符串，为了方便你阅读，ansible已经将格式化后的json信息返回到了控制台中，返回的信息很全面，比如：

在这里插入图片描述 ansible_distribution”表示远程主机的系统发行版，从其对应的值可以看出testB主机的系统发行版为Redhat

“ansible_distribution_version”表示远程主机的系统版本号，从其对应的值与 “ansible_distribution” 的值可以看出testB主机的系统版本为redhat7.3
在这里插入图片描述 “ansible_eth0″表示远程主机eth0网卡的相关信息。

“ansible_memory_mb”表示远程主机的内存配置信息。

返回的信息的确很多，很全面，但是，并不是每一次我们都需要看这么多信息，如果你只是想查看某一类信息，你可以通过关键字对信息进行过滤，比如，我只是想要查看远程主机的内存配置信息，那么我可以使用如下命令

 ansible testB -m setup -a 'filter=ansible_memory_mb'

上述命令表示通过”ansible_memory_mb”关键字对返回信息进行过滤，如你所见，通过setup模块的filter参数可以指定需要过滤的关键字，这样ansible就只会将”ansible_memory_mb”的相关信息返回，返回如下
在这里插入图片描述这样就精简很多了，因为精准的返回了你需要的信息，我知道，有的朋友可能跟我一样，记性不好，所以通常记不住准确的关键字，所以我们可以使用通配符，进行相对模糊的过滤，示例如下

ansible testB -m setup -a "filter=*mb*"

在这里插入图片描述

二、创建自定义facts事实变量

除了这些信息以外，我们还能够在远程主机中写入一些自定义的信息，这些自定义信息也可以被setup模块收集到。

ansible默认会去目标主机的/etc/ansible/facts.d目录下查找主机中的自定义信息，并且规定，自定义信息需要写在以.fact为后缀的文件中，同时，这些以.fact为后缀的文件中的内容需要是INI格式或者是json格式的。

那么，我们来创建一个测试文件，测试文件路径为testB主机的/etc/ansible/facts.d/info.fact，在文件中写入如下INI格式的信息。

cd /etc/ansible/facts.d/

[root@server3 facts.d]# cat info.fact 
[testmsg]
msg1=This is the first custom test message
msg2=This is the second custom test message

如上所示，上述内容是一段INI风格的内容，我在”[testmsg]”配置段中配置了两条自定义信息，msg1与msg2。

当然，我们也可以使用json格式进行配置，比如在/etc/ansible/facts.d/info.fact文件中写入如下配置，如下配置与上述配置的效果是相同的，只是书写格式不同。

{
   "testmsg":{
       "msg1":"This is the first custom test message",
       "msg2":"This is the second custom test message"
   }
}

通过上述方式，我们可以在目标主机的本地自定义信息，这些在远程主机本地自定义的信息被称为”local facts”，当我们运行setup模块时，远程主机的”local facts”信息也会被收集，我们可以通过”ansible_local”关键字过滤远程主机的”local facts”信息，示例命令如下

ansible testB -m setup -a "filter=ansible_local"

在这里插入图片描述

三、debug模块

见名知义，debug模块的作用就是帮助我们进行调试的，debug模块可以帮助我们把信息输出到ansible控制台上，以便我们能够定位问题。

[root@server4 ~]# cat debug01.yml 
---
- hosts: testB
  remote_user: root
  tasks:
  - name: touch testfile
    file:
      path: /testdir/testfile
      state: touch
  - name: debug demo
    debug:
      msg: this is debug info,The test file has been touched

上例中，我们先在test70主机上touch了对应的文件，然后，利用debug模块在控制台中输出了我们想要显示的信息，如你所见，debug模块的msg参数可以指定我们想要输出的信息，上述playbook表示touch完对应的文件以后，在ansible控制台中输出我们指定的信息，

debug模块除了能够使用msg参数输出自定义的信息，还能够直接输出变量中的信息，通过debug模块直接输出变量信息需要使用var参数，示例如下

[root@server4 ~]# cat debug02.yml 
---
- hosts: testB
  remote_user: root
  vars:
    testvar: value of test variable
  tasks:
  - name: debug demo
    debug:
      var: testvar

playbook中定义了一个变量，并且通过debug的var参数输出了这个变量的内容，
在这里插入图片描述变量的名称以及变量的值都输出到了屏幕上，这个功能可以帮助我们调试playbook中变量，让我们了解变量的值是否符合我们的要求。

当然，使用debug的msg参数时也可以引用变量的值，这样我们自定义的信息就更加灵活了，示例如下。

[root@server4 ~]# cat debug03.yml 
---
- hosts: testB
  remote_user: root
  vars:
    testvar: testv
  tasks:
  - name: debug demo
    debug:
      msg: "value of testvar is : {{testvar}}"

上例中的msg自定义信息中引用了testvar变量的值
在这里插入图片描述

四、在playbook使用facts变量

在这里插入图片描述 playbook在运行时默认都会运行”[Gathering Facts]”任务，”[Gathering Facts]”任务会收集远程主机的相关信息，这些信息会保存在对应的变量中，我们在playbook中可以使用这些变量，从而利用这些信息，

[root@server4 ~]# cat debug04.yml 
---
- hosts: testB
  remote_user: root
  tasks:
  - name: debug demo
    debug:
      msg: "Remote host memory information: {{ansible_memory_mb}}"

在这里插入图片描述如图所示，我们自定义的信息中包含了远程主机的内存信息，同时被输出了，只是格式上没有手动执行setup模块返回的信息格式易读，手动执行setup模块获取到的内存信息返回如下

testB | SUCCESS => {
   "ansible_facts": {
       "ansible_memory_mb": {
           "nocache": {
               "free": 1487,
               "used": 336
           },
           "real": {
               "free": 1151,
               "total": 1823,
               "used": 672
           },
           "swap": {
               "cached": 0,
               "free": 1023,
               "total": 1023,
               "used": 0
           }
       }
   },
   "changed": false
}

如上述返回信息所示，”ansible_memory_mb”中其实包含了 “nocache”、”real”、 “swap”三个部分的信息，如果我们只想获得”real”部分的信息，在playbook中引用变量时可以使用如下两种语法（即相当于使用属性调用变量）。

语法一示例：

debug:
     msg: "Remote host memory information : {{ansible_memory_mb.real}}"

语法二示例：

debug:
     msg: "Remote host memory information : {{ansible_memory_mb['real']}}"

[root@server4 ~]# cat debug04.yml 
---
- hosts: testB
  remote_user: root
  tasks:
  - name: debug demo
    debug:
      msg: "Remote host memory information: {{ansible_memory_mb.real}}"

在这里插入图片描述
上述两种语法前文中已经进行过示例，此处不再赘述。

其实，这些远程主机的变量信息不仅仅能够用于输出，我们通常会获取到这些信息以后，对这些信息的值进行判断，判断是否符合我们的要求，然后再执行下一步动作，比如，先获取到远程主机的系统发行版信息，然后判断发行版是centos6还是centos7，如果是centos6，我们就将准备好的A文件拷贝到远程主机中，如果是centos7，我们就将准备好的B文件拷贝到远程主机中。