Ansible playbook 用于验证目录并在非空时检索服务器主机名或IP。

huangapple
go评论103阅读模式
英文:

Ansible playbook to verify directory and retrieve server hostname or IP if not empty

问题

我想使用Ansible检查一个目录是否为空。
如果目录不为空，我想要获取服务器的主机名或IP地址。
有人可以帮助我吗？
谢谢！

我尝试进行了一个测试。

  1. - hosts: all
  2.   tasks:
  3.   - find :
  4.       paths: /tmp/foo
  5.       file_type: all
  6.       hidden: true
  7.     register: out
  9.   - fail :
  10.       msg: /tmp/foo目录不为空
  11.     when: out.matched != 0
英文:

I want to check a directory with ansible if it's not empty.
I want to have the server hostname or IP address if the directory is not empty.
Can anyone help me?
Thanks!

I tried to make a test.

  1. - hosts: all
  2.   tasks:
  3.   - find :
  4.       paths: /tmp/foo
  5.       file_type: all
  6.       hidden: true
  7.     register: out
  9.   - fail :
  10.       msg: the /tmp/foo directory is not empty
  11.     when: out.matched != 0

答案1

得分: 1

"Check a directory and list servers if empty."

答: 有两种非常有用的模式，你应该逐步了解并理解细节。

例如，给定两个远程主机，第二个主机上的目录是空的

  1. shell> ssh admin@test_11 find /tmp/test_dir
  2. /tmp/test_dir
  3. /tmp/test_dir/bar
  4. /tmp/test_dir/foo
  1. shell> ssh admin@test_13 find /tmp/test_dir
  2. /tmp/test_dir

查找文件

  1.     - find:
  2.         paths: /tmp/test_dir
  3.         file_type: any
  4.         hidden: true
  5.       register: out
  1. 创建一个事实的字典
  1.   report: "{{ dict(ansible_play_hosts|
  2.                    zip(ansible_play_hosts|
  3.                        map('extract', hostvars, ['out', 'matched']))) }}"

得到

  1.   report:
  2.     test_11: 2
  3.     test_13: 0
  1. 从字典中选择/拒绝属性，并获取满足条件的属性的名称
  1.   empty: "{{ report|dict2items|
  2.              rejectattr('value')|
  3.              map(attribute='key') }}"

得到你想要的结果

  1.   empty:
  2.     - test_13

完整的用于测试的示例playbook

  1. - hosts: all
  3.   vars:
  5.     report: "{{ dict(ansible_play_hosts|
  6.                      zip(ansible_play_hosts|
  7.                          map('extract', hostvars, ['out', 'matched']))) }}"
  8.     empty: "{{ report|dict2items|
  9.                rejectattr('value')|
  10.                map(attribute='key') }}"
  12.   tasks:
  14.     - find:
  15.         paths: /tmp/test_dir
  16.         file_type: any
  17.         hidden: true
  18.       register: out
  20.     - debug:
  21.         var: report
  22.       run_once: true
  24.     - debug:
  25.         var: empty
  26.       run_once: true

英文:

Q: "Check a directory and list servers if empty."

A: There are two very useful patterns you should go step by step through and understand the details.

For example, given two remote hosts, the directory is empty on the second one

  1. shell> ssh admin@test_11 find /tmp/test_dir
  2. /tmp/test_dir
  3. /tmp/test_dir/bar
  4. /tmp/test_dir/foo
  1. shell> ssh admin@test_13 find /tmp/test_dir
  2. /tmp/test_dir

Find the files

  1.     - find:
  2.         paths: /tmp/test_dir
  3.         file_type: any
  4.         hidden: true
  5.       register: out
  1. Crete a dictionary of the facts
  1.   report: "{{ dict(ansible_play_hosts|
  2.                    zip(ansible_play_hosts|
  3.                        map('extract', hostvars, ['out', 'matched']))) }}"

gives

  1.   report:
  2.     test_11: 2
  3.     test_13: 0
  1. Select/reject attributes from a dictionary and get the names of the attributes that match the condition
  1.   empty: "{{ report|dict2items|
  2.              rejectattr('value')|
  3.              map(attribute='key') }}"

