<commit_before>---
title: ReportingVnicInformation
category: feature
authors: danken, moti, msalem
wiki_category: Feature
wiki_title: Feature/ReportingVnicInformation
wiki_revision_count: 40
wiki_last_updated: 2014-02-03
---

# Reporting Vnic Information

## Reporting vNIC information reported by Guest Agent

### Summary

The Guest Agent reports the vNic details:

*   IP addresses (both IPv4 and IPv6).
*   vNic internal name

The retrieved information by the Guest Agent should be reported to the ovirt-engine and to be viewed by its client
Today only the IPv4 addresses are reported to the User, kept on VM level. This feature will maintain the information on vNic level.

### Owner

*   Name: <NAME>
*   Email: <EMAIL>

### Current status

[http://wiki.ovirt.org/wiki/Feature/DetailedReportingVnicInformation Reporting vNIC implementation reported by Guest Agent Detailed Design](http://wiki.ovirt.org/wiki/Feature/DetailedReportingVnicInformation Reporting vNIC implementation reported by Guest Agent Detailed Design)

### User Experience

#### API Changes

New attributes will be added to VM nics collection /api/vms/{vm:id}/nics:

`   `<nics>
`       `<nic id="56d6d62f-6af0-4c02-8500-4be041180031">
`           `<name>`nic1`</name>
                 ...
`           `<reported_data>
`               `<rel="devices" href=/api/vms/{vm:id}/nics/xxx/devices>
`           `<reported_data/>
`      `<nic/>
             ...
`   `</nics>

device:id = UUID.fromString(name)

<device id={device:id} href=/api/vms/{vm:id}/devices/{device:id}>

`       `<name>`p1p2`</name>
`       `<description>`guest reported data`</description>
`       `<ipv4_addresses>
`           `<ip address="1.1.1.1"/>
`           `<ip address="2.2.2.2"/>
`       `</ipv4_addresses>
`       `<ipv6_addresses>
`           `<ip address="2001:0db8:85a3:0042:0000:8a2e:0370:7335"/>
`           `<ip address="2001:0db8:85a3:0042:0000:8a2e:0370:7336"/>
`       `</ipv6_addresses>
             `<mac></mac>`        

</device>

##### Backward compatibility

Note that the existing IPs reported on /api/vms/{vm:id} are left intact, however the IPs addresses are retrieved from the VM's nics.
<commit_msg>API Changes<commit_after>---
title: ReportingVnicInformation
category: feature
authors: danken, moti, msalem
wiki_category: Feature
wiki_title: Feature/ReportingVnicInformation
wiki_revision_count: 40
wiki_last_updated: 2014-02-03
---

# Reporting Vnic Information

## Reporting vNIC information reported by Guest Agent

### Summary

The Guest Agent reports the vNic details:

*   IP addresses (both IPv4 and IPv6).
*   vNic internal name

The retrieved information by the Guest Agent should be reported to the ovirt-engine and to be viewed by its client
Today only the IPv4 addresses are reported to the User, kept on VM level. This feature will maintain the information on vNic level.

### Owner

*   Name: <NAME>
*   Email: <EMAIL>

### Current status

[http://wiki.ovirt.org/wiki/Feature/DetailedReportingVnicInformation Reporting vNIC implementation reported by Guest Agent Detailed Design](http://wiki.ovirt.org/wiki/Feature/DetailedReportingVnicInformation Reporting vNIC implementation reported by Guest Agent Detailed Design)

### User Experience

#### API Changes

New attributes will be added to VM nics collection /api/vms/{vm:id}/nics:

`   `<nics>
`       `<nic id="56d6d62f-6af0-4c02-8500-4be041180031">
`           `<name>`nic1`</name>
                 ...
`           `<reported_data>
`               `<rel="devices" href=/api/vms/{vm:id}/nics/xxx/devices>
`           `<reported_data/>
`      `<nic/>
             ...
`   `</nics>

device:id = UUID.fromString(name)

` `<device id={device:id} href=/api/vms/{vm:id}/devices/{device:id}>
`       `<name>`p1p2`</name>
`       `<description>`guest reported data`</description>
`       `<ipv4_addresses>
`           `<ip address="1.1.1.1"/>
`           `<ip address="2.2.2.2"/>
`       `</ipv4_addresses>
`       `<ipv6_addresses>
`           `<ip address="2001:0db8:85a3:0042:0000:8a2e:0370:7335"/>
`           `<ip address="2001:0db8:85a3:0042:0000:8a2e:0370:7336"/>
`       `</ipv6_addresses>
             `<mac></mac>`        
` `</device>

##### Backward compatibility

Note that the existing IPs reported on /api/vms/{vm:id} are left intact, however the IPs addresses are retrieved from the VM's nics.

{'fraction_non_alphanumeric': 0.13317972350230414, 'fraction_numerical': 0.04884792626728111, 'mean_word_length': 3.264243614931238, 'pattern_counts': {'":': 0, '<': 57, '<?xml version=': 0, '>': 57, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 4, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '407016', 'n_tokens_mistral': 1728, 'n_tokens_neox': 1483, 'n_words': 367}