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

Примечание

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

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

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

Для использования в книге задач укажите: cisco.nxos.nxos_file_copy.

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

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

Описание

Этот модуль поддерживает два разных подхода к копированию файла в флеш-память (или 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 до его удаления. <hr> Порт SSH-сервера, используемый для передачи файлов. Используется только когда file_pull равен `True`. Значение по умолчанию: `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 до его удаления. <hr> Используйте этот параметр для установки времени ожидания в секундах при передаче больших файлов или при медленной работе сети. Когда (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_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
При отправке файлов (file_pull имеет значение False) на устройство NXOS, функция scp-server должна быть включена.
При извлечении файлов (file_pull имеет значение True) на устройство NXOS, функция scp-server не требуется.
При извлечении файлов (file_pull имеет значение True) на устройство NXOS, передача не будет выполнена, если файл уже существует.
Режим проверки сообщит вам, будет ли файл скопирован.
Для получения информации об использовании 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	Указывает, был ли скопирован файл. Возвращается: успех Пример: `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. Возвращается: успех Пример: `"Sent"`

Авторы

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

Ссылки на сборку

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