gives what you want

  1.   empty:
  2.     - test_13

<hr>

<sup>

Example of a complete playbook for testing

  1. - hosts: all
  3.   vars:
  5.     report: &quot;{{ dict(ansible_play_hosts|
  6.                      zip(ansible_play_hosts|
  7.                          map(&#39;extract&#39;, hostvars, [&#39;out&#39;, &#39;matched&#39;]))) }}&quot;
  8.     empty: &quot;{{ report|dict2items|
  9.                rejectattr(&#39;value&#39;)|
  10.                map(attribute=&#39;key&#39;) }}&quot;
  12.   tasks:
  14.     - find:
  15.         paths: /tmp/test_dir
  16.         file_type: any
  17.         hidden: true
  18.       register: out
  20.     - debug:
  21.         var: report
  22.       run_once: true
  24.     - debug:
  25.         var: empty
  26.       run_once: true

</sup>

答案2

得分: 0

> 我想用Ansible检查一个目录是否为空。

既然未定义“空”是什么意思，以及是否可能存在零字节文件，我理解你的问题是你对文件夹大小感兴趣。

根据在条件中使用文件夹大小的内容，stat 模块返回的 size 属性 不会 告诉你文件夹内容的大小！它只报告目录条目的大小，这可能取决于诸如目录中包含的文件数量等多种因素。

如果你想计算目录中包含的数据量，你可以进一步参考这里的回答或Ansible：需要查找文件夹/目录或文件的通用解决方案。

由于这需要使用 command 或 shell，这在一般情况下不被推荐，可能可以将任务转换为自定义模块。为此，创建一个用 Bash 或 Shell 编写的自定义模块似乎是最好的方法。

以下是一个概念/示例模块，它接受一个字符串参数（path），并测试它是目录还是文件。然后提供目录及其所有文件（包括子目录）的大小，或仅文件大小作为结果集。

概念/示例模块 size.sh

  1. #!/bin/sh
  3. exec 3&gt;&amp;1 4&gt;&amp;2 &gt; /dev/null 2&gt;&amp;1
  5. # 创建函数
  7. function return_json() {
  9.     exec 1&gt;&amp;3 2&gt;&amp;4
  11.     jq --null-input --monochrome-output \
  12.         --arg changed &quot;$changed&quot; \
  13.         --arg rc &quot;$rc&quot; \
  14.         --arg stdout &quot;$stdout&quot; \
  15.         --arg stderr &quot;$stderr&quot; \
  16.         --arg directory &quot;$directory&quot; \
  17.         --arg file &quot;$file&quot; \
  18.         --arg msg &quot;$msg&quot; \
  19.        &#39;$ARGS.named&#39;
  21.     exec 3&gt;&amp;1 4&gt;&amp;2 &gt; /dev/null 2&gt;&amp;1
  23. }
  25. # 模块辅助函数
  27. function dirsize() {
  29.     du -sh &quot;$path&quot; | sort -h
  31. }
  33. function filesize() {
  35.     du -sh &quot;$path&quot;
  37. }
  39. # 模块主要逻辑
  41. function module_logic() {
  43.     if [ -f &quot;$path&quot; ]; then
  44.         filesize $path
  45.         file=&quot;true&quot;
  46.     elif [ -d &quot;$path&quot; ]; then
  47.         dirsize $path
  48.         directory=&quot;true&quot;
  49.     else
  50.         stderr=&quot;无法访问：文件或目录不存在或权限被拒绝。&quot;
  51.         rc=1
  52.     fi
  54. }
  56. # 设置默认值
  58. changed=&quot;false&quot;
  59. rc=0
  60. stdout=&quot;&quot;
  61. stderr=&quot;&quot;
  62. directory=&quot;false&quot;
  63. file=&quot;false&quot;
  64. msg=&quot;&quot;
  66. source &quot;$1&quot;
  68. # 检查先决条件
  70. if ! which jq &amp;&gt;/dev/null; then
  71.     exec 1&gt;&amp;3 2&gt;&amp;4
  72.     printf &quot;{ \&quot;changed\&quot;: \&quot;$changed\&quot;,
  73.            \&quot;rc\&quot;: \&quot;1\&quot; ,
  74.            \&quot;stdout\&quot;: \&quot;\&quot;,
  75.            \&quot;stderr\&quot;: \&quot;找不到命令：此模块需要在目标主机上安装 'jq'。正在退出... \&quot;,
  76.            \&quot;directory\&quot;: \&quot;false\&quot; ,
  77.            \&quot;file\&quot;: \&quot;false\&quot;,
  78.            \&quot;msg\&quot;: \&quot;\&quot;}&quot;
  79.     exit 127
  80. fi
  82. if ! grep -q &quot;Red Hat Enterprise Linux&quot; /etc/redhat-release; then
  83.     stderr=&quot;不支持此操作：未找到 Red Hat Enterprise Linux。正在退出...&quot;
  84.     rc=95
  86.     return_json
  88.     exit $rc
  90. fi
  92. # 验证参数键和值
  94. if [ -z &quot;$path&quot; ]; then
  95.     stderr=&quot;无效参数：未提供参数路径。正在退出...&quot;
  96.     rc=22
  98.     return_json
  100.     exit $rc
  101. fi
  103. if [[ $path == *[&#39;!:*&#39;]* ]]; then
  104.     stderr=&quot;无效参数：值路径包含无效字符。正在退出...&quot;
  105.     rc=22
  107.     return_json
  109.     exit $rc
  110. fi
  112. if [ ${#path} -ge 127 ]; then
  113.     stderr=&quot;参数太长：值路径字符太多。正在退出...&quot;
  114.     rc=7
  116.     return_json
  118.     exit $rc
  119. fi
  121. # 主要
  123. module_logic $path
  125. changed=&quot;false&quot;
  126. msg=$(module_logic $path | sed &#39;s/\t/ /g&#39;)
  128. return_json
  130. exit $rc

测试Playbook size.yml

  1. ---
  2. - hosts: test
  3.   become: false
  4.   gather_facts: false
  6.   tasks:
  8.   - name: 获取路径后面的大小
  9.     size:
  10.       path: /root/anaconda-ks.cfg
  11.     register: result
  12.     ignore_errors: true
  14.   - name: 获取路径后面的大小
  15.     size:
  16.       path: &#39;&#39;
  17.     register: result
  18.     ignore_errors: true
  20.   - name: 获取路径后面的大小
  21.     size:
  22.     register: result
  23.     ignore_errors: true
  25.   - name: 获取路径后面的大小
  26.     size:
  27.       path: &quot;/home/{{ ansible_user }}/*&quot;
  28.     register: result
  29.     ignore_errors: true
  31.   - name: 获取路径后面的大小
  32.     size:
  33.       path: &quot;/home/{{ ansible_user }}/1111111111/2222222222/3333333333/4444444444/5555555555/6666666666/
  35. <details>
  36. <summary>英文:</summary>
  38. &gt; _I want to check a directory with Ansible if it&#39;s not empty._
  40. Since it is not defined what empty means and if there could be [zero byte files](https://stackoverflow.com/a/4955006/6771046), I understand your question that you are interested in the folder size.
  42. According [Use folder size in Conditional](https://stackoverflow.com/a/59910613/6771046)
  44. &gt; _The size attribute returned by the stat module for a folder does **not** tell you the size of the folder&#39;s contents! It only reports the size of the directory entry, which may depend on a number of factors such as the number of files contained in the directory._
  46. If you&#39;re looking to calculate the amount of data contained in a folder, you may [proceed further with the answer there](https://stackoverflow.com/a/59910613/6771046) or [Ansible: Need generic solution to find size of folder/directory or file](https://stackoverflow.com/a/73687567/6771046).
  48. Since that require to use `command` or `shell` which is not generally recommended for all cases, it might be possible to transfer the task into a Custom Module. To do so, creating a Custom Module written in Bash or Shell seems to be the best approach.
  50. The following concept / example module takes a string parameter (`path`) and test if it is a directory or file. After it is providing the size of the directory with all files and including sub directories or the file size only as results set.
  52. **Concept / Example Module** `size.sh`
  54. ```sh
  55. #!/bin/sh
  57. exec 3&gt;&amp;1 4&gt;&amp;2 &gt; /dev/null 2&gt;&amp;1
  59. # Create functions
  61. function return_json() {
  63.     exec 1&gt;&amp;3 2&gt;&amp;4
  65.     jq --null-input --monochrome-output \
  66.         --arg changed &quot;$changed&quot; \
  67.         --arg rc &quot;$rc&quot; \
  68.         --arg stdout &quot;$stdout&quot; \
  69.         --arg stderr &quot;$stderr&quot; \
  70.         --arg directory &quot;$directory&quot; \
  71.         --arg file &quot;$file&quot; \
  72.         --arg msg &quot;$msg&quot; \
  73.        &#39;$ARGS.named&#39;
  75.     exec 3&gt;&amp;1 4&gt;&amp;2 &gt; /dev/null 2&gt;&amp;1
  77. }
  79. # Module helper functions
  81. function dirsize() {
  83.     du -sh &quot;$path&quot; | sort -h
  85. }
  87. function filesize() {
  89.     du -sh &quot;$path&quot;
  91. }
  93. # Module main logic
  95. function module_logic() {
  97.     if [ -f &quot;$path&quot; ]; then
  98.         filesize $path
  99.         file=&quot;true&quot;
  100.     elif [ -d &quot;$path&quot; ]; then
  101.         dirsize $path
  102.         directory=&quot;true&quot;
  103.     else
  104.         stderr=&quot;Cannot access: No such file or directory or Permission denied.&quot;
  105.         rc=1
  106.     fi
  108. }
  110. # Set default values
  112. changed=&quot;false&quot;
  113. rc=0
  114. stdout=&quot;&quot;
  115. stderr=&quot;&quot;
  116. directory=&quot;false&quot;
  117. file=&quot;false&quot;
  118. msg=&quot;&quot;
  120. source &quot;$1&quot;
  122. # Check prerequisites
  124. if ! which jq &amp;&gt;/dev/null; then
  125.     exec 1&gt;&amp;3 2&gt;&amp;4
  126.     printf &quot;{ \&quot;changed\&quot;: \&quot;$changed\&quot;,
  127.            \&quot;rc\&quot;: \&quot;1\&quot; ,
  128.            \&quot;stdout\&quot;: \&quot;\&quot;,
  129.            \&quot;stderr\&quot;: \&quot;Command not found: This module require &#39;jq&#39; installed on the target host. Exiting ...\&quot;,
  130.            \&quot;directory\&quot;: \&quot;false\&quot; ,
  131.            \&quot;file\&quot;: \&quot;false\&quot;,
  132.            \&quot;msg\&quot;: \&quot;\&quot;}&quot;
  133.     exit 127
  134. fi
  136. if ! grep -q &quot;Red Hat Enterprise Linux&quot; /etc/redhat-release; then
  137.     stderr=&quot;Operation not supported: Red Hat Enterprise Linux not found. Exiting ...&quot;
  138.     rc=95
  140.     return_json
  142.     exit $rc
  144. fi
  146. # Validate parameter key and value
  148. if [ -z &quot;$path&quot; ]; then
  149.     stderr=&quot;Invalid argument: Parameter path is not provided. Exiting ...&quot;
  150.     rc=22
  152.     return_json
  154.     exit $rc
  155. fi
  157. if [[ $path == *[&#39;!:*&#39;]* ]]; then
  158.     stderr=&quot;Invalid argument: Value path contains invalid characters. Exiting ...&quot;
  159.     rc=22
  161.     return_json
  163.     exit $rc
  164. fi
  166. if [ ${#path} -ge 127 ]; then
  167.     stderr=&quot;Argument too long: Value path has too many characters. Exiting ...&quot;
  168.     rc=7
  170.     return_json
  172.     exit $rc
  173. fi
  175. # Main
  177. module_logic $path
  179. changed=&quot;false&quot;
  180. msg=$(module_logic $path | sed &#39;s/\t/ /g&#39;)
  182. return_json
  184. exit $rc

Test Playbook size.yml

  1. ---
  2. - hosts: test
  3.   become: false
  4.   gather_facts: false
  6.   tasks:
  8.   - name: Get size behind path
  9.     size:
  10.       path: /root/anaconda-ks.cfg
  11.     register: result
  12.     ignore_errors: true
  14.   - name: Get size behind path
  15.     size:
  16.       path: &#39;&#39;
  17.     register: result
  18.     ignore_errors: true
  20.   - name: Get size behind path
  21.     size:
  22.     register: result
  23.     ignore_errors: true
  25.   - name: Get size behind path
  26.     size:
  27.       path: &quot;/home/{{ ansible_user }}/*&quot;
  28.     register: result
  29.     ignore_errors: true
  31.   - name: Get size behind path
  32.     size:
  33.       path: &quot;/home/{{ ansible_user }}/1111111111/2222222222/3333333333/4444444444/5555555555/6666666666/7777777777/8888888888/9999999999/0000000000/aaaaaaaaaa/bbbbbbbbbb/cccccccccc/&quot;
  34.     register: result
  35.     ignore_errors: true
  37.   - name: Get size behind path
  38.     size:
  39.       path: /home/{{ ansible_user }}
  40.     register: result
  42.   - name: Show result
  43.     debug:
  44.       var: result

Result ansible-playbook --user ${ANSIBLE_USER} size.yml

  1. TASK [Get size behind path] **********************************************
  2. fatal: [test.example.com]: FAILED! =&gt; changed=false
  3.   msg: &#39;&#39;
  4.   rc: &#39;1&#39;
  5.   stderr: &#39;Cannot access: No such file or directory or Permission denied.&#39;
  6.   stderr_lines: &lt;omitted&gt;
  7.   stdout: &#39;&#39;
  8.   stdout_lines: &lt;omitted&gt;
  9. ...ignoring
  11. TASK [Get size behind path] **********************************************
  12. fatal: [test.example.com]: FAILED! =&gt; changed=false
  13.   msg: &#39;&#39;
  14.   rc: &#39;1&#39;
  15.   stderr: Parameter path is not provided. Exiting ...
  16.   stderr_lines: &lt;omitted&gt;
  17.   stdout: &#39;&#39;
  18.   stdout_lines: &lt;omitted&gt;
  19. ...ignoring
  21. TASK [Get size behind path] **********************************************
  22. fatal: [test.example.com]: FAILED! =&gt; changed=false
  23.   directory: &#39;false&#39;
  24.   file: &#39;false&#39;
  25.   msg: &#39;&#39;
  26.   rc: &#39;22&#39;
  27.   stderr: &#39;Invalid argument: Value path contains invalid characters. Exiting ...&#39;
  28.   stderr_lines: &lt;omitted&gt;
  29.   stdout: &#39;&#39;
  30.   stdout_lines: &lt;omitted&gt;
  31. ...ignoring
  33. TASK [Get size behind path] **********************************************
  34. fatal: [test.example.com]: FAILED! =&gt; changed=false
  35.   msg: &#39;&#39;
  36.   rc: &#39;7&#39;
  37.   stderr: Argument &#39;path&#39; too long. Exiting ...
  38.   stderr_lines: &lt;omitted&gt;
  39.   stdout: &#39;&#39;
  40.   stdout_lines: &lt;omitted&gt;
  41. ...ignoring
  43. TASK [Get size behind path] **********************************************
  44. changed: [test.example.com]
  46. TASK [Show result] *******************************************************
  47. ok: [test.example.com] =&gt;
  48.   result:
  49.     changed: &#39;false&#39;
  50.     failed: false
  51.     msg: 722M /home/user
  52.     rc: &#39;0&#39;
  53.     stderr: &#39;&#39;
  54.     stderr_lines: []
  55.     stdout: &#39;&#39;
  56.     stdout_lines: []

Thanks to

For script and module

For general Linux and Shell

huangapple
  • 本文由 发表于 2023年6月1日 16:05:14
  • 转载请务必保留本文链接：https://go.coder-hub.com/76379857.html
  • ansible
  • directory
  • hostname
  • linux
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定