vm.get_guest_network_interfaces

Return the network interfaces visible inside a running VM as reported by the QEMU guest agent.

Requires the guest to have qemu-guest-agent installed and running.

Note

This method polls the guest agent with a 30-second timeout. If the agent is not yet ready (e.g. the guest just booted), a CallError is raised and the caller should retry.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the virtual machine.

Return value

Result

Type: array of object

Network interfaces reported by the QEMU guest agent.

No Additional Items

Each item of this array must be:

VMGuestNetworkInterface

Type: object
No Additional Properties

name Required

Name

Type: string

Interface name as seen in the guest OS (e.g. 'eth0', 'ens3').

hardware_address Required

Hardware Address

Type: string

MAC address of the interface.

ip_addresses Required

Ip Addresses

Type: array of object

IP addresses currently assigned to this interface.

No Additional Items

Each item of this array must be:

VMGuestNetworkInterfaceIPAddress

Type: object
No Additional Properties

ip_address Required

Ip Address

IP address assigned to the interface.

Any of

• Option 1
• Option 2

Type: const
Specific value: ""

Type: string

prefix Required

Prefix

Type: integer

Prefix length (subnet mask bits).

ip_address_type Required

Ip Address Type

Type: enum (of string)

Address family: 'IPV4' or 'IPV6'.

Must be one of:

• "IPV4"
• "IPV6"

Required roles: VM_READ