/usr/lib/perl5/Sys/Virt.pm is in libsys-virt-perl 1.2.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 | # -*- perl -*-
#
# Copyright (C) 2006 Red Hat
# Copyright (C) 2006-2007 Daniel P. Berrange
#
# This program is free software; You can redistribute it and/or modify
# it under either:
#
# a) the GNU General Public License as published by the Free
# Software Foundation; either version 2, or (at your option) any
# later version,
#
# or
#
# b) the "Artistic License"
#
# The file "LICENSE" distributed along with this file provides full
# details of the terms and conditions of the two licenses.
=pod
=head1 NAME
Sys::Virt - Represent and manage a libvirt hypervisor connection
=head1 SYNOPSIS
my $vmm = Sys::Virt->new(uri => $uri);
my @domains = $vmm->list_domains();
foreach my $dom (@domains) {
print "Domain ", $dom->get_id, " ", $dom->get_name, "\n";
}
=head1 DESCRIPTION
The Sys::Virt module provides a Perl XS binding to the libvirt
virtual machine management APIs. This allows machines running
within arbitrary virtualization containers to be managed with
a consistent API.
=head1 ERROR HANDLING
Any operations in the Sys::Virt API which have failure scenarios
will result in an instance of the L<Sys::Virt::Error> module being
thrown. To catch these errors, simply wrap the method in an eval
block:
eval { my $vmm = Sys::Virt->new(uri => $uri); };
if ($@) {
print STDERR "Unable to open connection to $addr" . $@->message . "\n";
}
For details of the information contained in the error objects,
consult the L<Sys::Virt::Error> manual page.
=head1 METHODS
=over 4
=cut
package Sys::Virt;
use strict;
use warnings;
use Sys::Virt::Error;
use Sys::Virt::Domain;
use Sys::Virt::Network;
use Sys::Virt::StoragePool;
use Sys::Virt::StorageVol;
use Sys::Virt::NodeDevice;
use Sys::Virt::Interface;
use Sys::Virt::Secret;
use Sys::Virt::NWFilter;
use Sys::Virt::DomainSnapshot;
use Sys::Virt::Stream;
our $VERSION = '1.2.1';
require XSLoader;
XSLoader::load('Sys::Virt', $VERSION);
=item my $vmm = Sys::Virt->new(uri => $uri, readonly => $ro, flags => $flags);
Attach to the virtualization host identified by C<uri>. The
C<uri> parameter may be omitted, in which case the default connection made
will be to the local Xen hypervisor. Some example URIs include:
=over 4
=item xen:///
Xen on the local machine
=item test:///default
Dummy "in memory" driver for test suites
=item qemu:///system
System-wide driver for QEMU / KVM virtualization
=item qemu:///session
Per-user driver for QEMU virtualization
=item qemu+tls://somehost/system
System-wide QEMU driver on C<somehost> using TLS security
=item xen+tcp://somehost/
Xen driver on C<somehost> using TCP / SASL security
=back
For further details consult C<http://libvirt.org/uri.html>
If the optional C<readonly> parameter is supplied, then an unprivileged
connection to the VMM will be attempted. If it is not supplied, then it
defaults to making a fully privileged connection to the VMM. If the
calling application is not running as root, it may be necessary to
provide authentication callbacks.
If the optional C<auth> parameter is set to a non-zero value,
authentication will be enabled during connection, using the
default set of credential gathering callbacks. The default
callbacks prompt for credentials on the console, so are not
suitable for graphical applications. For such apps a custom
implementation should be supplied. The C<credlist> parameter
should be an array reference listing the set of credential
types that will be supported. The credential constants in
this module can be used as values in this list. The C<callback>
parameter should be a subroutine reference containing the
code necessary to gather the credentials. When invoked it
will be supplied with a single parameter, a array reference
of requested credentials. The elements of the array are
hash references, with keys C<type> giving the type of
credential, C<prompt> giving a user descriptive user
prompt, C<challenge> giving name of the credential
required. The answer should be collected from the user, and
returned by setting the C<result> key. This key may already
be set with a default result if applicable
As a simple example returning hardcoded credentials
my $uri = "qemu+tcp://192.168.122.1/system";
my $username = "test";
my $password = "123456";
my $con = Sys::Virt->new(uri => $uri,
auth => 1,
credlist => [
Sys::Virt::CRED_AUTHNAME,
Sys::Virt::CRED_PASSPHRASE,
],
callback =>
sub {
my $creds = shift;
foreach my $cred (@{$creds}) {
if ($cred->{type} == Sys::Virt::CRED_AUTHNAME) {
$cred->{result} = $username;
}
if ($cred->{type} == Sys::Virt::CRED_PASSPHRASE) {
$cred->{result} = $password;
}
}
return 0;
});
For backwards compatibility with earlier releases, the C<address>
parameter is accepted as a synonym for the C<uri> parameter. The
use of C<uri> is recommended for all newly written code.
=cut
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my %params = @_;
my $uri = exists $params{address} ? $params{address} : exists $params{uri} ? $params{uri} : undef;
my $flags = exists $params{flags} ? $params{flags} : 0;
if ($params{readonly}) {
$flags |= &Sys::Virt::CONNECT_RO;
}
my $auth = exists $params{auth} ? $params{auth} : 0;
my $authcb = exists $params{callback} ? $params{callback} : undef;
my $credlist = exists $params{credlist} ? $params{credlist} : undef;
my $self;
if ($auth) {
$self = Sys::Virt::_open_auth($uri, $credlist, $authcb, $flags);
} else {
$self = Sys::Virt::_open($uri, $flags);
}
bless $self, $class;
return $self;
}
=item my $st = $vmm->new_stream($flags)
Create a new stream, with the given flags
=cut
sub new_stream {
my $self = shift;
my $flags = shift || 0;
return Sys::Virt::Stream->_new(connection => $self, flags => $flags);
}
=item my $dom = $vmm->create_domain($xml, $flags);
Create a new domain based on the XML description passed into the C<$xml>
parameter. The returned object is an instance of the L<Sys::Virt::Domain>
class. This method is not available with unprivileged connections to
the VMM. The C<$flags> parameter accepts one of the DOMAIN CREATION
constants documented in L<Sys::Virt::Domain>, and defaults to 0 if omitted.
=cut
sub create_domain {
my $self = shift;
my $xml = shift;
my $flags = shift || 0;
return Sys::Virt::Domain->_new(connection => $self, xml => $xml, flags => $flags);
}
=item my $dom = $vmm->create_domain_with_files($xml, $fds, $flags);
Create a new domain based on the XML description passed into the C<$xml>
parameter. The returned object is an instance of the L<Sys::Virt::Domain>
class. This method is not available with unprivileged connections to
the VMM. The C<$fds> parameter is an array of UNIX file descriptors
which will be passed to the init process of the container. This is
only supported with container based virtualization. The C<$flags>
parameter accepts one of the DOMAIN CREATION constants documented
in L<Sys::Virt::Domain>, and defaults to 0 if omitted.
=cut
sub create_domain_with_files {
my $self = shift;
my $xml = shift;
my $fds = shift;
my $flags = shift || 0;
return Sys::Virt::Domain->_new(connection => $self, xml => $xml,
fds => $fds, flags => $flags);
}
=item my $dom = $vmm->define_domain($xml);
Defines, but does not start, a new domain based on the XML description
passed into the C<$xml> parameter. The returned object is an instance
of the L<Sys::Virt::Domain> class. This method is not available with
unprivileged connections to the VMM. The defined domain can be later started
by calling the C<create> method on the returned C<Sys::Virt::Domain>
object.
=cut
sub define_domain {
my $self = shift;
my $xml = shift;
return Sys::Virt::Domain->_new(connection => $self, xml => $xml, nocreate => 1);
}
=item my $dom = $vmm->create_network($xml);
Create a new network based on the XML description passed into the C<$xml>
parameter. The returned object is an instance of the L<Sys::Virt::Network>
class. This method is not available with unprivileged connections to
the VMM.
=cut
sub create_network {
my $self = shift;
my $xml = shift;
return Sys::Virt::Network->_new(connection => $self, xml => $xml);
}
=item my $dom = $vmm->define_network($xml);
Defines, but does not start, a new network based on the XML description
passed into the C<$xml> parameter. The returned object is an instance
of the L<Sys::Virt::Network> class. This method is not available with
unprivileged connections to the VMM. The defined network can be later started
by calling the C<create> method on the returned C<Sys::Virt::Network>
object.
=cut
sub define_network {
my $self = shift;
my $xml = shift;
return Sys::Virt::Network->_new(connection => $self, xml => $xml, nocreate => 1);
}
=item my $dom = $vmm->create_storage_pool($xml);
Create a new storage pool based on the XML description passed into the C<$xml>
parameter. The returned object is an instance of the L<Sys::Virt::StoragePool>
class. This method is not available with unprivileged connections to
the VMM.
=cut
sub create_storage_pool {
my $self = shift;
my $xml = shift;
return Sys::Virt::StoragePool->_new(connection => $self, xml => $xml);
}
=item my $dom = $vmm->define_storage_pool($xml);
Defines, but does not start, a new storage pol based on the XML description
passed into the C<$xml> parameter. The returned object is an instance
of the L<Sys::Virt::StoragePool> class. This method is not available with
unprivileged connections to the VMM. The defined pool can be later started
by calling the C<create> method on the returned C<Sys::Virt::StoragePool>
object.
=cut
sub define_storage_pool {
my $self = shift;
my $xml = shift;
return Sys::Virt::StoragePool->_new(connection => $self, xml => $xml, nocreate => 1);
}
=item my $dom = $vmm->create_interface($xml);
Create a new interface based on the XML description passed into the C<$xml>
parameter. The returned object is an instance of the L<Sys::Virt::Interface>
class. This method is not available with unprivileged connections to
the VMM.
=cut
sub create_interface {
my $self = shift;
my $xml = shift;
return Sys::Virt::Interface->_new(connection => $self, xml => $xml);
}
=item my $dom = $vmm->define_interface($xml);
Defines, but does not start, a new interface based on the XML description
passed into the C<$xml> parameter. The returned object is an instance
of the L<Sys::Virt::Interface> class. This method is not available with
unprivileged connections to the VMM. The defined interface can be later started
by calling the C<create> method on the returned C<Sys::Virt::Interface>
object.
=cut
sub define_interface {
my $self = shift;
my $xml = shift;
return Sys::Virt::Interface->_new(connection => $self, xml => $xml, nocreate => 1);
}
=item my $dom = $vmm->create_node_device($xml);
Create a new virtual node device based on the XML description passed into the
C<$xml> parameter. The returned object is an instance of the L<Sys::Virt::NodeDevice>
class. This method is not available with unprivileged connections to
the VMM.
=cut
sub create_node_device {
my $self = shift;
my $xml = shift;
return Sys::Virt::NodeDevice->_new(connection => $self, xml => $xml);
}
=item my @doms = $vmm->list_domains()
Return a list of all running domains currently known to the VMM. The elements
in the returned list are instances of the L<Sys::Virt::Domain> class. This
method requires O(n) RPC calls, so the C<list_all_domains> method is
recommended as a more efficient alternative.
=cut
sub list_domains {
my $self = shift;
my $nids = $self->num_of_domains();
my @ids = $self->list_domain_ids($nids);
my @domains;
foreach my $id (@ids) {
eval {
push @domains, Sys::Virt::Domain->_new(connection => $self, id => $id);
};
if ($@) {
# nada - domain went away before we could look it up
};
}
return @domains;
}
=item my $nids = $vmm->num_of_domains()
Return the number of running domains known to the VMM. This can be
used as the C<maxids> parameter to C<list_domain_ids>.
=item my @domIDs = $vmm->list_domain_ids($maxids)
Return a list of all domain IDs currently known to the VMM. The IDs can
be used with the C<get_domain_by_id> method.
=item my @doms = $vmm->list_defined_domains()
Return a list of all domains defined, but not currently running, on the
VMM. The elements in the returned list are instances of the
L<Sys::Virt::Domain> class. This method requires O(n) RPC calls, so the
C<list_all_domains> method is recommended as a more efficient alternative.
=cut
sub list_defined_domains {
my $self = shift;
my $nnames = $self->num_of_defined_domains();
my @names = $self->list_defined_domain_names($nnames);
my @domains;
foreach my $name (@names) {
eval {
push @domains, Sys::Virt::Domain->_new(connection => $self, name => $name);
};
if ($@) {
# nada - domain went away before we could look it up
};
}
return @domains;
}
=item my $nnames = $vmm->num_of_defined_domains()
Return the number of running domains known to the VMM. This can be
used as the C<maxnames> parameter to C<list_defined_domain_names>.
=item my @names = $vmm->list_defined_domain_names($maxnames)
Return a list of names of all domains defined, but not currently running, on
the VMM. The names can be used with the C<get_domain_by_name> method.
=item my @doms = $vmm->list_all_domains($flags)
Return a list of all domains currently known to the VMM, whether
running or shutoff. The elements in the returned list are instances
of the L<Sys::Virt::Domain> class. The C<$flags> parameter can be
used to filter the list of returned domains.
=item my @nets = $vmm->list_networks()
Return a list of all networks currently known to the VMM. The elements
in the returned list are instances of the L<Sys::Virt::Network> class.
This method requires O(n) RPC calls, so the C<list_all_networks> method
is recommended as a more efficient alternative.
=cut
sub list_networks {
my $self = shift;
my $nnames = $self->num_of_networks();
my @names = $self->list_network_names($nnames);
my @networks;
foreach my $name (@names) {
eval {
push @networks, Sys::Virt::Network->_new(connection => $self, name => $name);
};
if ($@) {
# nada - network went away before we could look it up
};
}
return @networks;
}
=item my $nnames = $vmm->num_of_networks()
Return the number of running networks known to the VMM. This can be
used as the C<maxids> parameter to C<list_network_ids>.
=item my @netNames = $vmm->list_network_names($maxnames)
Return a list of all network names currently known to the VMM. The names can
be used with the C<get_network_by_name> method.
=item my @nets = $vmm->list_defined_networks()
Return a list of all networks defined, but not currently running, on the
VMM. The elements in the returned list are instances of the
L<Sys::Virt::Network> class. This method requires O(n) RPC calls, so the
C<list_all_networks> method is recommended as a more efficient alternative.
=cut
sub list_defined_networks {
my $self = shift;
my $nnames = $self->num_of_defined_networks();
my @names = $self->list_defined_network_names($nnames);
my @networks;
foreach my $name (@names) {
eval {
push @networks, Sys::Virt::Network->_new(connection => $self, name => $name);
};
if ($@) {
# nada - network went away before we could look it up
};
}
return @networks;
}
=item my $nnamess = $vmm->num_of_defined_networks()
Return the number of running networks known to the host. This can be
used as the C<maxnames> parameter to C<list_defined_network_names>.
=item my @names = $vmm->list_defined_network_names($maxnames)
Return a list of names of all networks defined, but not currently running, on
the host. The names can be used with the C<get_network_by_name> method.
=item my @nets = $vmm->list_all_networks($flags)
Return a list of all networks currently known to the VMM, whether
running or shutoff. The elements in the returned list are instances
of the L<Sys::Virt::Network> class. The C<$flags> parameter can be
used to filter the list of returned networks.
=item my @pools = $vmm->list_storage_pools()
Return a list of all storage pools currently known to the host. The elements
in the returned list are instances of the L<Sys::Virt::StoragePool> class.
This method requires O(n) RPC calls, so the C<list_all_storage_pools> method
is recommended as a more efficient alternative.
=cut
sub list_storage_pools {
my $self = shift;
my $nnames = $self->num_of_storage_pools();
my @names = $self->list_storage_pool_names($nnames);
my @pools;
foreach my $name (@names) {
eval {
push @pools, Sys::Virt::StoragePool->_new(connection => $self, name => $name);
};
if ($@) {
# nada - storage pool went away before we could look it up
};
}
return @pools;
}
=item my $nnames = $vmm->num_of_storage_pools()
Return the number of running storage pools known to the VMM. This can be
used as the C<maxids> parameter to C<list_storage_pool_names>.
=item my @poolNames = $vmm->list_storage_pool_names($maxnames)
Return a list of all storage pool names currently known to the VMM. The IDs can
be used with the C<get_network_by_id> method.
=item my @pools = $vmm->list_defined_storage_pools()
Return a list of all storage pools defined, but not currently running, on the
host. The elements in the returned list are instances of the
L<Sys::Virt::StoragePool> class. This method requires O(n) RPC calls, so the
C<list_all_storage_pools> method is recommended as a more efficient alternative.
=cut
sub list_defined_storage_pools {
my $self = shift;
my $nnames = $self->num_of_defined_storage_pools();
my @names = $self->list_defined_storage_pool_names($nnames);
my @pools;
foreach my $name (@names) {
eval {
push @pools, Sys::Virt::StoragePool->_new(connection => $self, name => $name);
};
if ($@) {
# nada - storage pool went away before we could look it up
};
}
return @pools;
}
=item my $nnames = $vmm->num_of_defined_storage_pools()
Return the number of running networks known to the host. This can be
used as the C<maxnames> parameter to C<list_defined_storage_pool_names>.
=item my @names = $vmm->list_defined_storage_pool_names($maxnames)
Return a list of names of all storage pools defined, but not currently running, on
the host. The names can be used with the C<get_storage_pool_by_name> method.
=item my @pools = $vmm->list_all_storage_pools($flags)
Return a list of all storage pools currently known to the VMM, whether
running or shutoff. The elements in the returned list are instances
of the L<Sys::Virt::StoragePool> class. The C<$flags> parameter can be
used to filter the list of returned pools.
=item my @devs = $vmm->list_node_devices($capability)
Return a list of all devices currently known to the host OS. The elements
in the returned list are instances of the L<Sys::Virt::NodeDevice> class.
The optional C<capability> parameter allows the list to be restricted to
only devices with a particular capability type. This method requires O(n)
RPC calls, so the C<list_all_node_devices> method is recommended as a
more efficient alternative.
=cut
sub list_node_devices {
my $self = shift;
my $cap = shift;
my $nnames = $self->num_of_node_devices($cap);
my @names = $self->list_node_device_names($cap, $nnames);
my @devs;
foreach my $name (@names) {
eval {
push @devs, Sys::Virt::NodeDevice->_new(connection => $self, name => $name);
};
if ($@) {
# nada - device went away before we could look it up
};
}
return @devs;
}
=item my $nnames = $vmm->num_of_node_devices($capability[, $flags])
Return the number of host devices known to the VMM. This can be
used as the C<maxids> parameter to C<list_node_device_names>.
The C<capability> parameter allows the list to be restricted to
only devices with a particular capability type, and should be left
as C<undef> if the full list is required. The optional <flags>
parameter is currently unused and defaults to 0 if omitted.
=item my @netNames = $vmm->list_node_device_names($capability, $maxnames[, $flags])
Return a list of all host device names currently known to the VMM. The names can
be used with the C<get_node_device_by_name> method.
The C<capability> parameter allows the list to be restricted to
only devices with a particular capability type, and should be left
as C<undef> if the full list is required. The optional <flags>
parameter is currently unused and defaults to 0 if omitted.
=item my @devs = $vmm->list_all_node_devices($flags)
Return a list of all node devices currently known to the VMM. The
elements in the returned list are instances of the
L<Sys::Virt::NodeDevice> class. The C<$flags> parameter can be
used to filter the list of returned devices.
=item my @ifaces = $vmm->list_interfaces()
Return a list of all network interfaces currently known to the VMM. The elements
in the returned list are instances of the L<Sys::Virt::Interface> class.
This method requires O(n) RPC calls, so the C<list_all_interfaces> method is
recommended as a more efficient alternative.
=cut
sub list_interfaces {
my $self = shift;
my $nnames = $self->num_of_interfaces();
my @names = $self->list_interface_names($nnames);
my @interfaces;
foreach my $name (@names) {
eval {
push @interfaces, Sys::Virt::Interface->_new(connection => $self, name => $name);
};
if ($@) {
# nada - interface went away before we could look it up
};
}
return @interfaces;
}
=item my $nnames = $vmm->num_of_interfaces()
Return the number of running interfaces known to the VMM. This can be
used as the C<maxnames> parameter to C<list_interface_names>.
=item my @names = $vmm->list_interface_names($maxnames)
Return a list of all interface names currently known to the VMM. The names can
be used with the C<get_interface_by_name> method.
=item my @ifaces = $vmm->list_defined_interfaces()
Return a list of all network interfaces currently known to the VMM. The elements
in the returned list are instances of the L<Sys::Virt::Interface> class.
This method requires O(n) RPC calls, so the C<list_all_interfaces> method is
recommended as a more efficient alternative.
=cut
sub list_defined_interfaces {
my $self = shift;
my $nnames = $self->num_of_defined_interfaces();
my @names = $self->list_defined_interface_names($nnames);
my @interfaces;
foreach my $name (@names) {
eval {
push @interfaces, Sys::Virt::Interface->_new(connection => $self, name => $name);
};
if ($@) {
# nada - interface went away before we could look it up
};
}
return @interfaces;
}
=item my $nnames = $vmm->num_of_defined_interfaces()
Return the number of inactive interfaces known to the VMM. This can be
used as the C<maxnames> parameter to C<list_defined_interface_names>.
=item my @names = $vmm->list_defined_interface_names($maxnames)
Return a list of inactive interface names currently known to the VMM. The names can
be used with the C<get_interface_by_name> method.
=item my @ifaces = $vmm->list_all_interfaces($flags)
Return a list of all interfaces currently known to the VMM, whether
running or shutoff. The elements in the returned list are instances
of the L<Sys::Virt::Interface> class. The C<$flags> parameter can be
used to filter the list of returned interfaces.
=item my @ifaces = $vmm->list_secrets()
Return a list of all secrets currently known to the VMM. The elements
in the returned list are instances of the L<Sys::Virt::Secret> class.
This method requires O(n) RPC calls, so the C<list_all_secrets> method
is recommended as a more efficient alternative.
=cut
sub list_secrets {
my $self = shift;
my $nuuids = $self->num_of_secrets();
my @uuids = $self->list_secret_uuids($nuuids);
my @secrets;
foreach my $uuid (@uuids) {
eval {
push @secrets, Sys::Virt::Secret->_new(connection => $self, uuid => $uuid);
};
if ($@) {
# nada - secret went away before we could look it up
};
}
return @secrets;
}
=item my $nuuids = $vmm->num_of_secrets()
Return the number of secrets known to the VMM. This can be
used as the C<maxuuids> parameter to C<list_secrets>.
=item my @uuids = $vmm->list_secret_uuids($maxuuids)
Return a list of all secret uuids currently known to the VMM. The uuids can
be used with the C<get_secret_by_uuid> method.
=item my @secrets = $vmm->list_all_secrets($flags)
Return a list of all secrets currently known to the VMM. The elements
in the returned list are instances of the L<Sys::Virt::Network> class.
The C<$flags> parameter can be used to filter the list of returned
secrets.
=item my @nets = $vmm->list_nwfilters()
Return a list of all nwfilters currently known to the VMM. The elements
in the returned list are instances of the L<Sys::Virt::NWFilter> class.
This method requires O(n) RPC calls, so the C<list_all_nwfilters> method
is recommended as a more efficient alternative.
=cut
sub list_nwfilters {
my $self = shift;
my $nnames = $self->num_of_nwfilters();
my @names = $self->list_nwfilter_names($nnames);
my @nwfilters;
foreach my $name (@names) {
eval {
push @nwfilters, Sys::Virt::NWFilter->_new(connection => $self, name => $name);
};
if ($@) {
# nada - nwfilter went away before we could look it up
};
}
return @nwfilters;
}
=item my $nnames = $vmm->num_of_nwfilters()
Return the number of running nwfilters known to the VMM. This can be
used as the C<maxids> parameter to C<list_nwfilter_names>.
=item my @filterNames = $vmm->list_nwfilter_names($maxnames)
Return a list of all nwfilter names currently known to the VMM. The names can
be used with the C<get_nwfilter_by_name> method.
=item my @nwfilters = $vmm->list_all_nwfilters($flags)
Return a list of all nwfilters currently known to the VMM. The elements
in the returned list are instances of the L<Sys::Virt::NWFilter> class.
The C<$flags> parameter is currently unused and defaults to zero.
=item $vmm->define_save_image_xml($file, $dxml, $flags=0)
Update the XML associated with a virtual machine's save image. The C<$file>
parameter is the fully qualified path to the save image XML, while C<$dxml>
is the new XML document to write. The C<$flags> parameter is currently
unused and defaults to zero.
=item $xml = $vmm->get_save_image_xml_description($file, $flags=1)
Retrieve the current XML configuration associated with the virtual
machine's save image identified by C<$file>. The C<$flags> parameter is currently
unused and defaults to zero.
=item my $dom = $vmm->get_domain_by_name($name)
Return the domain with a name of C<$name>. The returned object is
an instance of the L<Sys::Virt::Domain> class.
=cut
sub get_domain_by_name {
my $self = shift;
my $name = shift;
return Sys::Virt::Domain->_new(connection => $self, name => $name);
}
=item my $dom = $vmm->get_domain_by_id($id)
Return the domain with a local id of C<$id>. The returned object is
an instance of the L<Sys::Virt::Domain> class.
=cut
sub get_domain_by_id {
my $self = shift;
my $id = shift;
return Sys::Virt::Domain->_new(connection => $self, id => $id);
}
=item my $dom = $vmm->get_domain_by_uuid($uuid)
Return the domain with a globally unique id of C<$uuid>. The returned object is
an instance of the L<Sys::Virt::Domain> class.
=cut
sub get_domain_by_uuid {
my $self = shift;
my $uuid = shift;
return Sys::Virt::Domain->_new(connection => $self, uuid => $uuid);
}
=item my $net = $vmm->get_network_by_name($name)
Return the network with a name of C<$name>. The returned object is
an instance of the L<Sys::Virt::Network> class.
=cut
sub get_network_by_name {
my $self = shift;
my $name = shift;
return Sys::Virt::Network->_new(connection => $self, name => $name);
}
=item my $net = $vmm->get_network_by_uuid($uuid)
Return the network with a globally unique id of C<$uuid>. The returned object is
an instance of the L<Sys::Virt::Network> class.
=cut
sub get_network_by_uuid {
my $self = shift;
my $uuid = shift;
return Sys::Virt::Network->_new(connection => $self, uuid => $uuid);
}
=item my $pool = $vmm->get_storage_pool_by_name($name)
Return the storage pool with a name of C<$name>. The returned object is
an instance of the L<Sys::Virt::StoragePool> class.
=cut
sub get_storage_pool_by_name {
my $self = shift;
my $name = shift;
return Sys::Virt::StoragePool->_new(connection => $self, name => $name);
}
=item my $pool = $vmm->get_storage_pool_by_uuid($uuid)
Return the storage pool with a globally unique id of C<$uuid>. The returned object is
an instance of the L<Sys::Virt::StoragePool> class.
=cut
sub get_storage_pool_by_uuid {
my $self = shift;
my $uuid = shift;
return Sys::Virt::StoragePool->_new(connection => $self, uuid => $uuid);
}
=item my $pool = $vmm->get_storage_pool_by_volume($vol)
Return the storage pool with a storage volume C<$vol>. The C<$vol> parameter
must be an instance of the L<Sys::Virt::StorageVol> class. The returned object is
an instance of the L<Sys::Virt::StoragePool> class.
=cut
sub get_storage_pool_by_volume {
my $self = shift;
my $volume = shift;
return Sys::Virt::StoragePool->_new(connection => $self, volume => $volume);
}
=item my $vol = $vmm->get_storage_volume_by_path($path)
Return the storage volume with a location of C<$path>. The returned object is
an instance of the L<Sys::Virt::StorageVol> class.
=cut
sub get_storage_volume_by_path {
my $self = shift;
my $path = shift;
return Sys::Virt::StorageVol->_new(connection => $self, path => $path);
}
=item my $vol = $vmm->get_storage_volume_by_key($key)
Return the storage volume with a globally unique id of C<$key>. The returned object is
an instance of the L<Sys::Virt::StorageVol> class.
=cut
sub get_storage_volume_by_key {
my $self = shift;
my $key = shift;
return Sys::Virt::StorageVol->_new(connection => $self, key => $key);
}
=item my $dev = $vmm->get_node_device_by_name($name)
Return the node device with a name of C<$name>. The returned object is
an instance of the L<Sys::Virt::NodeDevice> class.
=cut
sub get_node_device_by_name {
my $self = shift;
my $name = shift;
return Sys::Virt::NodeDevice->_new(connection => $self, name => $name);
}
=item my $dev = $vmm->get_node_device_scsihost_by_wwn($wwnn, $wwpn, $flags=0)
Return the node device which is a SCSI host identified by C<$wwnn> and C<$wwpn>.
The C<$flags> parameter is unused and defaults to zero. The returned object is
an instance of the L<Sys::Virt::NodeDevice> class.
=cut
sub get_node_device_scsihost_by_wwn {
my $self = shift;
my $wwnn = shift;
my $wwpn = shift;
return Sys::Virt::NodeDevice->_new(connection => $self,
wwnn => $wwnn,
wwpn => $wwpn);
}
=item my $iface = $vmm->get_interface_by_name($name)
Return the interface with a name of C<$name>. The returned object is
an instance of the L<Sys::Virt::Interface> class.
=cut
sub get_interface_by_name {
my $self = shift;
my $name = shift;
return Sys::Virt::Interface->_new(connection => $self, name => $name);
}
=item my $iface = $vmm->get_interface_by_mac($mac)
Return the interface with a MAC address of C<$mac>. The returned object is
an instance of the L<Sys::Virt::Interface> class.
=cut
sub get_interface_by_mac {
my $self = shift;
my $mac = shift;
return Sys::Virt::Interface->_new(connection => $self, mac => $mac);
}
=item my $sec = $vmm->get_secret_by_uuid($uuid)
Return the secret with a globally unique id of C<$uuid>. The returned object is
an instance of the L<Sys::Virt::Secret> class.
=cut
sub get_secret_by_uuid {
my $self = shift;
my $uuid = shift;
return Sys::Virt::Secret->_new(connection => $self, uuid => $uuid);
}
=item my $sec = $vmm->get_secret_by_usage($usageType, $usageID)
Return the secret with a usage type of C<$usageType>, identified
by C<$usageID>. The returned object is an instance of the
L<Sys::Virt::Secret> class.
=cut
sub get_secret_by_usage {
my $self = shift;
my $type = shift;
my $id = shift;
return Sys::Virt::Secret->_new(connection => $self,
usageType => $type,
usageID => $id);
}
=item my $dom = $vmm->get_nwfilter_by_name($name)
Return the domain with a name of C<$name>. The returned object is
an instance of the L<Sys::Virt::NWFilter> class.
=cut
sub get_nwfilter_by_name {
my $self = shift;
my $name = shift;
return Sys::Virt::NWFilter->_new(connection => $self, name => $name);
}
=item my $dom = $vmm->get_nwfilter_by_uuid($uuid)
Return the nwfilter with a globally unique id of C<$uuid>. The returned object is
an instance of the L<Sys::Virt::NWFilter> class.
=cut
sub get_nwfilter_by_uuid {
my $self = shift;
my $uuid = shift;
return Sys::Virt::NWFilter->_new(connection => $self, uuid => $uuid);
}
=item my $xml = $vmm->find_storage_pool_sources($type, $srcspec[, $flags])
Probe for available storage pool sources for the pool of type C<$type>.
The C<$srcspec> parameter can be C<undef>, or a parameter to refine the
discovery process, for example a server hostname for NFS discovery. The
C<$flags> parameter is optional, and if omitted defaults to zero. The
returned scalar is an XML document describing the discovered storage
pool sources.
=item $vmm->interface_change_begin($flags)
Begin a transaction for changing the configuration of one or more
network interfaces
=item $vmm->interface_change_commit($flags)
Complete a transaction for changing the configuration of one or more
network interfaces
=item $vmm->interface_change_rollback($flags)
Abort a transaction for changing the configuration of one or more
network interfaces
=item $vmm->restore_domain($savefile)
Recreate a domain from the saved state file given in the C<$savefile> parameter.
=item $vmm->get_max_vcpus($domtype)
Return the maximum number of vcpus that can be configured for a domain
of type C<$domtype>
=item my $hostname = $vmm->get_hostname()
Return the name of the host with which this connection is associated.
=item my $uri = $vmm->get_uri()
Return the URI associated with the open connection. This may be different
from the URI used when initially connecting to libvirt, when 'auto-probing'
or drivers occurrs.
=item my $xml = $vmm->get_sysinfo()
Return an XML documenting representing the host system information,
typically obtained from SMBIOS tables.
=item my $type = $vmm->get_type()
Return the type of virtualization backend accessed by this VMM object. Currently
the only supported type is C<Xen>.
=item my $xml = $vmm->domain_xml_from_native($format, $config);
Convert the native hypervisor configuration C<$config> which is in format
<$format> into libvirrt domain XML. Valid values of C<$format> vary between
hypervisor drivers.
=item my $config = $vmm->domain_xml_to_native($format, $xml)
Convert the libvirt domain XML configuration C<$xml> to a native hypervisor
configuration in format C<$format>
=item my $ver = $vmm->get_version()
Return the complete version number as a string encoded in the
formula C<(major * 1000000) + (minor * 1000) + micro>.
=item my $ver = $vmm->get_major_version
Return the major version number of the libvirt library.
=cut
sub get_major_version {
my $self = shift;
my $ver = $self->get_version;
return ($ver - ($ver % 1000000))/1000000;
}
=item my $ver = $vmm->get_minor_version
Return the minor version number of the libvirt library.
=cut
sub get_minor_version {
my $self = shift;
my $ver = $self->get_version;
my $mver = $ver % 1000000;
return ($mver - ($mver % 1000)) / 1000;
}
=item my $ver = $vmm->get_micro_version
Return the micro version number of the libvirt library.
=cut
sub get_micro_version {
my $self = shift;
return $self->get_version % 1000;
}
sub get_version {
my $self = shift;
if (defined $self) {
return $self->_get_conn_version;
} else {
return &Sys::Virt::_get_library_version();
}
}
=item my $ver = $vmm->get_library_version
Return the version number of the API associated with
the active connection. This differs from C<get_version>
in that if the connection is to a remote libvirtd
daemon, it will return the API version of the remote
libvirt, rather than the local client.
=cut
sub get_library_version {
my $self = shift;
return $self->_get_conn_library_version;
}
1;
=pod
=item $conn->is_secure()
Returns a true value if the current connection is secure against
network interception. This implies either use of UNIX sockets,
or encryption with a TCP stream.
=item $conn->is_encrypted()
Returns a true value if the current connection data stream is
encrypted.
=item $conn->is_alive()
Returns a true value if the connection is alive, as determined
by keep-alive packets or other recent RPC traffic.
=item $conn->set_keep_alive($interval, $count)
Change the operation of the keep alive protocol to send C<$count>
packets spaced C<$interval> seconds apart before considering the
connection dead.
=item my $info = $con->get_node_info()
Returns a hash reference summarising the capabilities of the host
node. The elements of the hash are as follows:
=over 4
=item memory
The amount of physical memory in the host
=item model
The model of the CPU, eg x86_64
=item cpus
The total number of logical CPUs.
=item mhz
The peak MHZ of the CPU
=item nodes
The number of NUMA cells
=item sockets
The number of CPU sockets
=item cores
The number of cores per socket
=item threads
The number of threads per core
=back
NB, more accurate information about the total number of CPUs
and those online can be obtained using the C<get_node_cpu_map>
method.
=item my ($totcpus, $onlinemap, $totonline) = $con->get_node_cpu_map();
Returns an array containing information about the CPUs available
on the host. The first element, C<totcpus>, specifies the total
number of CPUs available to the host regardles of their online
stat. The second element, C<onlinemap>, provides a bitmap detailing
which CPUs are currently online. The third element, C<totonline>,
specifies the total number of online CPUs. The values in the bitmap
can be extracted using the C<unpack> method as follows:
my @onlinemap = split(//, unpack("b*", $onlinemap));
=item my $info = $con->get_node_cpu_stats($cpuNum=-1, $flags=0)
Returns a hash reference providing information about the host
CPU statistics. If <$cpuNum> is omitted, it defaults to C<Sys::Virt::NODE_CPU_STATS_ALL_CPUS>
which causes it to return cummulative information for all
CPUs in the host. If C<$cpuNum> is zero or larger, it returns
information just for the specified number. The C<$flags>
parameter is currently unused and defaults to zero. The
fields in the returned hash reference are
=over 4
=item kernel
The time spent in kernelspace
=item user
The time spent in userspace
=item idle
The idle time
=item iowait
The I/O wait time
=item utilization
The overall percentage utilization.
=back
=item my $info = $con->get_node_memory_stats($cellNum=-1, $flags=0)
Returns a hash reference providing information about the host
memory statistics. If <$cellNum> is omitted, it defaults to C<Sys::Virt::NODE_MEMORY_STATS_ALL_CELLS>
which causes it to return cummulative information for all
NUMA cells in the host. If C<$cellNum> is zero or larger, it
returns information just for the specified number. The C<$flags>
parameter is currently unused and defaults to zero. The
fields in the returned hash reference are
=over 4
=item total
The total memory
=item free
The free memory
=item buffers
The memory consumed by buffers
=item cached
The memory consumed for cache
=back
=item my $params = $conn->get_node_memory_parameters($flags=0)
Return a hash reference containing the set of memory tunable
parameters for the node. The keys in the hash are one of the
constants MEMORY PARAMETERS described later. The C<$flags>
parameter is currently unused, and defaults to 0 if omitted.
=item $conn->set_node_memory_parameters($params, $flags=0)
Update the memory tunable parameters for the node. The
C<$params> should be a hash reference whose keys are one
of the MEMORY PARAMETERS constants. The C<$flags>
parameter is currently unused, and defaults to 0 if omitted.
=item $conn->node_suspend_for_duration($target, $duration, $flags=0)
Suspend the the host, using mode C<$target> which is one of the NODE
SUSPEND constants listed later. The C<$duration> parameter controls
how long the node is suspended for before waking up.
=item $conn->domain_event_register($callback)
Register a callback to received notificaitons of domain state change
events. Only a single callback can be registered with each connection
instance. The callback will be invoked with four parameters, an
instance of C<Sys::Virt> for the connection, an instance of C<Sys::Virt::Domain>
for the domain changing state, and a C<event> and C<detail> arguments,
corresponding to the event constants defined in the C<Sys::Virt::Domain>
module. Before discarding the connection object, the callback must be
deregistered, otherwise the connection object memory will never be
released in garbage collection.
=item $conn->domain_event_deregister()
Unregister a callback, allowing the connection object to be garbage
collected.
=item $callback = $conn->domain_event_register_any($dom, $eventID, $callback)
Register a callback to received notifications of domain events.
The C<$dom> parameter can be C<undef> to request events on all
known domains, or a specific C<Sys::Virt::Domain> object to
filter events. The C<$eventID> parameter is one of the EVENT ID
constants described later in this document. The C<$callback> is
a subroutine reference that will receive the events.
All callbacks receive a C<Sys::Virt> connection as the first parameter
and a C<Sys::Virt::Domain> object indiciating the domain on which the
event occurred as the second parameter. Subsequent parameters vary
according to the event type
=over
=item EVENT_ID_LIFECYCLE
Extra C<event> and C<detail> parameters defining the lifecycle
transition that occurred.
=item EVENT_ID_REBOOT
No extra parameters
=item EVENT_ID_RTC_CHANGE
The C<utcoffset> gives the offset from UTC in seconds
=item EVENT_ID_WATCHDOG
The C<action> defines the action that is taken as a result
of the watchdog triggering. One of the WATCHDOG constants
described later
=item EVENT_ID_IO_ERROR
The C<srcPath> is the file on the host which had the error.
The C<devAlias> is the unique device alias from the guest
configuration associated with C<srcPath>. The C<action> is
the action taken as a result of the error, one of the
IO ERROR constants described later
=item EVENT_ID_GRAPHICS
The C<phase> is the stage of the connection, one of the GRAPHICS
PHASE constants described later. The C<local> and C<remote>
parameters follow with the details of the local and remote
network addresses. The C<authScheme> describes how the user
was authenticated (if at all). Finally C<identities> is an
array ref containing authenticated identities for the user,
if any.
=back
The return value is a unique callback ID that must be used when
unregistering the event.
=item $conn->domain_event_deregister_any($callbackID)
Unregister a callback, associated with the C<$callbackID> previously
obtained from C<domain_event_register_any>.
=item $callback = $conn->network_event_register_any($dom, $eventID, $callback)
Register a callback to received notifications of network events.
The C<$dom> parameter can be C<undef> to request events on all
known networks, or a specific C<Sys::Virt::Network> object to
filter events. The C<$eventID> parameter is one of the EVENT ID
constants described later in this document. The C<$callback> is
a subroutine reference that will receive the events.
All callbacks receive a C<Sys::Virt> connection as the first parameter
and a C<Sys::Virt::Network> object indiciating the network on which the
event occurred as the second parameter. Subsequent parameters vary
according to the event type
=over
=item EVENT_ID_LIFECYCLE
Extra C<event> and C<detail> parameters defining the lifecycle
transition that occurred.
=back
The return value is a unique callback ID that must be used when
unregistering the event.
=item $conn->network_event_deregister_any($callbackID)
Unregister a callback, associated with the C<$callbackID> previously
obtained from C<network_event_register_any>.
=item $conn->register_close_callback($coderef);
Register a callback to be invoked when the connection is closed.
The callback will be invoked with two parameters, the C<$conn>
it was registered against, and the reason for the close event.
The reason value will be one of the C<CLOSE REASON CONSTANTS>
listed later in this document.
=item $conn->unregister_close_callback();
Remove the previously registered close callback.
=item my $xml = $con->baseline_cpu(\@xml, $flags=0)
Given an array ref whose elements are XML documents describing host CPUs,
compute the baseline CPU model that is operable across all hosts. The
XML for the baseline CPU model is returned. The optional C<$flags>
parameter can take one of
=over 4
=item Sys::Virt::BASELINE_CPU_EXPAND_FEATURES
Expand the CPU definition to list all feature flags, even those
implied by the model name.
=back
=item @names = $con->get_cpu_model_names($arch, $flags=0)
Get a list of valid CPU models names for the architecture
given by C<$arch>. The C<$arch> value should be one of the
architectures listed in the capabilities XML document.
The C<$flags> parameter is currently unused and defaults
to 0.
=item my $info = $con->get_node_security_model()
Returns a hash reference summarising the security model of the
host node. There are two keys in the hash, C<model> specifying
the name of the security model (eg 'selinux') and C<doi>
specifying the 'domain of interpretation' for security labels.
=item my $xml = $con->get_capabilities();
Returns an XML document describing the hypervisor capabilities
=item my $result = $con->compare_cpu($xml, $flags=0);
Checks whether the CPU definition in C<$xml> is compatible with the
current hypervisor connection. This can be used to determine whether
it is safe to migrate a guest to this host. The returned result is
one of the constants listed later
=item $mem = $con->get_node_free_memory();
Returns the current free memory on the host
=item @mem = $con->get_node_cells_free_memory($start, $end);
Returns the free memory on each NUMA cell between C<$start> and C<$end>.
=back
=head1 CONSTANTS
The following sets of constants are useful when dealing with APIs
in this package
=head2 CONNECTION
When opening a connection the following constants can be used:
=over 4
=item Sys::Virt::CONNECT_RO
Request a read-only connection
=item Sys::Virt::CONNECT_NO_ALIASES
Prevent the resolution of URI aliases
=back
=head2 CREDENTIAL TYPES
When providing authentication callbacks, the following constants
indicate the type of credential being requested
=over 4
=item Sys::Virt::CRED_AUTHNAME
Identity to act as
=item Sys::Virt::CRED_USERNAME
Identity to authorize as
=item Sys::Virt::CRED_CNONCE
Client supplies a nonce
=item Sys::Virt::CRED_REALM
Authentication realm
=item Sys::Virt::CRED_ECHOPROMPT
Challenge response non-secret
=item Sys::Virt::CRED_NOECHOPROMPT
Challenge response secret
=item Sys::Virt::CRED_PASSPHRASE
Passphrase secret
=item Sys::Virt::CRED_LANGUAGE
RFC 1766 language code
=item Sys::Virt::CRED_EXTERNAL
Externally provided credential
=back
=head2 CPU COMPARISON CONSTANTS
=over 4
=item Sys::Virt::CPU_COMPARE_INCOMPATIBLE
This host is missing one or more CPU features in the CPU
description
=item Sys::Virt::CPU_COMPARE_IDENTICAL
The host has an identical CPU description
=item Sys::Virt::CPU_COMPARE_SUPERSET
The host offers a superset of the CPU descriptoon
=back
=head2 NODE SUSPEND CONSTANTS
=over 4
=item Sys::Virt::NODE_SUSPEND_TARGET_MEM
Suspends to memory (equivalent of S3 on x86 architectures)
=item Sys::Virt::NODE_SUSPEND_TARGET_DISK
Suspends to disk (equivalent of S5 on x86 architectures)
=item Sys::Virt::NODE_SUSPEND_TARGET_HYBRID
Suspends to memory and disk (equivalent of S3+S5 on x86 architectures)
=back
=head2 NODE VCPU CONSTANTS
=over 4
=item Sys::Virt::NODE_CPU_STATS_ALL_CPUS
Request statistics for all CPUs
=back
=head2 NODE MEMORY CONSTANTS
=over 4
=item Sys::Virt::NODE_MEMORY_STATS_ALL_CELLS
Request statistics for all memory cells
=back
=head2 MEMORY PARAMETERS
The following constants are used to name memory
parameters of the node
=over 4
=item Sys::Virt::NODE_MEMORY_SHARED_FULL_SCANS
How many times all mergeable areas have been scanned.
=item Sys::Virt::NODE_MEMORY_SHARED_PAGES_SHARED
How many the shared memory pages are being used.
=item Sys::Virt::NODE_MEMORY_SHARED_PAGES_SHARING
How many sites are sharing the pages
=item Sys::Virt::NODE_MEMORY_SHARED_PAGES_TO_SCAN
How many present pages to scan before the shared memory service goes to sleep
=item Sys::Virt::NODE_MEMORY_SHARED_PAGES_UNSHARED
How many pages unique but repeatedly checked for merging.
=item Sys::Virt::NODE_MEMORY_SHARED_PAGES_VOLATILE
How many pages changing too fast to be placed in a tree.
=item Sys::Virt::NODE_MEMORY_SHARED_SLEEP_MILLISECS
How many milliseconds the shared memory service should sleep before next scan.
=back
=head2 CLOSE REASON CONSTANTS
The following constants related to the connection close callback,
describe the reason for the closing of the connection.
=over 4
=item Sys::Virt::CLOSE_REASON_CLIENT
The client application requested the connection be closed
=item Sys::Virt::CLOSE_REASON_EOF
End-of-file was encountered reading data from the connection
=item Sys::Virt::CLOSE_REASON_ERROR
An I/O error was encountered reading/writing data from/to the
connection
=item Sys::Virt::CLOSE_REASON_KEEPALIVE
The connection keepalive timer triggered due to lack of response
from the server
=back
=head2 CPU STATS CONSTANTS
The following constants provide the names of known CPU stats fields
=over 4
=item Sys::Virt::NODE_CPU_STATS_IDLE
Time spent idle
=item Sys::Virt::NODE_CPU_STATS_IOWAIT
Time spent waiting for I/O to complete
=item Sys::Virt::NODE_CPU_STATS_KERNEL
Time spent executing kernel code
=item Sys::Virt::NODE_CPU_STATS_USER
Time spent executing user code
=item Sys::Virt::NODE_CPU_STATS_UTILIZATION
Percentage utilization of the CPU.
=back
=head2 MEMORY STAS CONSTANTS
The following constants provide the names of known memory stats fields
=over 4
=item Sys::Virt::NODE_MEMORY_STATS_BUFFERS
The amount of memory consumed by I/O buffers
=item Sys::Virt::NODE_MEMORY_STATS_CACHED
The amount of memory consumed by disk cache
=item Sys::Virt::NODE_MEMORY_STATS_FREE
The amount of free memory
=item Sys::Virt::NODE_MEMORY_STATS_TOTAL
The total amount of memory
=back
=head1 BUGS
Hopefully none, but the XS code needs to be audited to ensure it
is not leaking memory.
=head1 AUTHORS
Daniel P. Berrange <berrange@redhat.com>
=head1 COPYRIGHT
Copyright (C) 2006-2009 Red Hat
Copyright (C) 2006-2009 Daniel P. Berrange
=head1 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.
=head1 SEE ALSO
L<Sys::Virt::Domain>, L<Sys::Virt::Network>, L<Sys::Virt::StoragePool>,
L<Sys::Virt::StorageVol>, L<Sys::Virt::Error>, C<http://libvirt.org>
=cut
|