.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Sys::Virt::NetworkPort 3pm"
.TH Sys::Virt::NetworkPort 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Sys::Virt::NetworkPort \- Represent & manage a libvirt virtual network port
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`Sys::Virt::NetworkPort\*(C'\fR module represents a port in a virtual network.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "my $uuid = $port\->\fBget_uuid()\fR" 4
.el .IP "my \f(CW$uuid\fR = \f(CW$port\fR\->\fBget_uuid()\fR" 4
.IX Item "my $uuid = $port->get_uuid()"
Returns a 16 byte long string containing the raw globally unique identifier
(UUID) for the network port.
.ie n .IP "my $uuid = $port\->\fBget_uuid_string()\fR" 4
.el .IP "my \f(CW$uuid\fR = \f(CW$port\fR\->\fBget_uuid_string()\fR" 4
.IX Item "my $uuid = $port->get_uuid_string()"
Returns a printable string representation of the raw UUID, in the format
\&'XXXXXXXX\-XXXX\-XXXX\-XXXX\-XXXXXXXXXXXX'.
.ie n .IP "my $xml = $port\->\fBget_xml_description()\fR" 4
.el .IP "my \f(CW$xml\fR = \f(CW$port\fR\->\fBget_xml_description()\fR" 4
.IX Item "my $xml = $port->get_xml_description()"
Returns an XML document containing a complete description of
the network port's configuration
.ie n .IP $port\->\fBdelete()\fR 4
.el .IP \f(CW$port\fR\->\fBdelete()\fR 4
.IX Item "$port->delete()"
Delete the network port from the managed network.
.ie n .IP "my $params = $port\->get_parameters($flags=0);" 4
.el .IP "my \f(CW$params\fR = \f(CW$port\fR\->get_parameters($flags=0);" 4
.IX Item "my $params = $port->get_parameters($flags=0);"
Get tunable parameters associated with the network port. The \f(CW$flags\fR
parameter is currently unused and defaults to zero. The returned
\&\f(CW$params\fR is a hash reference whose keys are one or more of the
following constants:
.RS 4
.IP Sys::Virt::NetworkPort::BANDWIDTH_IN_AVERAGE 4
.IX Item "Sys::Virt::NetworkPort::BANDWIDTH_IN_AVERAGE"
The average inbound bandwidth
.IP Sys::Virt::NetworkPort::BANDWIDTH_IN_BURST 4
.IX Item "Sys::Virt::NetworkPort::BANDWIDTH_IN_BURST"
The burstable inbound bandwidth
.IP Sys::Virt::NetworkPort::BANDWIDTH_IN_FLOOR 4
.IX Item "Sys::Virt::NetworkPort::BANDWIDTH_IN_FLOOR"
The minimum inbound bandwidth
.IP Sys::Virt::NetworkPort::BANDWIDTH_IN_PEAK 4
.IX Item "Sys::Virt::NetworkPort::BANDWIDTH_IN_PEAK"
The peak inbound bandwidth
.IP Sys::Virt::NetworkPort::BANDWIDTH_OUT_AVERAGE 4
.IX Item "Sys::Virt::NetworkPort::BANDWIDTH_OUT_AVERAGE"
The average outbound bandwidth
.IP Sys::Virt::NetworkPort::BANDWIDTH_OUT_BURST 4
.IX Item "Sys::Virt::NetworkPort::BANDWIDTH_OUT_BURST"
The burstable outbound bandwidth
.IP Sys::Virt::NetworkPort::BANDWIDTH_OUT_PEAK 4
.IX Item "Sys::Virt::NetworkPort::BANDWIDTH_OUT_PEAK"
The peak outbound bandwidth
.RE
.RS 4
.RE
.ie n .IP "$port\->set_parameters($params, $flags=0);" 4
.el .IP "\f(CW$port\fR\->set_parameters($params, \f(CW$flags\fR=0);" 4
.IX Item "$port->set_parameters($params, $flags=0);"
Set tunable parameters associated with the network port. The \f(CW$flags\fR
parameter is currently unused and defaults to zero. The \f(CW$params\fR
parameter is a hash reference whose keys are one or more of the
constants listed for \f(CW\*(C`get_parameters\*(C'\fR.
.SS "NETWORK PORT CREATION CONSTANTS"
.IX Subsection "NETWORK PORT CREATION CONSTANTS"
When creating network ports zero or more of the following
constants may be used
.IP Sys::Virt::NetworkPort::CREATE_RECLAIM 4
.IX Item "Sys::Virt::NetworkPort::CREATE_RECLAIM"
Providing configuration reclaiming a pre-existing network port.
.IP Sys::Virt::NetworkPort::CREATE_VALIDATE 4
.IX Item "Sys::Virt::NetworkPort::CREATE_VALIDATE"
Validate the XML document against the XML schema
.SH AUTHORS
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2019 Red Hat
.SH LICENSE
.IX Header "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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sys::Virt, Sys::Virt::Network, Sys::Virt::Error, \f(CW\*(C`http://libvirt.org\*(C'\fR