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 используется в качестве адреса назначения для протокола передачи. | ||
| 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 будет удалена из конфигурации. | |
Примечания
Примечание
- Тестировалось с программным обеспечением Cisco IOS XR, версия 6.1.2
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco https://www.ansible.com/integrations/networks/cisco.
Примеры
- name: enable netconf service on port 830
iosxr_netconf:
listens_on: 830
state: present
- name: disable netconf service
iosxr_netconf:
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы в этой статье, а следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands строка | при changed is True | Возвращает команду, отправленную удаленному устройству Пример: ssh server netconf port 830 |
Статус
- Гарантируется, что этот модуль будет иметь обратную совместимость. [превью]
- Этот модуль поддерживается командой Ansible Network Команда Ansible Network. [network]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти в этой статье из базы знаний Red Hat https://access.redhat.com/articles/3166901.
Авторы
- 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.7/modules/iosxr_netconf_module.html
