netconf_config - конфигурация устройства netconf

Новое в версии 2.2.

Описание
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Описание

Netconf — это протокол управления сетями, разработанный и стандартизированный IETF. Он документирован в RFC 6241.
Этот модуль позволяет пользователю отправлять файл конфигурации в формате XML на устройство netconf и определяет, были ли изменения в конфигурации.

Требования (к хосту, на котором выполняется модуль)

python >= 2.6
ncclient

Параметры

параметр	обязателен	значение по умолчанию	комментарии
allow_agent (добавлен в 2.4)	нет	True	если true, разрешает запросы к SSH-агенту (если он найден) для ключей если false, запрещает запросы к SSH-агенту для SSH-ключей
datastore (добавлен в 2.4)	нет	auto	auto, использует candidate и по умолчанию fallback к running candidate, редактирует хранилище <candidate/> и затем подтверждает изменения running, редактирует хранилище <running/> напрямую
host	да		имя хоста или IP-адрес устройства netconf
hostkey_verify	нет	True	если true, SSH-ключ хоста устройства должен соответствовать SSH-ключу, присутствующему на хосте если false, SSH-ключ хоста устройства не проверяется
look_for_keys (добавлен в 2.4)	нет	True	если 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 для отправки на устройство

Примеры

- 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']

Примечания

Примечание

Этот модуль поддерживает устройства с возможностями candidate и confirmed-commit, а также без них. Он всегда использует более безопасную функцию.

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Для помощи в разработке модулей, если вы заинтересованы, прочитайте Справочная информация сообщества & Участие, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/netconf_config_module.html