community.network.ce_file_copy 模块 – 通过华为云引擎交换机上的 SCP 将文件复制到远程云引擎设备。

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.network。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：community.network.ce_file_copy。

注意

community.network 集合已被弃用，并将从 Ansible 12 中删除。有关更多信息，请参阅 讨论主题。

已弃用

在以下版本中移除：

6.0.0 版

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

概要

• 通过华为云引擎交换机上的 SCP 将文件复制到远程云引擎设备。

别名：network.cloudengine.ce_file_copy

要求

执行此模块的主机需要以下要求。

• paramiko

参数

参数	注释
file_system 字符串	设备的远程文件系统。如果省略，支持 *file_system* 参数的设备将使用其默认值。文件系统指示存储介质，可以设置为如下：1）flash 是主 MPU 上闪存的根目录。2）slave#flash 是从 MPU 上闪存的根目录。如果不存在从 MPU，则此驱动器不可用。3）chassis ID/slot number#flash 是堆叠中设备上闪存的根目录。例如，1/5#flash 指的是机箱 ID 为 1 且槽位号为 5 的闪存。 默认值： "flash:"
local_file 字符串 / 必需	本地文件的路径。本地目录必须存在。*local_file* 的最大长度为 4096。
remote_file 字符串	复制的远程文件路径。远程目录必须存在。如果省略，将使用本地文件的名称。*remote_file* 的最大长度为 4096。

备注

注意

• 必须使用 scp-server 功能启用此功能。

• 如果文件已存在，则不会进行传输。

• 此模块要求在被管理的远程设备上启用 netconf 系统服务。

• 推荐的连接是 netconf。

• 此模块也适用于旧版 playbook 的 local 连接。

示例

- name: File copy test
  hosts: cloudengine
  connection: local
  gather_facts: false
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: "Copy a local file to remote device"
    community.network.ce_file_copy:
      local_file: /usr/vrpcfg.cfg
      remote_file: /vrpcfg.cfg
      file_system: 'flash:'
      provider: "{{ cli }}"

返回值

公共返回值已记录在 此处，以下是此模块特有的字段

键	描述
changed 布尔值	检查设备上是否进行了更改 返回： 始终 示例： true
local_file 字符串	本地文件的路径。 返回： 始终 示例： "/usr/work/vrpcfg.zip"
remote_file 字符串	远程文件的路径。 返回： 始终 示例： "/vrpcfg.zip"
transfer_result 字符串	有关传输结果的信息。 返回： 始终 示例： "本地文件已成功传输到设备。"

状态

• 此模块将在6.0.0版本中移除。[已弃用]

• 更多信息请参见 已弃用。

作者

• 周志金 (@QijunPan)

资源链接

• 问题追踪器
• 代码仓库