---
name: "Sys::Virt::Interface"
section: "3pm"
platform: "linux"
package: "perl-sys-virt"
version: "12.7.0-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Sys::Virt::Interface"
---

# Sys::Virt::Interface(3pm)

Represent & manage a libvirt host network interface

## NAME

Sys::Virt::Interface - Represent & manage a libvirt host network interface

## DESCRIPTION

The `"Sys::Virt::Interface"` module represents a host network interface allowing configuration of IP addresses, bonding, vlans and bridges.

## METHODS

- my $name = $iface-\>**get\_name()**

  Returns a string with a locally unique name of the network

- $iface-\>**is\_active()**

  Returns a true value if the interface is currently running

- my $name = $iface-\>**get\_mac()**

  Returns a string with the hardware MAC address of the interface

- my $xml = $iface-\>**get\_xml\_description()**

  Returns an XML document containing a complete description of the network's configuration

- $iface-\>**create()**

  Start a network whose configuration was previously defined using the `"define_network"` method in Sys::Virt.

- $iface-\>**undefine()**

  Remove the configuration associated with a network previously defined with the `"define_network"` method in Sys::Virt. If the network is running, you probably want to use the `"shutdown"` or `"destroy"` methods instead.

- $iface-\>**destroy()**

  Immediately terminate the machine, and remove it from the virtual machine monitor. The `$iface` handle is invalid after this call completes and should not be used again.

## CONSTANTS

This section documents constants that are used with various APIs described above

### LIST FILTERING

The following constants are used to filter object lists

- Sys::Virt::Interface::LIST\_ACTIVE

  Include interfaces that are active

- Sys::Virt::Interface::LIST\_INACTIVE

  Include interfaces that are not active

### INTERFACE DEFINE

The following constants can be used to control the behaviour of interface define operations

- Sys::Virt::Interface::DEFINE\_VALIDATE

  Validate the XML document against the XML schema

### XML CONSTANTS

The following constants are used when querying XML

- Sys::Virt::Interface::XML\_INACTIVE

  Request the inactive XML, instead of the current possibly live config.

## AUTHORS

Daniel P. Berrange \<berrange@redhat.com\>

## COPYRIGHT

Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange

## LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of either the GNU General Public License as published by the Free Software Foundation (either version 2 of the License, or at your option any later version), or, the Artistic License, as specified in the Perl README file.

## SEE ALSO

Sys::Virt, Sys::Virt::Error, `"http://libvirt.org"`