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		По умолчанию: None	Устаревшее Начиная с Ansible 2.5, мы рекомендуем использовать `connection: network_cli`. Дополнительную информацию см. в Руководстве по сети. Объект словаря, содержащий сведения о подключении.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение - путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout	По умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечет до завершения операции, модуль выдаст ошибку.
	password	По умолчанию: None	Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port	По умолчанию: 22	Указывает порт, используемый при установке подключения к удаленному устройству.
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 str	когда changed равно True	Возвращает команду, отправленную на удаленное устройство Пример: ssh server netconf port 830

Статус

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

Поддержка

Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/iosxr_netconf_module.html