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

Примечание

Этот модуль входит в коллекцию junipernetworks.junos (версия 8.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install junipernetworks.junos. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: junipernetworks.junos.junos_scp.

Добавлена в junipernetworks.junos 1.0.0

УСТЕРЕГЛО
Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

УСТЕРЕГЛО

Удалено в:: главной версии после 2025-01-01
Почему:: Выпущены обновленные модули с большей функциональностью
Альтернатива:: Используйте ansible.netcommon.net_get, ansible.netcommon.net_put вместо этого.

Описание

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

Псевдонимы: scp

Требования

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

junos-eznc
ncclient (>=v0.5.2)

Параметры

Параметр	Комментарии
dest путь	Аргумент `dest` указывает путь для приема файлов. По умолчанию: `"."`
provider словарь	Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` или `connection: netconf`. Дополнительную информацию можно найти в руководстве Junos OS Platform Options. <hr> Объект словаря, содержащий данные подключения.
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` позволяет выполнять рекурсивную передачу файлов и каталогов. Варианты: `false` ← (по умолчанию) `true`
remote_src логическое	Аргумент `remote_src` позволяет загружать файлы (scp get) с удаленного устройства. По умолчанию выполняется загрузка файлов (scp put) на удаленное устройство. Варианты: `false` ← (по умолчанию) `true`
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.
Дополнительную информацию об использовании командной строки и netconf можно найти в руководстве :ref:`Junos OS Platform Options guide <junos_platform_options>`
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами можно найти в руководстве :ref:`Ansible Network Guide <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 Возвращается: всегда

Статус

Этот модуль будет удалён в крупном релизе после 2025-01-01. [устаревший]
Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

Christian Giese (@GIC-de)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/junipernetworks/junos/junos_scp_module.html