黑帽联盟

标题: ansible笔记(15):变量(二) [打印本页]

作者: yun    时间: 2019-9-8 14:03
标题: ansible笔记(15):变量(二)
本帖最后由 yun 于 2019-9-11 17:22 编辑

ansible是一个系列文章,我们会尽量以通俗易懂的方式总结ansible的相关知识点。
ansible系列博文直达链接:ansible轻松入门系列
"ansible系列"中的每篇文章都建立在前文的基础之上,所以,请按照顺序阅读这些文章,否则有可能在阅读中遇到障碍。


前一篇文章中已经初步的总结了变量的一些使用方法,这篇文章我们继续,只不过,这篇文章所涉及到的内容需要借助两个模块,所以在详细的总结变量的相关使用方法之前,会先描述一下这两个模块的用法。

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

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

当执行playbook时,playbook其实就是自动调用了setup模块从而执行了"[Gathering Facts]"任务,所以我们可以通过手动执行setup模块查看"[Gathering Facts]"任务收集到的信息,示例如下
  1. ansible test70 -m setup
复制代码
上述ad-hoc命令表示收集test70主机的相关信息,执行上述命令后,远程主机test70的相关信息将会输出到ansible主机的控制台上,返回的信息的格式是json格式,我的返回信息如下。
注:由于返回的信息比较多,此处为了方便示例,我将部分内容删除(或折叠省略)了,所以如下返回信息并不完全,只用于示意。
  1. test70 | SUCCESS =>
  2. {
  3.     "ansible_facts":{
  4.         "ansible_all_ipv4_addresses":[
  5.             "192.168.122.1",
  6.             "192.168.1.106",
  7.             "10.1.1.70",
  8.             "172.16.66.70"
  9.         ],
  10.         "ansible_all_ipv6_addresses":Array[2],
  11.         "ansible_apparmor":Object{...},
  12.         "ansible_architecture":"x86_64",
  13.         "ansible_bios_date":"05/19/2017",
  14.         "ansible_bios_version":"6.00",
  15.         "ansible_cmdline":Object{...},
  16.         "ansible_date_time":Object{...},
  17.         "ansible_default_ipv4":Object{...},
  18.         "ansible_default_ipv6":Object{...},
  19.         "ansible_device_links":Object{...},
  20.         "ansible_devices":Object{...},
  21.         "ansible_distribution":"CentOS",
  22.         "ansible_distribution_file_parsed":true,
  23.         "ansible_distribution_file_path":"/etc/redhat-release",
  24.         "ansible_distribution_file_variety":"RedHat",
  25.         "ansible_distribution_major_version":"7",
  26.         "ansible_distribution_release":"Core",
  27.         "ansible_distribution_version":"7.4.1708",
  28.         "ansible_dns":Object{...},
  29.         "ansible_domain":"",
  30.         "ansible_effective_group_id":0,
  31.         "ansible_effective_user_id":0,
  32.         "ansible_ens33":Object{...},
  33.         "ansible_ens34":Object{...},
  34.         "ansible_ens35":{
  35.             "active":true,
  36.             "device":"ens35",
  37.             "features":{
  38.                 "busy_poll":"off [fixed]",
  39.                 "fcoe_mtu":"off [fixed]",
  40.                 "generic_receive_offload":"on",
  41.                 "generic_segmentation_offload":"on",
  42.                 "highdma":"off [fixed]",
  43.                 "hw_tc_offload":"off [fixed]",
  44.                 "l2_fwd_offload":"off [fixed]",
  45.                 "large_receive_offload":"off [fixed]",
  46.                 "loopback":"off [fixed]",
  47.                 "netns_local":"off [fixed]",
  48.                 "ntuple_filters":"off [fixed]",
  49.                 "receive_hashing":"off [fixed]",
  50.                 "rx_all":"off",
  51.                 "rx_checksumming":"off",
  52.                 "rx_fcs":"off",
  53.                 "rx_vlan_filter":"on [fixed]",
  54.                 "rx_vlan_offload":"on",
  55.                 "rx_vlan_stag_filter":"off [fixed]",
  56.                 "rx_vlan_stag_hw_parse":"off [fixed]",
  57.                 "scatter_gather":"on",
  58.                 "tcp_segmentation_offload":"on",
  59.                 "tx_checksum_fcoe_crc":"off [fixed]",
  60.                 "tx_checksum_ip_generic":"on",
  61.                 "tx_checksum_ipv4":"off [fixed]",
  62.                 "tx_checksum_ipv6":"off [fixed]",
  63.                 "tx_checksum_sctp":"off [fixed]",
  64.                 "tx_checksumming":"on",
  65.                 "tx_fcoe_segmentation":"off [fixed]",
  66.                 "tx_gre_csum_segmentation":"off [fixed]",
  67.                 "tx_gre_segmentation":"off [fixed]",
  68.                 "tx_gso_partial":"off [fixed]",
  69.                 "tx_gso_robust":"off [fixed]",
  70.                 "tx_ipip_segmentation":"off [fixed]",
  71.                 "tx_lockless":"off [fixed]",
  72.                 "tx_mpls_segmentation":"off [fixed]",
  73.                 "tx_nocache_copy":"off",
  74.                 "tx_scatter_gather":"on",
  75.                 "tx_scatter_gather_fraglist":"off [fixed]",
  76.                 "tx_sctp_segmentation":"off [fixed]",
  77.                 "tx_sit_segmentation":"off [fixed]",
  78.                 "tx_tcp6_segmentation":"off [fixed]",
  79.                 "tx_tcp_ecn_segmentation":"off [fixed]",
  80.                 "tx_tcp_mangleid_segmentation":"off",
  81.                 "tx_tcp_segmentation":"on",
  82.                 "tx_udp_tnl_csum_segmentation":"off [fixed]",
  83.                 "tx_udp_tnl_segmentation":"off [fixed]",
  84.                 "tx_vlan_offload":"on [fixed]",
  85.                 "tx_vlan_stag_hw_insert":"off [fixed]",
  86.                 "udp_fragmentation_offload":"off [fixed]",
  87.                 "vlan_challenged":"off [fixed]"
  88.             },
  89.             "hw_timestamp_filters":[


  90.             ],
  91.             "ipv4":{
  92.                 "address":"10.1.1.70",
  93.                 "broadcast":"10.1.1.255",
  94.                 "netmask":"255.255.255.0",
  95.                 "network":"10.1.1.0"
  96.             },
  97.             "ipv6":[
  98.                 {
  99.                     "address":"fe80::250:56ff:fe25:5fb0",
  100.                     "prefix":"64",
  101.                     "scope":"link"
  102.                 }
  103.             ],
  104.             "macaddress":"00:50:56:25:5f:b0",
  105.             "module":"e1000",
  106.             "mtu":1500,
  107.             "pciid":"0000:02:03.0",
  108.             "promisc":false,
  109.             "speed":1000,
  110.             "timestamping":[
  111.                 "tx_software",
  112.                 "rx_software",
  113.                 "software"
  114.             ],
  115.             "type":"ether"
  116.         },
  117.         "ansible_env":Object{...},
  118.         "ansible_fips":false,
  119.         "ansible_form_factor":"Other",
  120.         "ansible_fqdn":"test70",
  121.         "ansible_hostname":"test70",
  122.         "ansible_interfaces":Array[6],
  123.         "ansible_kernel":"3.10.0-693.el7.x86_64",
  124.         "ansible_lo":Object{...},
  125.         "ansible_local":Object{...},
  126.         "ansible_lsb":Object{...},
  127.         "ansible_lvm":Object{...},
  128.         "ansible_machine":"x86_64",
  129.         "ansible_machine_id":"f6d15ac15f624d3db89e843639a52cc0",
  130.         "ansible_memfree_mb":1121,
  131.         "ansible_memory_mb":{
  132.             "nocache":{
  133.                 "free":1467,
  134.                 "used":356
  135.             },
  136.             "real":{
  137.                 "free":1121,
  138.                 "total":1823,
  139.                 "used":702
  140.             },
  141.             "swap":{
  142.                 "cached":0,
  143.                 "free":1023,
  144.                 "total":1023,
  145.                 "used":0
  146.             }
  147.         },
  148.         "ansible_memtotal_mb":1823,
  149.         "ansible_mounts":Array[2],
  150.         "ansible_nodename":"test70",
  151.         "ansible_os_family":"RedHat",
  152.         "ansible_pkg_mgr":"yum",
  153.         "ansible_processor":Array[6],
  154.         "ansible_processor_cores":2,
  155.         "ansible_processor_count":1,
  156.         "ansible_processor_threads_per_core":1,
  157.         "ansible_processor_vcpus":2,
  158.         "ansible_product_name":"VMware Virtual Platform",
  159.         "ansible_product_serial":"VMware-56 4d 0d 63 80 3f 29 b4-f0 e2 1b 7a ff 01 a5 9e",
  160.         "ansible_product_uuid":"630D4D56-3F80-B429-F0E2-1B7AFF01A59E",
  161.         "ansible_product_version":"None",
  162.         "ansible_python":Object{...},
  163.         "ansible_python_version":"2.7.5",
  164.         "ansible_real_group_id":0,
  165.         "ansible_real_user_id":0,
  166.         "ansible_selinux":Object{...},
  167.         "ansible_selinux_python_present":true,
  168.         "ansible_service_mgr":"systemd",
  169.         "ansible_swapfree_mb":1023,
  170.         "ansible_swaptotal_mb":1023,
  171.         "ansible_system":"Linux",
  172.         "ansible_system_capabilities":Array[37],
  173.         "ansible_system_capabilities_enforced":"True",
  174.         "ansible_system_vendor":"VMware, Inc.",
  175.         "ansible_uptime_seconds":31658,
  176.         "ansible_user_dir":"/root",
  177.         "ansible_user_gecos":"root",
  178.         "ansible_user_gid":0,
  179.         "ansible_user_id":"root",
  180.         "ansible_user_shell":"/bin/bash",
  181.         "ansible_user_uid":0,
  182.         "ansible_userspace_architecture":"x86_64",
  183.         "ansible_userspace_bits":"64",
  184.         "ansible_virbr0":Object{...},
  185.         "ansible_virbr0_nic":Object{...},
  186.         "ansible_virtualization_role":"guest",
  187.         "ansible_virtualization_type":"VMware",
  188.         "gather_subset":Array[1],
  189.         "module_setup":true
  190.     },
  191.     "changed":false
  192. }
