junipernetworks.junos.junos_netconf – Настраивает службу Junos Netconf

Примечание

Этот плагин входит в сборку junipernetworks.junos (версия 1.3.0).

Для его установки используйте: 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 строка	Варианты: cli netconf ←	Настраивает транспортное соединение, используемое при подключении к удалённому устройству.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
state строка		Варианты: present ← absent	Указывает состояние ресурса `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.
Этот модуль также работает с local подключениями для устаревших книг задач.
Если значение netconf_port не указано в задаче, по умолчанию оно будет включено только на порте 830. Хотя значение netconf_port может быть от 1 до 65535, следует избегать настройки доступа к порту, обычно назначенному для другой службы. Это предотвращает потенциальные конфликты ресурсов.
Подробную информацию о работе с CLI и netconf см. в руководстве по вариантам платформы Junos OS
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
Дополнительную информацию об использовании 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 строка	при changed = True	Возвращает команду, отправленную удалённому устройству Пример: set system services netconf ssh port 830

Авторы

Peter Sprygada (@privateip)

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