Bug 1441741

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-engineAssignee: Ori Liel <oliel>
Status: CLOSED ERRATA QA Contact: samuel macko <smacko>
Severity: medium Docs Contact:
Priority: medium    
Version: 4.0.7CC: apinnick, dcadzow, juan.hernandez, lleistne, lsurette, mkalinin, mperina, mtessun, oliel, omachace, rdlugyhe, Rhev-m-bugs, srevivo, tjelinek
Target Milestone: ovirt-4.3.3Keywords: Documentation
Target Release: 4.3.0Flags: 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
Description of problem:
When one runs v4 API call to /api/vms in RHV 4.0.7 (and in earlier RHV 4.0.x as well I believe), even if guest agent is installed the information about IP address of a virtual machine is missing (entire <guest_info> block) , only <fqdn> is visible. If one enforces a v3 API call, everything is displayed as expected.

Version-Release number of selected component (if applicable):
RHV 4.0.x

How reproducible:

Steps to Reproduce:
1. Create a VM in RHEV env, install guest agent
2. Run a v4 API GET call to /api/vms:
# curl \
--cacert '/path/to/ca.crt' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:password' \

Actual results:
<guest_info> block is completely missing in output, only <fqdn> is visible

Expected results:
<guest_info> is displayed like in below example:

                <ip address="xxx.xxx.xxx.xxx" version="v4"/>
                <ip address="fe80::xxxx:xxxx:xxxx:xxxx" version="v6"/>
                <ip address="xxxx:xx:x:xxxx:xxx:xxxx:xxxx:xxx" version="v6"/>

Kind Regards,
Igor Netkachev
Technical Support Engineer
Red Hat Global Support Services

Comment 4 Juan Hernández 2017-04-14 07:39:22 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


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:


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.

Comment 5 Juan Hernández 2017-04-14 07:41:49 UTC
I am removing the 'Regression' keyword, as 'guest_info' is still available in V3 of the API, and was never available in V4.

Comment 6 Oved Ourfali 2017-04-15 16:15:44 UTC
Juan, should this move to virt?

Comment 7 Juan Hernández 2017-04-15 19:59:39 UTC
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.

Comment 15 Sandro Bonazzola 2019-01-28 09:41:35 UTC
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.

Comment 16 RHV bug bot 2019-03-05 21:22:43 UTC
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

Comment 18 RHV bug bot 2019-03-29 11:14:37 UTC
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

Comment 19 samuel macko 2019-04-05 12:15:55 UTC
Verified on ovirt-engine- and python-ovirt-engine-sdk4-4.3.1-1.el7ev.x86_64.

Comment 22 errata-xmlrpc 2019-05-08 12:36:48 UTC
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.