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

Примечание

Этот модуль входит в коллекцию ansible.netcommon (версия 8.5.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать её в сценарии, укажите: ansible.netcommon.restconf_config.

Добавлено в ansible.netcommon 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
content string	Данные конфигурации в формате, заданном параметром `format`. Обязателен, если `method` не равен delete.
format string	Формат конфигурации, переданной в качестве значения `content`. Допустимые значения — xml и json; указанный формат конфигурации должен поддерживаться удалённым сервером RESTCONF. Варианты: `"json"` ← (по умолчанию) `"xml"`
method string	Метод RESTCONF для управления изменением конфигурации на устройстве. Значение post используется для создания ресурса данных или вызова ресурса операции, put — для замены целевого ресурса данных, patch — для изменения целевого ресурса, а delete — для удаления целевого ресурса. Варианты: `"post"` ← (по умолчанию) `"put"` `"patch"` `"delete"`
path string / обязательный	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 dictionary	Конфигурация, отправленная на устройство. Возвращается: Если метод не равен delete Пример: `{"vpn-service": [{"customer-name": "red", "vpn-id": "blue_vpn1", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any"}]}`
running dictionary	Текущая работающая конфигурация устройства. Возвращается: Если метод не равен delete Пример: `{"vpn-service": [{"customer-name": "blue", "vpn-id": "red_vpn2", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any"}, {"customer-name": "red", "vpn-id": "blue_vpn1", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any"}]}`

Авторы

Ganesh Nalawade (@ganeshrn)

Ссылки на коллекцию

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