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

Новая в версии 2.8.

Обзор
Параметры
Примеры
Возвращаемые значения
Статус

Обзор

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.

Примеры

- name: create l3vpn services
  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" } ] }

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительная информация о поддержке этого модуля Red Hat доступна в этой статье базы знаний Red Hat.

Авторы

Ganesh Nalawade (@ganeshrn)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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