Модуль community.network.ce_file_copy — Копирование файла на удалённое устройство cloudengine по SCP на коммутаторах HUAWEI CloudEngine.

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.network.ce_file_copy.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Копирование файла на удалённое устройство cloudengine по SCP на коммутаторах HUAWEI CloudEngine.

Псевдонимы: 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.
Этот модуль также работает с подключениями 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 строка	Информация о результате передачи. Возвращается: всегда Пример: `"The local file has been successfully transferred to the device."`

Авторы

Zhou Zhijin (@QijunPan)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ce_file_copy_module.html