复制代码
返回信息如上,是一个json格式的字符串,为了方便你阅读,ansible已经将格式化后的json信息返回到了控制台中,返回的信息很全面,比如:
"ansible_all_ipv4_addresses"表示远程主机中的所有ipv4地址,从其对应的值可以看出,test70主机上一共有4个ipv4地址。
"ansible_distribution"表示远程主机的系统发行版,从其对应的值可以看出test70主机的系统发行版为centos
"ansible_distribution_version"表示远程主机的系统版本号,从其对应的值与  "ansible_distribution" 的值可以看出test70主机的系统版本为centos7.4
"ansible_ens35"表示远程主机ens35网卡的相关信息,细心如你一定也发现了,我还有两个名为"ens33"和"ens34"的网卡,只不过为了方便示例,这两个网卡的信息被我省略了。
"ansible_memory_mb"表示远程主机的内存配置信息。

返回的信息的确很多,很全面,但是,并不是每一次我们都需要看这么多信息,如果你只是想查看某一类信息,你可以通过关键字对信息进行过滤,比如,我只是想要查看远程主机的内存配置信息,那么我可以使用如下命令
  1. ansible test70 -m setup -a 'filter=ansible_memory_mb'
复制代码
上述命令表示通过"ansible_memory_mb"关键字对返回信息进行过滤,如你所见,通过setup模块的filter参数可以指定需要过滤的关键字,这样ansible就只会将"ansible_memory_mb"的相关信息返回,返回如下
  1. test70 | SUCCESS => {
  2.    "ansible_facts": {
  3.        "ansible_memory_mb": {
  4.            "nocache": {
  5.                "free": 1467,
  6.                "used": 356
  7.            },
  8.            "real": {
  9.                "free": 1119,
  10.                "total": 1823,
  11.                "used": 704
  12.            },
  13.            "swap": {
  14.                "cached": 0,
  15.                "free": 1023,
  16.                "total": 1023,
  17.                "used": 0
  18.            }
  19.        }
  20.    },
  21.    "changed": false
  22. }
