Spec-Zone.ru › Ansible 2.9

restconf_get – Получение данных конфигурации/состояния из устройств RESTCONF

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

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
content
-
    Варианты:
  • config
  • nonconfig
  • all
Параметр запроса, который управляет обработкой дочерних узлов запрошенных узлов данных в path. Если значение равно config, возвращаются только дочерние данные конфигурации узла со значением в path. Если значение равно nonconfig, возвращаются только дочерние данные, не относящиеся к конфигурации, узла со значением в path. Если значение равно all, возвращаются все дочерние узлы данных со значением в path.
output
-
    Варианты:
  • json ←
  • xml
Вывод полученного ответа.
path
- / обязательно
URI, используемый для выполнения API-запросов.

Примеры

- name: get l3vpn services
  restconf_get:
      path: /config/ietf-l3vpn-svc:l3vpn-svc/vpn-services

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
response
словарь
при валидном JSON ответе устройства
Словарь, представляющий JSON-форматированный ответ

Пример:
{ "vpn-services": { "vpn-service": [ { "customer-name": "red", "vpn-id": "blue_vpn1", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any" } ] } }


Статус

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

Поддержка 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.9/modules/restconf_get_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API