ansible.netcommon.restconf_config – Обрабатывает создание, обновление, чтение и удаление данных конфигурации на устройствах с поддержкой RESTCONF.

Примечание

Этот плагин является частью коллекции ansible.netcommon (версия 1.5.0).

Для его установки используйте: ansible-galaxy collection install ansible.netcommon.

Для использования в книге задач укажите: ansible.netcommon.restconf_config.

Новое в версии 1.0.0: of ansible.netcommon

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

RESTCONF — это стандартный механизм, позволяющий веб-приложениям настраивать и управлять данными. RESTCONF — это стандарт IETF и документирован в RFC 8040.
Этот модуль позволяет пользователю настраивать данные на устройствах с поддержкой RESTCONF.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
content строка		Данные конфигурации в формате, указанном в опции `format`. Требуется, если опция `method` не равна delete.
format строка	Варианты: json ← xml	Формат конфигурации, задаваемый значением `content`. Допустимые значения — xml и json. Указанный формат конфигурации должен поддерживаться удалённым сервером RESTCONF.
method строка	Варианты: post ← put patch delete	Метод RESTCONF для управления изменениями конфигурации на устройстве. Значение post используется для создания ресурса данных или вызова ресурса операции, put используется для замены целевого ресурса данных, patch используется для изменения целевого ресурса, а delete — для удаления целевого ресурса.
path строка / обязательно		URI, используемый для выполнения API-запросов.

Примечания

Примечание

Для этого модуля требуется включенная служба RESTCONF на удалённом управляемом устройстве.
Этот модуль поддерживается со значением ansible_connection равным ansible.netcommon.httpapi и значением ansible_network_os равным ansible.netcommon.restconf.
Этот модуль протестирован на Cisco IOSXE версии 16.12.02.

Примеры

- name: create l3vpn services
  ansible.netcommon.restconf_config:
    path: /config/ietf-l3vpn-svc:l3vpn-svc/vpn-services
    content: |
      {
        "vpn-service":[
                        {
                          "vpn-id": "red_vpn2",
                          "customer-name": "blue",
                          "vpn-service-topology": "ietf-l3vpn-svc:any-to-any"
                        },
                        {
                          "vpn-id": "blue_vpn1",
                          "customer-name": "red",
                          "vpn-service-topology": "ietf-l3vpn-svc:any-to-any"
                        }
                      ]
       }

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
candidate словарь	Когда метод не равен delete	Конфигурация, отправленная на устройство. Пример: { "vpn-service": [ { "customer-name": "red", "vpn-id": "blue_vpn1", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any" } ] }
running словарь	Когда метод не равен delete	Текущая рабочая конфигурация на устройстве. Пример: { "vpn-service": [ { "vpn-id": "red_vpn2", "customer-name": "blue", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any" }, { "vpn-id": "blue_vpn1", "customer-name": "red", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any" } ] }

Авторы

Ganesh Nalawade (@ganeshrn)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/netcommon/restconf_config_module.html