iosxr_netconf - Настройка службы NetConf подсистемы на устройствах Cisco IOS-XR

Новая версия 2.5.

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Описание

Этот модуль предоставляет абстракцию, которая позволяет включить и настроить службу netconf, работающую на оборудовании Cisco IOS-XR. Этот модуль позволяет легко включить API Netconf. Netconf предоставляет программируемый интерфейс для работы с ресурсами конфигурации и состояния, как определено в RFC 6242.

Требования

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

ncclient >= 0.5.3 при использовании netconf
lxml >= 4.1.1 при использовании netconf

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
netconf_port		Значение по умолчанию: 830	Этот аргумент определяет порт, на котором служба netconf должна прослушивать подключения SSH. Порт по умолчанию, как определено в RFC 6242, равен 830. Псевдонимы: listens_on
netconf_vrf		Значение по умолчанию: "default"	Имя vrf netconf Псевдонимы: vrf
provider			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию можно найти в Руководстве по сети. Объект словаря, содержащий данные подключения.
	host обязательный		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	port	Значение по умолчанию: 22	Указывает порт, который следует использовать при построении подключения к удаленному устройству.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	timeout	Значение по умолчанию: 10	Указывает тайм-аут в секундах для взаимодействия с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
state		Варианты: present ← absent	Определяет состояние ресурса `iosxr_netconf` на удаленном устройстве. Если аргумент state установлен в present, служба netconf будет настроена. Если аргумент state установлен в absent, служба netconf будет удалена из конфигурации.

Примечания

Примечание

Проверено на Cisco IOS XR Software, версия 6.1.2
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco .

Примеры

- name: enable netconf service on port 830
  iosxr_netconf:
    listens_on: 830
    state: present

- name: disable netconf service
  iosxr_netconf:
    state: absent

Возвращаемые значения

Общие значения, возвращаемые модулями, описаны в этой документации. Ниже приведены поля, уникальные для этого модуля:

Ключ	Возвращаемое значение	Описание
commands строка	при изменении значение равно True	Возвращает команду, отправленную на удаленное устройство Пример: ssh server netconf port 830

Статус

Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется как обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетевым задачам. Дополнительная информация см. в поддержке модулей.

Список других модулей, также поддерживаемых командой Ansible по сетевым задачам, см. в здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье Базы знаний.

Автор

Kedar Kekan (@kedarX)

Подсказка

Если вы заметили какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/iosxr_netconf_module.html