复制代码
这样就精简很多了,因为精准的返回了你需要的信息,我知道,有的朋友可能跟我一样,记性不好,所以通常记不住准确的关键字,所以我们可以使用通配符,进行相对模糊的过滤,示例如下
  1. ansible test70 -m setup -a "filter=*mb*"
复制代码
上述命令表示返回所有包含mb的关键字对应的信息,返回信息如下
  1. test70 | SUCCESS => {
  2.    "ansible_facts": {
  3.        "ansible_memfree_mb": 1140,
  4.        "ansible_memory_mb": {
  5.            "nocache": {
  6.                "free": 1475,
  7.                "used": 348
  8.            },
  9.            "real": {
  10.                "free": 1140,
  11.                "total": 1823,
  12.                "used": 683
  13.            },
  14.            "swap": {
  15.                "cached": 0,
  16.                "free": 1023,
  17.                "total": 1023,
  18.                "used": 0
  19.            }
  20.        },
  21.        "ansible_memtotal_mb": 1823,
  22.        "ansible_swapfree_mb": 1023,
  23.        "ansible_swaptotal_mb": 1023
  24.    },
  25.    "changed": false
  26. }
复制代码
其实,除了这些信息以外,我们还能够在远程主机中写入一些自定义的信息,这些自定义信息也可以被setup模块收集到。

