| Summary: | [Docs][REST][Python][Ruby][Java] v4 API - Document the proper way to retrieve IP-addresses of a VM | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Virtualization Manager | Reporter: | Igor Netkachev <inetkach> |
| Component: | ovirt-engine | Assignee: | Ori Liel <oliel> |
| Status: | CLOSED ERRATA | QA Contact: | samuel macko <smacko> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 4.0.7 | CC: | apinnick, dcadzow, juan.hernandez, lleistne, lsurette, mkalinin, mperina, mtessun, oliel, omachace, rdlugyhe, Rhev-m-bugs, srevivo, tjelinek |
| Target Milestone: | ovirt-4.3.3 | Keywords: | Documentation |
| Target Release: | 4.3.0 | Flags: | rdlugyhe:
needinfo?
(oliel) |
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | docs-accepted | ||
| Fixed In Version: | ovirt-engine-sdk-4.3.1 | Doc Type: | Bug Fix |
| Doc Text: |
In the current release, the v4 API documentation shows how to retrieve the IP addresses of a virtual machine.
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2019-05-08 12:36:48 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | Infra | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
|
Description
Igor Netkachev
2017-04-12 15:19:02 UTC
The 'guest_info' element has been removed in version 4 of the API. The information is now available in the collection of 'reported devices' of the virtual machine:
GET /ovirt-engine/api/vms/123/reporteddevices
<reported_devices>
<reported_device>
<name>eth0</name>
<type>network</type>
<mac>
<address>00:1a:4a:b5:4c:94</address>
</mac>
<ips>
<ip>
<address>192.168.1.115</address>
<version>v4</version>
</ip>
...
</ips>
</reported_device>
...
</reported_devices>
Note that the same VM may contain multiple reported devices, and in particular multiple network interface cards. Each network interface card may then contain multiple IP addresses.
For a particular network interface card the same information is also available in /ovirt-engine/api/vms/123/nics/456/reporteddevices.
This change is documented here:
http://ovirt.github.io/ovirt-engine-api-model/4.1/#_removed_the_code_guest_info_code_element
That documentation can be improved. And we should probably add to the SDKs examples showing how to get IP addresses of virtual machines, as it is a common use case.
I am removing the 'Regression' keyword, as 'guest_info' is still available in V3 of the API, and was never available in V4. Juan, should this move to virt? Yes, I think so, moving it. Note that in my opinion the only thing that should do is improve the documentation and add examples to the SDKs. This bug has not been marked as blocker for oVirt 4.3.0. Since we are releasing it tomorrow, January 29th, this bug has been re-targeted to 4.3.1. INFO: Bug status wasn't changed from MODIFIED to ON_QA due to the following reason: [No relevant external trackers attached] For more info please contact: rhv-devops INFO: Bug status (ON_QA) wasn't changed but the folowing should be fixed: [No relevant external trackers attached] For more info please contact: rhv-devops Verified on ovirt-engine-4.3.3.2-0.1.el7.noarch and python-ovirt-engine-sdk4-4.3.1-1.el7ev.x86_64. Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHEA-2019:1085 |