Ansible `copy` 模块

Ansible copy 模块

一、简介

• 功能：copy 模块用于将本地文件或目录复制到远程主机。它可以在复制过程中设置文件或目录的权限、所有者和组等属性。
• 使用场景：常用于分发配置文件、脚本或其他需要在远程主机上使用的文件，确保目标主机上的文件一致性。

二、基本用法

2.1 语法

ansible <pattern> -m copy -a "src=<source_path> dest=<destination_path> [other options]"

• <pattern>：指定要操作的主机或主机组，例如 all、webservers。
• -m copy：指定使用 copy 模块。
• src=<source_path>：指定本地文件或目录的路径。
• dest=<destination_path>：指定远程主机上目标文件或目录的路径。
• 其他选项：如 mode、owner、group 等，用于设置目标文件或目录的属性。

2.2 示例

复制单个文件

ansible all -m copy -a "src=/local/path/file.txt dest=/remote/path/file.txt"

• 解释：将本地主机上的 file.txt 复制到所有远程主机的 /remote/path/ 目录下。如果目标路径下已存在同名文件，将被覆盖。

复制目录及其内容

ansible all -m copy -a "src=/local/path/dir dest=/remote/path/dir"

• 解释：将本地主机上的 dir 目录及其内容复制到所有远程主机的 /remote/path/ 目录下。目录和文件会保持原有结构。

复制并设置文件权限

ansible all -m copy -a "src=/local/path/file.txt dest=/remote/path/file.txt mode=0644"

• 解释：将本地 file.txt 复制到所有远程主机，并设置该文件的权限为 0644。

复制并设置文件所有者和组

ansible all -m copy -a "src=/local/path/file.txt dest=/remote/path/file.txt owner=user1 group=group1"

• 解释：将本地 file.txt 复制到所有远程主机，并将文件所有者设置为 user1，所属组设置为 group1。

三、其他常用选项

3.1 mode

• 功能：设置目标文件或目录的权限。

• 用法：

  ansible all -m copy -a "src=/local/path/file.txt dest=/remote/path/file.txt mode=0755"
  

  • 解释：将 file.txt 复制到远程主机，并设置其权限为 0755。

3.2 owner

• 功能：设置目标文件或目录的所有者。

• 用法：

  ansible all -m copy -a "src=/local/path/file.txt dest=/remote/path/file.txt owner=user1"
  

  • 解释：将 file.txt 复制到远程主机，并将文件所有者设置为 user1。

3.3 group

• 功能：设置目标文件或目录的所属组。

• 用法：

  ansible all -m copy -a "src=/local/path/file.txt dest=/remote/path/file.txt group=group1"
  

  • 解释：将 file.txt 复制到远程主机，并将文件所属组设置为 group1。

3.4 backup

• 功能：如果目标文件已存在，创建一个备份文件。

• 用法：

  ansible all -m copy -a "src=/local/path/file.txt dest=/remote/path/file.txt backup=yes"
  

  • 解释：在 file.txt 文件被覆盖之前，创建一个备份文件。

3.5 force

• 功能：是否强制覆盖目标文件。默认为 yes，即当文件内容不同或 mode、owner、group 等属性不同，目标文件将被覆盖。设置为 no 时，如果文件已经存在且内容相同，则不覆盖。

• 用法：

  ansible all -m copy -a "src=/local/path/file.txt dest=/remote/path/file.txt force=no"
  

  • 解释：如果远程主机上的文件已经存在且内容相同，则不会覆盖。

四、注意事项

• 文件大小和网络性能：在传输大型文件或目录时，注意网络性能和传输时间。如果文件非常大，可以考虑使用其他传输方式（如 rsync 模块）。
• 文件权限和所有权：在复制文件时，确保文件的权限和所有权设置符合目标主机的安全策略和访问要求。
• 符号链接处理：copy 模块不会自动处理符号链接。如果需要复制符号链接而不是链接指向的文件，请明确在源路径中指定。