junipernetworks.junos.junos_netconf – Настройка службы Junos Netconf
Примечание
Этот плагин является частью коллекции junipernetworks.junos (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install junipernetworks.junos.
Для использования в плейбуке укажите: junipernetworks.junos.junos_netconf.
Новое в версии 1.0.0: junipernetworks.junos
Обзор
- Этот модуль предоставляет абстракцию, которая позволяет включить и настроить службу netconf, работающую на устройствах Junos. Этот модуль может быть использован для простого включения API Netconf. Netconf предоставляет программируемый интерфейс для работы с ресурсами конфигурации и состояния, как определено в RFC 6242. Если параметр
netconf_portне указан в задании, по умолчанию netconf будет включен только на порту 830.
Примечание
У этого модуля есть соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| netconf_port целое число | Значение по умолчанию: 830 | Этот аргумент указывает порт, на котором служба netconf должна слушать подключения SSH. Порт по умолчанию, как определено в RFC 6242, равен 830. Псевдонимы: listens_on | |
| 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 строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| state строка |
| Указывает состояние ресурса junos_netconf на удалённом устройстве. Если аргумент state установлен в present, служба netconf будет настроена. Если аргумент state установлен в absent, служба netconf будет удалена из конфигурации. | |
Примечания
Примечание
- Проверено на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.
- Рекомендуемое подключение —
network_cli. См. руководство Junos OS Platform Options. - Этот модуль также работает с подключениями
localдля устаревших плейбуков. - Если значение
netconf_portне указано в задании, по умолчанию оно будет включено на порту 830. Хотя значениеnetconf_portможет быть от 1 до 65535, следует избегать настройки доступа на порту, обычно используемом для другой службы. Это предотвращает потенциальные конфликты ресурсов. - Сведения об использовании CLI и netconf см. в руководстве Junos OS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Juniper см. в https://www.ansible.com/ansible-juniper.
Примеры
- name: enable netconf service on port 830
junipernetworks.junos.junos_netconf:
listens_on: 830
state: present
- name: disable netconf service
junipernetworks.junos.junos_netconf:
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, а следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands строка | при изменении True | Возвращает команду, отправленную на удалённое устройство Пример: set system services netconf ssh port 830 |
Авторы
- Peter Sprygada (@privateip)
© 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_netconf_module.html