Spec-Zone.ru › Ansible 2.9

junos_scp – Передача файлов на удалённые устройства с Junos

Новая в версии 2.5.

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

Обзор

  • Этот модуль переносит файлы через SCP на удалённые устройства с Junos.

Требования

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

  • junos-eznc
  • ncclient (>=v0.5.2)

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
dest
-
Значение по умолчанию:
"."
Аргумент dest указывает путь для получения файлов.
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli или connection: netconf.
Для получения дополнительной информации обратитесь к руководству по платформам Junos OS Junos OS Platform Options guide.
Объект словаря, содержащий сведения о подключении.
host
строка / обязательно
Указывает имя DNS хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port
целое число
Значение по умолчанию:
22
Указывает порт для подключения к удалённому устройству. Порт по умолчанию — стандартный SSH-порт 22 (для transport=cli) или порт 830 (для transport=netconf) устройства.
ssh_keyfile
путь
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Значение по умолчанию:
10
Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
username
строка
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
recursive
логическое значение
    Варианты:
  • нет ←
  • да
Аргумент recursive включает рекурсивную передачу файлов и каталогов.
remote_src
логическое значение
    Варианты:
  • нет ←
  • да
Аргумент remote_src включает загрузку файлов (scp get) с удалённого устройства. По умолчанию файлы загружаются (scp put) на удалённое устройство.
src
- / обязательно
Аргумент src принимает один путь или список путей для передачи. Аргумент recursive должен быть true, чтобы передать каталоги.

Примечания

Примечание

  • Для работы этого модуля на удалённом управляемом устройстве должна быть включена системная служба netconf.
  • Проверено на vMX JUNOS версии 17.3R1.10.
  • Работает только с подключением local.
  • Подробную информацию об использовании CLI и netconf см. в руководстве по платформам Junos OS Junos OS Platform Options guide
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide Ansible Network Guide
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами Juniper см. на https://www.ansible.com/ansible-juniper.

Примеры

# the required set of connection arguments have been purposely left off
# the examples for brevity
- name: upload local file to home directory on remote device
  junos_scp:
    src: test.tgz

- name: upload local file to tmp directory on remote device
  junos_scp:
    src: test.tgz
    dest: /tmp/

- name: download file from remote device
  junos_scp:
    src: test.tgz
    remote_src: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ Возвращаемое значение Описание
changed
логическое значение
всегда
всегда истина



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается командой Ansible Network Team. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat см. в статье базы знаний Red Hat Red Hat Knowledge Base article.

Авторы

  • Christian Giese (@GIC-de)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ для его улучшения.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/junos_scp_module.html

Spec-Zone.ru

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