ce_file_copy – Копирование файла на удалённое устройство cloudengine по протоколу SCP на коммутаторах HUAWEI CloudEngine
Новая версия 2.4.
Обзор
- Копирование файла на удалённое устройство 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.
- Рекомендуемое подключение -
netconf. - Этот модуль также работает с подключением
localдля устаревших playbooks.
Примеры
- 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"
ce_file_copy:
local_file: /usr/vrpcfg.cfg
remote_file: /vrpcfg.cfg
file_system: 'flash:'
provider: "{{ cli }}"
Возвращаемые значения
Общие возвращаемые значения описаны в документации, ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | всегда | Проверка, были ли внесены изменения на устройстве Пример: True |
| local_file строка | всегда | Путь к локальному файлу. Пример: /usr/work/vrpcfg.zip |
| remote_file строка | всегда | Путь к удалённому файлу. Пример: /vrpcfg.zip |
| transfer_result строка | всегда | Информация о результате передачи. Пример: Локальный файл успешно передан на устройство. |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Zhou Zhijin (@QijunPan)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ce_file_copy_module.html