Модуль ansible.netcommon.net_get – копирование файла с сетевого устройства на контроллер Ansible

Примечание

Этот модуль входит в коллекцию ansible.netcommon (версия 8.5.3).

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

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

Чтобы использовать модуль в плейбуке, укажите: ansible.netcommon.net_get.

Добавлено в ansible.netcommon 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры

Краткое описание

Этот модуль позволяет копировать файлы с сетевого устройства на контроллер Ansible.

Примечание

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

Требования

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

scp, если используется протокол scp с paramiko

Параметры

Параметр	Комментарии
dest строка	Задает файл назначения. Путь к файлу назначения может быть полным путем на управляющем узле Ansible или относительным путем от корневого каталога плейбука или роли. По умолчанию: `["Same filename as specified in I(src). The path will be playbook root or role root directory if playbook is part of a role."]`
protocol строка	Протокол, используемый для передачи файла. Варианты: `"scp"` ← (по умолчанию) `"sftp"`
src строка / обязательный	Задает исходный файл. Путь к исходному файлу может быть полным путем на сетевом устройстве или относительным путем, поддерживаемым целевым сетевым устройством.

Примечания

Примечание

Для работы scp на некоторых устройствах необходимо включить определенные параметры. Перед использованием этого модуля настройте их, например для ios — ip scp server enable.
Для выполнения scp на сетевом устройстве пользователю должны быть заранее предоставлены соответствующие привилегии; например, для ios по умолчанию для разрешения scp требуются привилегии пользователя уровня 15.
Файл назначения по умолчанию для исходного файла.
Этот модуль поддерживается на ansible_network_os сетевых платформах. Подробности см. в разделе :ref:`Параметры сетевых платформ <platform_options>`.

Примеры

- name: copy file from the network device to Ansible controller
  ansible.netcommon.net_get:
    src: running_cfg_ios1.txt

- name: copy file from ios to common location at /tmp
  ansible.netcommon.net_get:
    src: running_cfg_sw1.txt
    dest: /tmp/ios1.txt

Авторы

Deepak Agrawal (@dagrawal)

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

© 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/ansible/netcommon/net_get_module.html