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

Примечание

Этот плагин входит в коллекцию ansible.netcommon (версия 1.4.1).

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

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

Новое в версии 1.0.0: из 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-вызовов.

Примеры

- 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/netcommon/restconf_config_module.html