cisco.iosxr.iosxr_netconf – Настраивает службу NetConf подсистемы на устройствах Cisco IOS-XR
Примечание
Этот плагин входит в коллекцию cisco.iosxr (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install cisco.iosxr
Для использования в книге задач укажите: cisco.iosxr.iosxr_netconf
Новое в версии 1.0.0: of cisco.iosxr
Обзор
- Этот модуль предоставляет абстракцию, которая позволяет включить и настроить службу 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 целое число | Указывает порт, используемый при построении соединения с удаленным устройством. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации соединения с удаленным устройством. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Указывает тип транспорта для подключения. | |
| 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 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 is True | Возвращает команду, отправленную на удаленное устройство Пример: ssh server netconf port 830 |
Авторы
- 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.10/collections/cisco/iosxr/iosxr_netconf_module.html
