cisco.nxos.nxos_file_copy – Копирование файла на удалённое устройство NXOS.
Примечание
Этот плагин является частью коллекции cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos
Для использования в плейбуке укажите: cisco.nxos.nxos_file_copy
Новое в версии 1.0.0: модуля cisco.nxos
Обзор
- Этот модуль поддерживает два различных рабочих процесса для копирования файла на флэш (или bootflash) устройства NXOS. Файлы могут быть (1) отправлены с контроллера Ansible на устройство или (2) извлечены с удалённого сервера SCP на устройство. Копирование файлов инициируется с устройства NXOS на удалённый сервер SCP. Этот модуль поддерживает только использование подключения
network_cliили транспортCliс подключениемlocal
Примечание
Этот модуль имеет соответствующий плагин действия.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- paramiko (необходимо, когда file_pull равен False)
- SCPClient (необходимо, когда file_pull равен False)
- pexpect (необходимо, когда file_pull равен True)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| connect_ssh_port строка | По умолчанию: 22 | Порт SSH-сервера, используемый для передачи файлов. | |
| file_pull логическое значение |
| Когда (False) файл копируется с контроллера Ansible на устройство NXOS. Когда (True) файл копируется с удалённого сервера SCP на устройство NXOS. В этом режиме копирование файла инициируется с устройства NXOS. Если файл уже присутствует на устройстве, он будет перезаписан, поэтому операция НЕ идемпотентна. | |
| file_pull_compact логическое значение |
| Если file_pull равно True, используется для сжатия файлов изображений nxos. Этот параметр может быть использован только с файлами изображений nxos. Если (file_pull равно False), этот параметр не используется. | |
| file_pull_kstack логическое значение |
| Если file_pull равно True, это может использоваться для ускорения копирования файлов, когда текущее изображение nxos поддерживает опцию use-kstack. Если (file_pull равно False), этот параметр не используется. | |
| file_pull_protocol строка |
| Если file_pull равно True, это используется для определения протокола передачи для копирования файла с удаленного сервера на устройство NXOS. Если (file_pull равно False), этот параметр не используется. | |
| file_pull_timeout строка | По умолчанию: 300 | Используйте этот параметр для установки таймаута в секундах при передаче больших файлов или при медленной сети. Если (file_pull равно False), этот параметр не используется. | |
| file_system строка | По умолчанию: "bootflash:" | Удаленная файловая система на устройстве nxos. Если опущено, устройства, поддерживающие параметр file_system, будут использовать свои значения по умолчанию. | |
| local_file строка | Если (file_pull равно False) это путь к локальному файлу на контроллере Ansible. Локальный каталог должен существовать. Если (file_pull равно True) это имя целевого файла на устройстве NXOS. | ||
| local_file_directory строка | Если (file_pull равно True) файл копируется с удалённого сервера SCP на устройство NXOS и записывается в этот каталог на устройстве NXOS. Если каталог не существует, он будет создан в файловой системе. Этот параметр является необязательным. Если (file_pull равно False), этот параметр не используется. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации, пожалуйста, см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль, который нужно использовать, если необходимо войти в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль, который нужно использовать для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт, который нужно использовать при построении подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту для соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может быть медленным для возврата при длительных командах (sh mac, sh bgp и т.д.). | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое значение |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настраивает transport для использования SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверяться. Это должно использоваться только на контролируемых вами сайтах с самозаверяющимися сертификатами. Если аргумент transport не nxapi, это значение игнорируется. | |
| remote_file строка | Если (file_pull равно False) это удалённый путь к файлу на устройстве NXOS. Если опущено, будет использовано имя локального файла. Удалённый каталог должен существовать. Если (file_pull равно True) это полный путь к файлу на удалённом сервере SCP, который должен быть скопирован на устройство NXOS. | ||
| remote_scp_server строка | Адрес удалённого сервера scp, когда file_pull равно True. Это обязательно, если file_pull равно True. Если (file_pull равно False), этот параметр не используется. | ||
| remote_scp_server_password строка | Пароль удалённого сервера scp, когда file_pull равно True. Это обязательно, если file_pull равно True. Если (file_pull равно False), этот параметр не используется. | ||
| remote_scp_server_user строка | Имя пользователя удалённого сервера scp, когда file_pull равно True. Это обязательно, если file_pull равно True. Если (file_pull равно False), этот параметр не используется. | ||
| vrf строка | По умолчанию: "management" | VRF, используемый для извлечения файла. Полезно, когда не определён vrf управления. | |
Примечания
Примечание
- Тестировалось на NXOS 7.0(3)I2(5), 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(3), 6.0(2)A8(8), 7.0(3)F3(4), 7.3(0)D1(1), 8.3(0), 9.2, 9.3
- При отправке файлов (file_pull равно False) на устройство NXOS, функция scp-server должна быть включена.
- При получении файлов (file_pull равно True) на устройство NXOS, функция scp-server не требуется.
- При получении файлов (file_pull равно True) на устройство NXOS, передача не произойдёт, если файл уже присутствует.
- Режим проверки покажет, будет ли скопирован файл.
- Для информации об использовании CLI и NX-API, см. Руководство по параметрам платформы NXOS
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, см. Руководство по сети Ansible
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco, см. страницу интеграции Cisco cisco.
Примеры
# File copy from ansible controller to nxos device
- name: copy from server to device
cisco.nxos.nxos_file_copy:
local_file: ./test_file.txt
remote_file: test_file.txt
# Initiate file copy from the nxos device to transfer file from an SCP server back to the nxos device
- name: initiate file copy from device
cisco.nxos.nxos_file_copy:
file_pull: true
local_file: xyz
local_file_directory: dir1/dir2/dir3
remote_file: /mydir/abc
remote_scp_server: 192.168.0.1
remote_scp_server_user: myUser
remote_scp_server_password: myPassword
vrf: management
# Initiate file copy from the nxos device to transfer file from a ftp server back to the nxos device.
# remote_scp_server_user and remote_scp_server_password are used to login to the FTP server.
- name: initiate file copy from device
cisco.nxos.nxos_file_copy:
file_pull: true
file_pull_protocol: ftp
local_file: xyz
remote_file: /mydir/abc
remote_scp_server: 192.168.0.1
remote_scp_server_user: myUser
remote_scp_server_password: myPassword
vrf: management
Значения возврата
Общие значения возвращаемых данных документированы здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | успех | Указывает, был ли файл скопирован. Пример: True |
| local_file string | успех | Путь к локальному файлу. Пример: /path/to/local/file |
| remote_file string | успех | Путь к удалённому файлу. Пример: /path/to/remote/file |
| remote_scp_server string | успех | Имя сервера scp при file_pull = True. Пример: fileserver.example.com |
| transfer_status string | успех | Была ли передана копия файла на устройство nxos? Пример: Отправлено |
Авторы
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
- Переписано как плагин (@mikewiebe)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_file_copy_module.html
