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. Объект словаря, содержащий данные подключения. | ||
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: 22 | Указывает порт, используемый при построении подключения к удаленному устройству. Значение порта по умолчанию — 22 (стандартный SSH порт для 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. - Подробную информацию об использовании командной строки и 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 логическое значение | всегда | всегда true |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается командой Ansible Network. [сеть]
Поддержка 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.8/modules/junos_scp_module.html