那么,我们应该在哪里定义这些信息呢?该怎样定义这些信息呢?
ansible默认会去目标主机的/etc/ansible/facts.d目录下查找主机中的自定义信息,并且规定,自定义信息需要写在以".fact"为后缀的文件中,同时,这些以".fact"为后缀的文件中的内容需要是INI格式或者是json格式的。

那么,我们来创建一个测试文件,测试文件路径为test70主机的/etc/ansible/facts.d/testinfo.fact,在文件中写入如下INI格式的信息。
  1. [root@test70 facts.d]# cat testinfo.fact
  2. [testmsg]
  3. msg1=This is the first custom test message
  4. msg2=This is the second custom test message
复制代码
如上所示,上述内容是一段INI风格的内容,我在"[testmsg]"配置段中配置了两条自定义信息,msg1与msg2。  
当然,我们也可以使用json格式进行配置,比如在/etc/ansible/facts.d/testinfo.fact文件中写入如下配置,如下配置与上述配置的效果是相同的,只是书写格式不同。
  1. {
  2.    "testmsg":{
  3.        "msg1":"This is the first custom test message",
  4.        "msg2":"This is the second custom test message"
  5.    }
  6. }
复制代码
通过上述方式,我们可以在目标主机的本地自定义信息,这些在远程主机本地自定义的信息被称为"local facts",当我们运行setup模块时,远程主机的"local facts"信息也会被收集,我们可以通过"ansible_local"关键字过滤远程主机的"local facts"信息,示例命令如下
  1. ansible test70 -m setup -a "filter=ansible_local"
复制代码
上述命令返回的信息如下
  1. test70 | SUCCESS => {
  2.    "ansible_facts": {
  3.        "ansible_local": {
  4.            "testinfo": {
  5.                "testmsg": {
  6.                    "msg1": "This is the first custom test message",
  7.                    "msg2": "This is the second custom test message"
  8.                }
  9.            }
  10.        }
  11.    },
  12.    "changed": false
  13. }
复制代码
之前说过,当setup收集远程主机的"local facts"时,默认会查找远程主机的/etc/ansible/facts.d目录,如果你把"local facts"信息文件放在了其他自定义路径,在使用setup模块时,需要使用"fact_path"参数指定对应的路径,假设,我把".fact"文件放在了目标主机的"/testdir"目录下,示例命令如下
  1. ansible test70 -m setup -a 'fact_path=/testdir'
复制代码
其实,setup模块返回的这些信息都存在了对应的变量中,我们可以通过引用变量从而使用对应的信息,但是别急,我们先来了解一下另外一个模块,这个模块叫"debug模块"。

见名知义,debug模块的作用就是帮助我们进行调试的,debug模块可以帮助我们把信息输出到ansible控制台上,以便我们能够定位问题。
那么我们先来看一个debug模块的playbook小示例,如下
  1. ---
  2. - hosts: test70
  3.   remote_user: root
  4.   tasks:
  5.   - name: touch testfile
  6.     file:
  7.       path: /testdir/testfile
  8.       state: touch
  9.   - name: debug demo
  10.     debug:
  11.       msg: this is debug info,The test file has been touched
复制代码
上例中,我们先在test70主机上touch了对应的文件,然后,利用debug模块在控制台中输出了我们想要显示的信息,如你所见,debug模块的msg参数可以指定我们想要输出的信息,上述playbook表示touch完对应的文件以后,在ansible控制台中输出我们指定的信息,那么我们运行一下这个测试剧本,看一下效果,如下
1.png
如图所示,自定义信息已经输出在ansible控制台中。

