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

Примечание

Этот плагин является частью коллекции junipernetworks.junos (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install junipernetworks.junos.

Чтобы использовать его в книге задач, укажите: junipernetworks.junos.junos_scp.

Новое в версии 1.0.0: плагина junipernetworks.junos

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

Обзор

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

Примечание

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

Требования

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

junos-eznc
ncclient (>=v0.5.2)

Параметры

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

Примечания

Примечание

Для работы этого модуля на удалённом управляемом устройстве должна быть включена система служб netconf.
Проверено на версии vMX JUNOS 17.3R1.10.
Работает только с подключениями local.
Так как этот модуль использует junos-eznc для установления соединения с устройством Junos, параметры конфигурации netconf необходимо передавать с помощью параметров модуля, например, ssh_config, в отличие от других модулей Junos, использующих тип подключения netconf.
Дополнительную информацию об использовании CLI и netconf см. в руководстве Junos OS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве 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
  junipernetworks.junos.junos_scp:
    src: test.tgz

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

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

- name: ssh config file path for jumphost config
  junipernetworks.junos.junos_scp:
    src: test.tgz
    remote_src: true
    ssh_config: /home/user/customsshconfig

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

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

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

Авторы

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.10/collections/junipernetworks/junos/junos_scp_module.html