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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Значения возврата
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
ncclient

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
allow_agent (добавлено в 2.4)	Значение по умолчанию: "да"	если истинно, разрешает запросы к SSH-агенту (если найден) для ключей если ложно, отключает запросы к SSH-агенту для ssh-ключей
datastore (добавлено в 2.4)	Значение по умолчанию: "авто"	авто, использует кандидатское и падает к рабочему кандидат, редактирует хранилище <candidate/> и затем подтверждает рабочий, напрямую редактирует хранилище <running/>
host обязательно		имя хоста или IP-адрес устройства netconf
hostkey_verify	Значение по умолчанию: "да"	если истинно, ssh-ключ хоста устройства должен соответствовать ssh-ключу, присутствующему на хосте если ложно, ssh-ключ хоста устройства не проверяется
look_for_keys (добавлено в 2.4)	Значение по умолчанию: "да"	если истинно, ищет ssh-ключи в стандартных расположениях (например, ~/.ssh/id_*) если ложно, отключает поиск ssh-ключей
password обязательно		пароль пользователя для аутентификации
port	Значение по умолчанию: 830	порт netconf
save (добавлено в 2.4)	Значение по умолчанию: "нет"	Аргумент `save` инструктирует модуль сохранять текущую конфигурацию в стартовую конфигурацию, если она была изменена.
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']

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/netconf_config_module.html