nxos_file_copy — Копирование файла на удалённое устройство NXOS через SCP.

Новая в версии 2.2.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Обзор

Копирование файла на флеш-память (или bootflash) удалённого сетевого устройства на базе NXOS. Этот модуль поддерживает только использование подключения network_cli или Cli транспорт с подключением local.

Требования

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

paramiko

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
connect_ssh_port (добавлен в 2.5)		Значение по умолчанию: 22	Порт SSH для подключения к серверу во время передачи файла
file_system			Удаленная файловая система устройства. Если опущено, устройства, поддерживающие параметр file_system, будут использовать свои значения по умолчанию.
local_file обязательно			Путь к локальному файлу. Локальный каталог должен существовать.
provider			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	port	Значение по умолчанию: "0 (использовать общий порт)"	Указывает порт для использования при построении подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию установлено на соответствующий общий порт транспорта, если оно не указано в задаче. (cli=22, http=80, https=443).
	username		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	authorize bool (добавлен в 2.5.3)	Варианты: нет ← да	Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	auth_pass (добавлен в 2.5.3)	Значение по умолчанию: "none"	Указывает пароль, если необходимо перейти в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	timeout (добавлен в 2.3)	Значение по умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. NX-API может быть медленным при возврате по длительным командам (sh mac, sh bgp и т. д.).
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	Значение по умолчанию: "cli"	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_ssl bool	Варианты: нет ← да	Настраивает transport для использования SSL, если значение равно true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	validate_certs bool	Варианты: нет да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
	use_proxy bool (добавлен в 2.5)	Варианты: нет да ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
remote_file			Путь к удалённому файлу для копирования. Удалённые каталоги должны существовать. Если опущено, будет использовано имя локального файла.

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) на VIRL
Функция должна быть включена с помощью функции scp-server.
Если файл уже существует (совпадают контрольные суммы md5), передача не будет производиться.
Режим проверки покажет, будет ли скопирован файл.
Справочную информацию по использованию CLI и NX-API см. в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- nxos_file_copy:
    local_file: "./test_file.txt"
    remote_file: "test_file.txt"

Возвращаемые значения

Общие возвращаемые значения описаны в документации, следующие поля уникальны для этого модуля:

Ключ	Возвращённое значение	Описание
local_file строка	успех	Путь к локальному файлу. Пример: /path/to/local/file
remote_file строка	успех	Путь к удалённому файлу. Пример: /path/to/remote/file
transfer_status строка	успех	Была ли передан файл. «Нет передачи» или «Отправлено». Пример: Отправлено

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что его поддерживает команда Ansible Network Team. См. техническое обслуживание и поддержку модулей для получения дополнительной информации.

Список других модулей, которые также поддерживаются командой Ansible Network Team, см. в документации.

Поддержка

Для получения дополнительной информации о поддержке этого модуля Red Hat, пожалуйста, обратитесь к этой статье базы знаний.

Автор

Jason Edelman (@jedelman8)
Gabriele Gerbino (@GGabriele)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/nxos_file_copy_module.html