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

Примечание

Этот модуль является частью коллекции ansible.netcommon (версия 6.1.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, если используется protocol=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 - по умолчанию необходимы права пользователя 15 для разрешения scp.
По умолчанию место назначения исходного файла.
Этот модуль поддерживается на сетевых платформах 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/netcommon/net_get_module.html