ansible fetch 模块
概要
- 该模块的工作方式与copy类似,但相反。
- 它用于从远程机器获取文件并将它们本地存储在按主机名组织的文件树中。
- 如果dest中已经存在的文件与src不同,它们将被覆盖。
- Windows 目标也支持此模块。
参数
parameter | choices/defaults | comments |
---|
dest | | 保存文件的目录。例如,如果dest目录是/backup,则主机host.example.com上名为/etc/profile的src文件将被保存到/backup/host.example.com/etc/profile。主机名以库存名称为准 |
fail_on_missing | yes or no,默认为yes | 当设置为yes时,如果由于任何原因无法读取远程文件,则任务将失败。 |
flat | yes or no,默认no | 允许您覆盖将主机名/path/to/文件追加到目标的默认行为。如果dest以’/'结尾,它将使用源文件的基名,类似于copy模块。如果使用单个主机,或者检索每个主机唯一命名的文件,这可能很有用。如果使用多个具有相同文件名的主机,则每个主机的文件将被覆盖。 |
src | | 要在远程系统上获取的文件。这必须是一个文件,而不是目录。在以后的版本中可能会支持递归抓取。 |
validate_checksum | yes or no,默认yes | 在获取文件之后,验证源和目标校验和是否匹配。 |
笔记
- 当运行 fetch with
become
时,slurp模块也将用于获取文件的内容以确定远程校验和。这有效地使传输大小加倍,并且根据文件大小可能会消耗远程或本地主机上的所有可用内存,从而导致MemoryError
. 因此,建议become
尽可能不运行此模块。 - 在 Ansible 2.5 之前,如果无法读取远程文件,则此模块不会失败,除非
fail_on_missing
已设置。 - 在 Ansible 2.5 或更高版本中,鼓励剧本作者使用
fail_when
或ignore_errors
获得此功能。他们也可以明确设置fail_on_missing
为no
获得非失败行为。 - Windows 目标也支持此模块。
例子
- name: Store file into /tmp/fetched/host.example.com/tmp/somefile
fetch:
src: /tmp/somefile
dest: /tmp/fetched
- name: Specifying a path directly
fetch:
src: /tmp/somefile
dest: /tmp/prefix-{{ inventory_hostname }}
flat: yes
- name: Specifying a destination path
fetch:
src: /tmp/uniquefile
dest: /tmp/special/
flat: yes
- name: Storing in a path relative to the playbook
fetch:
src: /tmp/uniquefile
dest: special/prefix-{{ inventory_hostname }}
flat: yes