netconf_config - конфигурация устройства netconf
Новая в версии 2.2.
Обзор
- Netconf — это протокол управления сетями, разработанный и стандартизированный IETF. Он документирован в RFC 6241.
- Этот модуль позволяет пользователю отправлять файл конфигурации XML на устройство netconf и определяет, были ли внесены изменения в конфигурацию.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- ncclient
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_agent (добавлено в 2.4) | По умолчанию: да | если true, включает запрос к SSH-агенту (если найден) для ключей если false, отключает запрос к SSH-агенту для ssh-ключей |
| datastore (добавлено в 2.4) | По умолчанию: auto | auto, использует кандидатский и переходит к текущему candidate, редактирует хранилище <candidate/> и затем производит коммит running, редактирует хранилище <running/> напрямую |
| host обязательно | имя хоста или IP-адрес устройства netconf | |
| hostkey_verify | По умолчанию: да | если true, ssh-ключ хоста устройства должен соответствовать ssh-ключу, присутствующему на хосте если false, ssh-ключ хоста устройства не проверяется |
| look_for_keys (добавлено в 2.4) | По умолчанию: да | если true, включает поиск ssh-ключей в стандартных местах (например, ~/.ssh/id_*) если false, отключает поиск ssh-ключей |
| password обязательно | пароль пользователя для аутентификации | |
| port | По умолчанию: 830 | порт netconf |
| save (добавлено в 2.4) | По умолчанию: нет | Аргумент save инструктирует модуль сохранить running-конфигурацию в startup-конфигурацию, если она изменена. |
| src (добавлено в 2.4) | Указывает путь к исходному файлу xml, который содержит конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на контрольном хосте Ansible или относительным путем от корня playbook или роли. Этот аргумент несовместим с xml. | |
| username обязательно | имя пользователя для аутентификации | |
| xml | содержимое XML для отправки на устройство |
Примечания
Примечание
- Этот модуль поддерживает устройства с и без возможностей кандидатской конфигурации и подтвержденного коммита. Он всегда использует более безопасный метод.
- Этот модуль поддерживает использование соединения connection=netconf
Примеры
- name: use lookup filter to provide xml configuration
netconf_config:
xml: "{{ lookup('file', './config.xml') }}"
host: 10.0.0.1
username: admin
password: admin
- name: set ntp server in the device
netconf_config:
host: 10.0.0.1
username: admin
password: admin
xml: |
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<system xmlns="urn:ietf:params:xml:ns:yang:ietf-system">
<ntp>
<enabled>true</enabled>
<server>
<name>ntp1</name>
<udp><address>127.0.0.1</address></udp>
</server>
</ntp>
</system>
</config>
- name: wipe ntp configuration
netconf_config:
host: 10.0.0.1
username: admin
password: admin
xml: |
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<system xmlns="urn:ietf:params:xml:ns:yang:ietf-system">
<ntp>
<enabled>false</enabled>
<server operation="remove">
<name>ntp1</name>
</server>
</ntp>
</system>
</config>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| server_capabilities список | успех | список возможностей сервера Пример: ['urn:ietf:params:netconf:base:1.1', 'urn:ietf:params:netconf:capability:confirmed-commit:1.0', 'urn:ietf:params:netconf:capability:candidate:1.0'] |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- Leandro Lisboa Penz (@lpenz)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/netconf_config_module.html
