nxos_file_copy - Копирование файла на удалённый сетевой узел NXOS по SCP.
Новая версия 2.2.
Обзор
- Копирование файла на флеш-память (или bootflash) удалённого сетевого устройства на базе NXOS.
Параметры
| параметр | обязательный | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| auth_pass (добавлен в 2.4.4)
| нет | нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| file_system | нет | Удаленная файловая система устройства. Если опущено, устройства, которые поддерживают параметр file_system, будут использовать свои значения по умолчанию. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| local_file | да | Путь к локальному файлу. Локальный каталог должен существовать. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение применяется к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту используемого транспорта, если не указано в задаче (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передать все аргументы nxos в виде объекта dict. Все ограничения (обязательность, варианты и т.д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| remote_file | нет | Путь к удалённому файлу для копирования. Удалённые каталоги должны существовать. Если опущено, используется имя локального файла. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout (добавлен в 2.3)
| нет | 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль возвращает ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т.д.). | |
| transport | да | cli | Настраивает транспортное подключение для соединения с удалённым устройством. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает транспорт transport на использование SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых сайтах с самозаверяющими сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется. |
Примеры
- nxos_file_copy:
local_file: "./test_file.txt"
remote_file: "test_file.txt"
provider: "{{ cli }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращено | тип | пример |
|---|---|---|---|---|
| local_file | Путь к локальному файлу. | успех | строка | /path/to/local/file |
| remote_file | Путь к удалённому файлу. | успех | строка | /path/to/remote/file |
| transfer_status | Была ли передана информация файла. "Нет передачи" или "Отправлено". | успех | строка | Отправлено |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Функция должна быть включена с помощью функции scp-server.
- Если файл уже существует (соответствие сумм MD5), передача не выполняется.
- Режим проверки покажет, будет ли скопирован файл.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимости.
Информация о техническом обслуживании
Дополнительную информацию о поддержке данного модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Дополнительную информацию по разработке модулей, если вы заинтересованы в этом, см. Информация о сообществе и внесение вклада, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_file_copy_module.html
