Spec-Zone.ru › Ansible

Модуль cisco.nxos.nxos_file_copy — копирование файла на удалённое устройство NXOS.

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.nxos. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.nxos.nxos_file_copy.

Добавлен в cisco.nxos 1.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль поддерживает два разных способа копирования файла во flash (или bootflash) на устройствах NXOS. Файлы можно либо (1) передавать с контроллера Ansible на устройство, либо (2) загружать на устройство с удалённого файлового сервера SCP. Копирование файлов инициируется с устройства NXOS на удалённый сервер SCP. Этот модуль поддерживает только транспорт подключения network_cli или Cli с подключением local.

Примечание

Этому модулю соответствует плагин действий.

Псевдонимы: file_copy

Требования

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

  • paramiko или libssh (требуется, если file_pull имеет значение False)
  • scp (требуется, если file_pull имеет значение False)

Параметры

Параметр

Комментарии

connect_ssh_port

integer

Устарел

Этот параметр устарел и будет удалён в одном из выпусков после 2024-06-01.

Для обратной совместимости этот параметр продолжит переопределять значение ansible_port, пока не будет удалён.

Порт SSH-сервера, используемый для передачи файлов.

Используется только при значении True параметра file_pull.

По умолчанию: 22

file_pull

boolean

Если значение равно False, файл копируется с контроллера Ansible на устройство NXOS.

Если значение равно True, файл копируется с удалённого сервера SCP на устройство NXOS. В этом режиме копирование файла инициируется с устройства NXOS.

Если файл уже присутствует на устройстве, он будет перезаписан, поэтому операция НЕ является идемпотентной.

Варианты:

  • false ← (по умолчанию)
  • true

file_pull_compact

boolean

Если file_pull имеет значение True, этот параметр используется для сжатия файлов образов NXOS. Этот параметр можно использовать только с файлами образов NXOS.

Если file_pull имеет значение False, этот параметр не используется.

Варианты:

  • false ← (по умолчанию)
  • true

file_pull_kstack

boolean

Если file_pull имеет значение True, этот параметр можно использовать для ускорения копирования файлов, если запущенный образ NXOS поддерживает параметр use-kstack.

Если file_pull имеет значение False, этот параметр не используется.

Варианты:

  • false ← (по умолчанию)
  • true

file_pull_protocol

string

Если file_pull имеет значение True, этот параметр позволяет задать протокол передачи файла с удалённого устройства на устройство NXOS.

Если file_pull имеет значение False, этот параметр не используется.

Варианты:

  • "scp" ← (по умолчанию)
  • "sftp"
  • "ftp"
  • "http"
  • "https"
  • "tftp"

file_pull_timeout

integer

Устарел

Этот параметр устарел и будет удалён в одном из выпусков после 2024-06-01.

Для обратной совместимости этот параметр продолжит переопределять значение ansible_command_timeout, пока не будет удалён.

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

Если file_pull имеет значение False, этот параметр не используется.

По умолчанию: 300

file_system

string

Удалённая файловая система на устройстве NXOS. Если параметр file_system не указан, устройства, поддерживающие этот параметр, используют значения по умолчанию.

По умолчанию: "bootflash:"

local_file

path

Если file_pull имеет значение False, это путь к локальному файлу на контроллере Ansible. Локальный каталог должен существовать.

Если file_pull имеет значение True, это имя целевого файла на устройстве NXOS.

local_file_directory

path

Если file_pull имеет значение True, файл копируется с удалённого сервера SCP на устройство NXOS и сохраняется в этом каталоге на устройстве NXOS. Если каталога не существует, он будет создан в file_system. Это необязательный параметр.

Если file_pull имеет значение False, этот параметр не используется.

remote_file

path

Если file_pull имеет значение False, это путь к удалённому файлу на устройстве NXOS. Если параметр не указан, будет использовано имя локального файла. Удалённый каталог должен существовать.

Если file_pull имеет значение True, это полный путь к файлу на удалённом сервере SCP, который нужно скопировать на устройство NXOS.

remote_scp_server

string

Адрес удалённого сервера SCP, если file_pull имеет значение True. Этот параметр обязателен, если file_pull имеет значение True.

Если file_pull имеет значение False, этот параметр не используется.

remote_scp_server_password

string

Пароль удалённого сервера SCP, если file_pull имеет значение True. Этот параметр обязателен, если file_pull имеет значение True.

Если file_pull имеет значение False, этот параметр не используется.

remote_scp_server_user

string

Имя пользователя удалённого сервера SCP, если file_pull имеет значение True. Этот параметр обязателен, если file_pull имеет значение True.

Если file_pull имеет значение False, этот параметр не используется.

vrf

string

VRF, используемая для получения файла. Полезно, если VRF управления не задана.

Этот параметр неприменим к коммутаторам MDS.

По умолчанию: "management"

Примечания

Примечание

  • Проверено на 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
  • Ограниченная поддержка Cisco MDS
  • Для передачи файлов на устройство NXOS (file_pull имеет значение False) необходимо включить функцию scp-server.
  • Для загрузки файлов на устройство NXOS (file_pull имеет значение True) включать функцию scp-server не требуется.
  • При загрузке файлов на устройство NXOS (file_pull имеет значение True) передача не выполняется, если файл уже существует.
  • Режим проверки покажет, будет ли скопирован файл.
  • Сведения об использовании CLI и NX-API см. в :ref:`руководстве по параметрам платформы NXOS <nxos_platform_options>`
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по сетевым устройствам Ansible <network_guide>`
  • Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/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

Указывает, был ли скопирован файл.

Возвращается: success

Пример: true

local_file

string

Путь к локальному файлу.

Возвращается: success

Пример: "/path/to/local/file"

remote_file

string

Путь к удалённому файлу.

Возвращается: success

Пример: "/path/to/remote/file"

remote_scp_server

string

Имя сервера SCP, если file_pull имеет значение True.

Возвращается: success

Пример: "fileserver.example.com"

transfer_status

string

Указывает, был ли передан файл на устройство NXOS.

Возвращается: success

Пример: "Sent"

Авторы

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)
  • Переработан в плагин: (@mikewiebe)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/nxos/nxos_file_copy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API