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. Объект типа dict, содержащий сведения о соединении.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: 22	Указывает порт для подключения к удаленному устройству. Значение порта по умолчанию — 22 (для `transport=cli`) или 830 (для `transport=netconf`) устройства.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	username -		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_USERNAME`.
recursive boolean		Варианты: нет ← да	Аргумент `recursive` позволяет выполнять рекурсивную передачу файлов и каталогов.
remote_src boolean		Варианты: нет ← да	Аргумент `remote_src` позволяет загружать файлы (scp get) с удаленного устройства. По умолчанию файлы загружаются (scp put) на удалённое устройство.
src - / обязательно			Аргумент `src` принимает один путь или список путей, которые нужно передать. Аргумент `recursive` должен быть `true`, чтобы передать каталоги.

Примечания

Примечание

Для этого модуля требуется включенная служба netconf на удалённом управляемом устройстве.
Тестировалось на vMX JUNOS версии 17.3R1.10.
Работает только с local подключениями.
Сведения об использовании CLI и netconf см. в руководстве по платформам Junos OS Руководство по платформам Junos OS
Дополнительная информация об использовании Ansible для управления сетевыми устройствами см. в руководстве по сети Ansible Руководство по сети Ansible
Дополнительная информация об использовании 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 boolean	всегда	всегда true

Статус

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

Поддержка Red Hat

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

Авторы

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.7/modules/junos_scp_module.html