<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:

*   IPv4 addresses reported by the guest agent

`  `<guest_agent_ipv4_addresses>
`      `<ip address="1.1.1.1"/>
`      `<ip address="2.2.2.2"/>
`  `</guest_agent_ipv4_addresses>

*   IPv6 addresses reported by the guest agent

`  `<guest_agent_ipv6_addresses>
`      `<ip address="2001:0db8:85a3:0042:0000:8a2e:0370:7335"/>
`      `<ip address="2001:0db8:85a3:0042:0000:8a2e:0370:7336"/>
`  `</guest_agent_ipv6_addresses>

*   interface_name

`  `<interface_name>`p1p2`</interface_name>

Note that *ipv4_addresses* and *ipv6_addresses* are saved for IP allocation feature for stating the IP(s) set by the engine for the vNic.

##### 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.

`  `<guest_info>
`      `<ips>
`          `<ip address="1.1.1.1"/>
`          `<ip address="2.2.2.2"/>
`      `</ips>
`  `</guest_info>

However it will be extended to contain also the network devices configuration on the guest:

`  `<guest_info>
`      `<network_devices>
`          `<interface>
`              `<name>`p1p2`</name>
`              `<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 address="AA:AA:AA:AA:AA:AA"/>
`          `</interface>
`      `</network_devices>
`  `</guest_info>

Populating the VM's **network_devices** element under **guest_info** is implemented by mechanism introduced by ["All-Content Header" patch](http://gerrit.ovirt.org/#/c/9018)
Only if the request header contains the 'All-Content' property with 'true' value, will populate the network_device information for the VM.

#### UI Changes

Administrator Portal:

*   VM Main-Tab - No changes:
    -   On ip address column the entire list of IP addresses will be presented instead (single space delimiter between the IPs)
*   VM Network Interface sub-tab:
    -   Add column 'interface name' (before mac-address field) - presents the internal name of the vNic.
    -   Add column 'IPv4 Address' (after mac-address field) - presents the IPv4 addresses of the vNic (for multiple addresses per vnic, field includes a comma delimited list).<commit_msg>Backward compatibility<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:

*   IPv4 addresses reported by the guest agent

`  `<guest_agent_ipv4_addresses>
`      `<ip address="1.1.1.1"/>
`      `<ip address="2.2.2.2"/>
`  `</guest_agent_ipv4_addresses>

*   IPv6 addresses reported by the guest agent

`  `<guest_agent_ipv6_addresses>
`      `<ip address="2001:0db8:85a3:0042:0000:8a2e:0370:7335"/>
`      `<ip address="2001:0db8:85a3:0042:0000:8a2e:0370:7336"/>
`  `</guest_agent_ipv6_addresses>

*   interface_name

`  `<interface_name>`p1p2`</interface_name>

Note that *ipv4_addresses* and *ipv6_addresses* are saved for IP allocation feature for stating the IP(s) set by the engine for the vNic.

##### 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.

`  `<guest_info>
`      `<ips>
`          `<ip address="1.1.1.1"/>
`          `<ip address="2.2.2.2"/>
`      `</ips>
`  `</guest_info>

However it will be extended to contain also the network devices configuration on the guest:

`  `<guest_info>
            ...
`      `<network_devices>
`          `<interface>
`              `<name>`p1p2`</name>
`              `<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 address="AA:AA:AA:AA:AA:AA"/>
`          `</interface>
`      `</network_devices>
`  `</guest_info>

Populating the VM's **network_devices** element under **guest_info** is implemented by mechanism introduced by ["All-Content Header" patch](http://gerrit.ovirt.org/#/c/9018)
Only if the request header contains the 'All-Content' property with 'true' value, will populate the network_device information for the VM.

#### UI Changes

Administrator Portal:

*   VM Main-Tab - No changes:
    -   On ip address column the entire list of IP addresses will be presented instead (single space delimiter between the IPs)
*   VM Network Interface sub-tab:
    -   Add column 'interface name' (before mac-address field) - presents the internal name of the vNic.
    -   Add column 'IPv4 Address' (after mac-address field) - presents the IPv4 addresses of the vNic (for multiple addresses per vnic, field includes a comma delimited list).
{'fraction_non_alphanumeric': 0.11532604181088191, 'fraction_numerical': 0.04624117402741243, 'mean_word_length': 3.464771322620519, 'pattern_counts': {'":': 0, '<': 73, '<?xml version=': 0, '>': 73, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 12, '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': '2133081', 'n_tokens_mistral': 2604, 'n_tokens_neox': 2372, 'n_words': 702}