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

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет 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 целое число	Этот параметр указывает порт, на котором служба netconf должна прослушивать подключения SSH. Порт по умолчанию, как определено в RFC 6242, равен 830. По умолчанию: `830`
netconf_vrf псевдонимы: vrf строка	Имя VRF для netconf По умолчанию: `"default"`
state строка	Указывает состояние ресурса `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 строка	Возвращает команду, отправленную удаленному устройству Возвращаемое значение: когда changed равен True Пример: `"ssh server netconf port 830"`

Авторы

Kedar Kekan (@kedarX)

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

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