iosxr_netconf – Настройка службы NetConf подсистемы NetConf на устройствах Cisco IOS-XR
Новая в версии 2.5.
Описание
- Этот модуль предоставляет абстракцию, которая позволяет включить и настроить службу netconf, работающую на программном обеспечении Cisco IOS-XR. Этот модуль может быть использован для простого включения API Netconf. Netconf предоставляет программный интерфейс для работы с ресурсами конфигурации и состояния, как определено в RFC 6242.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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 используется в качестве целевого адреса для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: 22 | Указывает порт для создания подключения к удалённому устройству. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| state - |
| Указывает состояние ресурса iosxr_netconf на удалённом устройстве. Если параметр state установлен в present, служба netconf будет настроена. Если параметр state установлен в absent, служба netconf будет удалена из конфигурации. | |
Примечания
Примечание
- Этот модуль работает с подключением
network_cli. См. варианты платформы IOS-XR. - Тестировалось с программным обеспечением Cisco IOS XR, версия 6.1.3
- Для получения дополнительной информации об использовании 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 строка | при изменении is True | Возвращает команду, отправленную на удалённое устройство Пример: ssh server netconf порт 830 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
- Этот модуль поддерживается командой Ansible Network. [сеть]
Поддержка Red Hat
Дополнительная информация о поддержке этого модуля Red Hat доступна в этой статье базы знаний 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.9/modules/iosxr_netconf_module.html
