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

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

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

Описание

Копирование файла на флэш-память (или bootflash) удалённого сетевого устройства на устройствах NXOS.

Требования

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

paramiko

Параметры

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

Примечания

Примечание

Тестировалось на 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"
    provider: "{{ cli }}"
    connect_ssh_port: "{{ ansible_ssh_port }}"

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

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

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

Статус

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

Поддержка

Дополнительную информацию о поддержке этого модуля 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.5/modules/nxos_file_copy_module.html