restconf_get – Получение данных конфигурации/состояния с устройств, поддерживающих RESTCONF
Новое в версии 2.8.
Описание
- RESTCONF — это стандартный механизм, позволяющий веб-приложениям получать доступ к данным конфигурации и состояния, разработанным и стандартизированным IETF. Он документирован в RFC 8040.
- Этот модуль позволяет пользователю получать данные конфигурации и состояния с устройств, поддерживающих RESTCONF.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
content
-
|
|
Параметр запроса, который управляет обработкой дочерних узлов запрошенных узлов данных в
path. Если значение config, возвращаются только дочерние узлы данных конфигурации значения в path. Если значение nonconfig, возвращаются только дочерние узлы данных, не являющиеся конфигурацией, значения в path. Если значение all, возвращаются все дочерние узлы данных значения в path.
|
|
output
-
|
|
Вывод полученного ответа.
|
|
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.8/modules/restconf_get_module.html