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 Platform Options. Объект dict, содержащий детали подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: 22 | Указывает порт для подключения к удаленному устройству. Значение порта по умолчанию — 22 (для transport=cli) или 830 (для transport=netconf) устройства. | |
| username | Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль вернет ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| recursive bool |
| Аргумент recursive позволяет выполнять рекурсивную передачу файлов и каталогов. | |
| remote_src bool |
| Аргумент remote_src позволяет скачивать файлы (scp get) с удаленного устройства. По умолчанию выполняется загрузка файлов (scp put) на удаленное устройство. | |
| src обязательно | Аргумент src принимает один путь или список путей, которые нужно передать. Аргумент recursive должен быть true для передачи каталогов. | ||
Примечания
Примечание
- Для этого модуля требуется включенная служба netconf на управляемом удаленном устройстве.
- Проверено на версии Junos vMX 17.3R1.10.
- Работает только с подключениями
local. - Сведения об использовании 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
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 bool | всегда | всегда true |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его обслуживает команда Ansible Network. Подробнее см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также обслуживаемых командой Ansible Network, см. в этом документе.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.6/modules/junos_scp_module.html