debug模块除了能够使用msg参数输出自定义的信息,还能够直接输出变量中的信息,通过debug模块直接输出变量信息需要使用var参数,示例如下
  1. ---
  2. - hosts: test70
  3.   remote_user: root
  4.   vars:
  5.     testvar: value of test variable
  6.   tasks:
  7.   - name: debug demo
  8.     debug:
  9.       var: testvar
复制代码
上例虽然连接到了test70远程主机,但是并没有对test70做任何操作,只是在playbook中定义了一个变量,并且通过debug的var参数输出了这个变量的内容,只是为了单纯的演示debug模块的var参数的使用方法,上述playbook的执行效果如下
2.png
变量的名称以及变量的值都输出到了屏幕上,这个功能可以帮助我们调试playbook中变量,让我们了解变量的值是否符合我们的要求。

当然,使用debug的msg参数时也可以引用变量的值,这样我们自定义的信息就更加灵活了,示例如下。
  1. ---
  2. - hosts: test70
  3.   remote_user: root
  4.   vars:
  5.     testvar: testv
  6.   tasks:
  7.   - name: debug demo
  8.     debug:
  9.       msg: "value of testvar is : {{testvar}}"
复制代码
上例中的msg自定义信息中引用了testvar变量的值
注:上例中msg的值需要使用引号引起,因为{{testvar}}变量前包含"冒号",如果不使用引号会报语法错误。
上例输出效果如下
3.png

setup模块与debug模块了解完了,现在绕回一开始的话题,playbook在运行时默认都会运行"[Gathering Facts]"任务,"[Gathering Facts]"任务会收集远程主机的相关信息,这些信息会保存在对应的变量中,我们在playbook中可以使用这些变量,从而利用这些信息,那么我们怎样在playbook获取到这些变量的值呢?在setup模块的示例中,我们可以通过"ansible_memory_mb"关键字获取远程主机的内存信息,其实,"ansible_memory_mb"就是一个变量名,换句话说就是,我们可以在playbook中直接引用名为"ansible_memory_mb"的变量,从而获取到远程主机的内存信息,示例如下
  1. ---
  2. - hosts: test70
  3.   remote_user: root
  4.   tasks:
  5.   - name: debug demo
  6.     debug:
  7.       msg: "Remote host memory information: {{ansible_memory_mb}}"
复制代码
上例执行效果如下
4.png
如图所示,我们自定义的信息中包含了远程主机的内存信息,同时被输出了,只是格式上没有手动执行setup模块返回的信息格式易读,手动执行setup模块获取到的内存信息返回如下
  1. test70 | SUCCESS => {
  2.    "ansible_facts": {
  3.        "ansible_memory_mb": {
  4.            "nocache": {
  5.                "free": 1487,
  6.                "used": 336
  7.            },
  8.            "real": {
  9.                "free": 1151,
  10.                "total": 1823,
  11.                "used": 672
  12.            },
  13.            "swap": {
  14.                "cached": 0,
  15.                "free": 1023,
  16.                "total": 1023,
  17.                "used": 0
  18.            }
  19.        }
  20.    },
  21.    "changed": false
  22. }
复制代码
如上述返回信息所示,"ansible_memory_mb"中其实包含了 "nocache"、"real"、 "swap"三个部分的信息,如果我们只想获得"real"部分的信息,在playbook中引用变量时可以使用如下两种语法。
  1. 语法一示例:
  2. debug:
  3.      msg: "Remote host memory information : {{ansible_memory_mb.real}}"
  4. 语法二示例:
  5. debug:
  6.      msg: "Remote host memory information : {{ansible_memory_mb['real']}}"
  7. 上述两种语法前文中已经进行过示例,此处不再赘述。
复制代码
其实,这些远程主机的变量信息不仅仅能够用于输出,我们通常会获取到这些信息以后,对这些信息的值进行判断,判断是否符合我们的要求,然后再执行下一步动作,比如,先获取到远程主机的系统发行版信息,然后判断发行版是centos6还是centos7,如果是centos6,我们就将准备好的A文件拷贝到远程主机中,如果是centos7,我们就将准备好的B文件拷贝到远程主机中,不过由于我们还没有总结条件判断的相关使用方法,所以此处就不进行示例了,这篇文章就先总结到这里,希望能够对你有所帮助。








欢迎光临 黑帽联盟 (https://bbs.cnblackhat.com/) Powered by Discuz! X2.5