ansible.netcommon.restconf_get – Получение данных конфигурации/состояния с устройств, поддерживающих RESTCONF.
Примечание
Этот плагин является частью коллекции ansible.netcommon (версия 1.4.1).
Для его установки используйте: ansible-galaxy collection install ansible.netcommon
Для использования в книге задач укажите: ansible.netcommon.restconf_get
Введено в версии 1.0.0: из ansible.netcommon
Описание
- RESTCONF — это стандартный механизм, позволяющий веб-приложениям получать доступ к данным конфигурации и состояния, разработанным и стандартизированным IETF. Он документирован в RFC 8040.
- Этот модуль позволяет пользователю получать данные конфигурации и состояния с устройств, поддерживающих RESTCONF.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| content строка |
| Параметр запроса, который управляет тем, как будут обрабатываться дочерние узлы запрашиваемых узлов данных в path. Если значение равно config, возвращаются только дочерние узлы данных конфигурации значения в path. Если значение равно nonconfig, возвращаются только дочерние узлы данных, не являющиеся конфигурацией, значения в path. Если значение равно all, возвращаются все дочерние узлы данных значения в path
|
| output строка |
| Вывод полученного ответа. |
| path строка / обязательно | URI, используемый для выполнения вызовов API. |
Примеры
- name: get l3vpn services
ansible.netcommon.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" } ] } } |
Авторы
- 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_get_module.html
