Sys::V...erface(3pm)

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

okay so bestie, this is a page from the User Contributed Perl Documentation (iykyk) and it's the whole entire vibe for Sys::Virt::Interface, a Perl module. buckle up πŸŽ€

πŸ’œ NAME

Sys::Virt::Interface β€” literally the module that lets you represent & manage a libvirt host network interface πŸ¦‹

🌸 DESCRIPTION

The Sys::Virt::Interface module represents a host network interface, and it's giving full glow-up energy: it lets you configure IP addresses, bonding, vlans and bridges. no cap, it does all of that πŸ’…

πŸ‘‘ METHODS

here's the group chat of methods, bestie, every single one:

  • my $name = $iface->get_name() β€” returns a string with a locally unique name of the network. it's the interface's government name, fr fr πŸͺͺ
  • $iface->is_active() β€” returns a true value if the interface is currently running. vibe check: is it up? ✨
  • my $name = $iface->get_mac() β€” returns a string with the hardware MAC address of the interface. that's the hardware's literal fingerprint 🫢
  • my $xml = $iface->get_xml_description() β€” returns an XML document containing a complete description of the network's configuration. the whole lore, in XML form πŸ“œ
  • $iface->create() β€” start a network whose configuration was previously defined using the "define_network" method in Sys::Virt. time to make it real πŸ”₯
  • $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. hope this helps 😭
  • $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. like, it's dead-dead, do not touch it πŸ’€
⚠️ real talk: after destroy() the $iface handle is invalid β€” do NOT reuse it. that's not me being dramatic, that's the manpage.

🌈 CONSTANTS

this section documents constants that are used with various APIs described above. little fact drops, keep them in your notes πŸ“

⭐ 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. obsessed with a schema check before committing πŸŽ€

πŸ¦‹ 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. the "before" pic instead of the "now" pic πŸ–ΌοΈ

πŸ’– AUTHORS

Daniel P. Berrange <berrange@redhat.com> β€” the main character, we stan πŸ‘‘

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 of these two icons:

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

pick your fighter, both slay πŸ’œ

πŸ” SEE ALSO


and that's the whole page, bestie 🫢 this one's from perl v5.40.2, dated 2026-06-08 β€” no cap, it's giving iconic manual-page energy, periodt πŸŽ€βœ¨

πŸ“¦ where this page comes from