Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в плейбуке укажите: community.network.ce_file_copy.

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

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • paramiko

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
file_system
строка
Значение по умолчанию:
"flash:"
Файловая система удалённого устройства. Если опущено, устройства, поддерживающие параметр file_system, будут использовать значения по умолчанию. Файловая система обозначает носитель хранения и может быть установлена следующим образом: 1) flash — корневой каталог флэш-памяти на главном МПУ. 2) slave#flash — корневой каталог флэш-памяти на подчиненном МПУ. Если подчиненный МПУ отсутствует, этот диск недоступен. 3) chassis ID/slot number#flash — корневой каталог флэш-памяти на устройстве в стеке. Например, 1/5#flash указывает на флэш-память с идентификатором корпуса 1 и номером слота 5.
local_file
строка / обязательный
Путь к локальному файлу. Локальный каталог должен существовать. Максимальная длина local_file составляет 4096.
remote_file
строка
Путь к удалённому файлу для копирования. Удаленные каталоги должны существовать. Если опущено, используется имя локального файла. Максимальная длина remote_file составляет 4096.

Примечания

Примечание

  • Функция должна быть включена с помощью функции scp-server.
  • Если файл уже существует, передача не будет производиться.
  • Этот модуль требует, чтобы служба netconf system была включена на удалённом управляемом устройстве.
  • Рекомендуемое подключение — netconf.
  • Этот модуль также работает с подключением local для плейбуков старой версии.

Примеры

- name: File copy test
  hosts: cloudengine
  connection: local
  gather_facts: no
  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
строка
всегда
Информация о результате передачи.

Пример:
Локальный файл успешно передан на устройство.


Авторы

  • Zhou Zhijin (@QijunPan)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API