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

Примечание

Этот модуль входит в коллекцию cisco.iosxr (версия 12.3.1).

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

Для установки используйте: ansible-galaxy collection install cisco.iosxr.

Чтобы использовать её в плейбуке, укажите: cisco.iosxr.iosxr_netconf.

Добавлено в cisco.iosxr 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Примечание

Этому модулю соответствует модуль действий.

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

Параметры

Параметр	Комментарии
netconf_port псевдонимы: listens_on integer	Этот аргумент задаёт порт, на котором служба netconf должна принимать SSH-подключения. Порт по умолчанию, определённый в RFC 6242, — 830. По умолчанию: `830`
netconf_vrf псевдонимы: vrf string	Имя VRF для netconf По умолчанию: `"default"`
state string	Задаёт состояние ресурса `iosxr_netconf` на удалённом устройстве. Если аргумент state имеет значение present, служба netconf будет настроена. Если аргумент state имеет значение absent, служба netconf будет удалена из конфигурации. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Этот модуль работает с подключением network_cli. См. параметры платформы IOS-XR.
Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по сетям Ansible <network_guide>`
Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

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

- name: disable netconf service
  cisco.iosxr.iosxr_netconf:
    state: absent

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

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

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

Авторы

Kedar Kekan (@kedarX)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/iosxr/iosxr_netconf_module.html