/usr/share/fusioninventory/lib/FusionInventory/Agent/Inventory.pm is in fusioninventory-agent 1:2.3.10.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 | package FusionInventory::Agent::Inventory;
use strict;
use warnings;
use Config;
use Data::Dumper;
use Digest::MD5 qw(md5_base64);
use English qw(-no_match_vars);
use XML::TreePP;
use FusionInventory::Agent::Tools;
my %fields = (
ANTIVIRUS => [ qw/COMPANY NAME GUID ENABLED UPTODATE VERSION/ ],
BATTERIES => [ qw/CAPACITY CHEMISTRY DATE NAME SERIAL MANUFACTURER
VOLTAGE/ ],
CONTROLLERS => [ qw/CAPTION DRIVER NAME MANUFACTURER PCICLASS VENDORID
PRODUCTID PCISUBSYSTEMID PCISLOT TYPE REV/ ],
CPUS => [ qw/CACHE CORE DESCRIPTION MANUFACTURER NAME THREAD SERIAL
STEPPING FAMILYNAME FAMILYNUMBER MODEL SPEED ID EXTERNAL_CLOCK ARCH/ ],
DRIVES => [ qw/CREATEDATE DESCRIPTION FREE FILESYSTEM LABEL LETTER
SERIAL SYSTEMDRIVE TOTAL TYPE VOLUMN/ ],
ENVS => [ qw/KEY VAL/ ],
INPUTS => [ qw/NAME MANUFACTURER CAPTION DESCRIPTION INTERFACE LAYOUT
POINTINGTYPE TYPE/ ],
MEMORIES => [qw/CAPACITY CAPTION FORMFACTOR REMOVABLE PURPOSE SPEED
SERIALNUMBER TYPE DESCRIPTION NUMSLOTS MEMORYCORRECTION
MANUFACTURER/ ],
MODEMS => [ qw/DESCRIPTION NAME/ ],
MONITORS => [ qw/BASE64 CAPTION DESCRIPTION MANUFACTURER SERIAL
UUENCODE/ ],
NETWORKS => [ qw/BSSID DESCRIPTION DRIVER FIRMWARE IPADDRESS IPADDRESS6
IPDHCP IPGATEWAY IPMASK IPMASK6 IPSUBNET IPSUBNET6
MANAGEMENT MANUFACTURER MACADDR MODEL MTU PCISLOT
PNPDEVICEID STATUS SLAVES SPEED SSID TYPE VIRTUALDEV
WWN/ ],
PORTS => [ qw/CAPTION DESCRIPTION NAME TYPE/ ],
PROCESSES => [ qw/USER PID CPUUSAGE MEM VIRTUALMEMORY TTY STARTED CMD/ ],
REGISTRY => [ qw/NAME REGVALUE HIVE/ ],
RUDDER => [ qw/AGENT UUID HOSTNAME/ ],
SLOTS => [ qw/DESCRIPTION DESIGNATION NAME STATUS/ ],
SOFTWARES => [ qw/COMMENTS FILESIZE FOLDER FROM HELPLINK INSTALLDATE NAME
NO_REMOVE RELEASE_TYPE PUBLISHER UNINSTALL_STRING
URL_INFO_ABOUT VERSION VERSION_MINOR VERSION_MAJOR
GUID ARCH USERNAME USERID/ ],
SOUNDS => [ qw/CAPTION DESCRIPTION MANUFACTURER NAME/ ],
STORAGES => [ qw/DESCRIPTION DISKSIZE INTERFACE MANUFACTURER MODEL NAME
TYPE SERIAL SERIALNUMBER FIRMWARE SCSI_COID SCSI_CHID
SCSI_UNID SCSI_LUN WWN/ ],
VIDEOS => [ qw/CHIPSET MEMORY NAME RESOLUTION PCISLOT/ ],
USBDEVICES => [ qw/VENDORID PRODUCTID MANUFACTURER CAPTION SERIAL CLASS
SUBCLASS NAME/ ],
USERS => [ qw/LOGIN DOMAIN/ ],
LOCAL_USERS => [ qw/LOGIN ID NAME HOME SHELL/ ],
LOCAL_GROUPS => [ qw/NAME ID MEMBER/ ],
PRINTERS => [ qw/COMMENT DESCRIPTION DRIVER NAME NETWORK PORT RESOLUTION
SHARED STATUS ERRSTATUS SERVERNAME SHARENAME
PRINTPROCESSOR SERIAL/ ],
BIOS => [ qw/SMODEL SMANUFACTURER SSN BDATE BVERSION
BMANUFACTURER MMANUFACTURER MSN MMODEL ASSETTAG
ENCLOSURESERIAL BIOSSERIAL
TYPE SKUNUMBER/ ],
HARDWARE => [ qw/USERID OSVERSION PROCESSORN OSCOMMENTS CHECKSUM
PROCESSORT NAME PROCESSORS SWAP ETIME TYPE OSNAME
IPADDR WORKGROUP DESCRIPTION MEMORY UUID VMID DNS
LASTLOGGEDUSER USERDOMAIN DATELASTLOGGEDUSER
DEFAULTGATEWAY VMSYSTEM WINOWNER WINPRODID
WINPRODKEY WINCOMPANY WINLANG CHASSIS_TYPE VMID
VMNAME VMHOSTSERIAL/ ],
OPERATINGSYSTEM => [ qw/KERNEL_NAME KERNEL_VERSION NAME VERSION FULL_NAME
SERVICE_PACK INSTALL_DATE FQDN DNS_DOMAIN
SSH_KEY ARCH BOOT_TIME/ ],
ACCESSLOG => [ qw/USERID LOGDATE/ ],
VIRTUALMACHINES => [ qw/MEMORY NAME UUID STATUS SUBSYSTEM VMTYPE VCPU
VMID MAC COMMENT OWNER SERIAL/ ],
LOGICAL_VOLUMES => [ qw/LV_NAME VGN_AME ATTR SIZE LV_UUID SEG_COUNT
VG_UUID/ ],
PHYSICAL_VOLUMES => [ qw/DEVICE PV_PE_COUNT PV_UUID FORMAT ATTR
SIZE FREE PE_SIZE VG_UUID/ ],
VOLUME_GROUPS => [ qw/VG_NAME PV_COUNT LV_COUNT ATTR SIZE FREE VG_UUID
VG_EXTENT_SIZE/ ],
LICENSEINFOS => [ qw/NAME FULLNAME KEY COMPONENTS TRIAL UPDATE OEM ACTIVATION_DATE PRODUCTID/ ]
);
my %checks = (
STORAGES => {
INTERFACE => qr/^(SCSI|HDC|IDE|USB|1394|Serial-ATA|SAS)$/
},
VIRTUALMACHINES => {
STATUS => qr/^(running|blocked|idle|paused|shutdown|crashed|dying|off)$/
},
SLOTS => {
STATUS => qr/^(free|used)$/
},
NETWORKS => {
TYPE => qr/^(ethernet|wifi|aggregate|alias|dialup)$/
},
CPUS => {
ARCH => qr/^(MIPS|MIPS64|Alpha|SPARC|SPARC64|m68k|i386|x86_64|PowerPC|PowerPC64|ARM|AArch64)$/
}
);
# convert fields list into fields hashes, for fast lookup
foreach my $section (keys %fields) {
$fields{$section} = { map { $_ => 1 } @{$fields{$section}} };
}
sub new {
my ($class, %params) = @_;
my $self = {
logger => $params{logger},
fields => \%fields,
content => {
HARDWARE => {
ARCHNAME => $Config{archname},
VMSYSTEM => "Physical" # Default value
},
VERSIONCLIENT => $FusionInventory::Agent::AGENT_STRING
}
};
bless $self, $class;
$self->setTag($params{tag});
$self->{last_state_file} = $params{statedir} . '/last_state'
if $params{statedir};
return $self;
}
sub getContent {
my ($self) = @_;
return $self->{content};
}
sub mergeContent {
my ($self, $content) = @_;
die "no content" unless $content;
foreach my $section (keys %$content) {
if (ref $content->{$section} eq 'ARRAY') {
# a list of entry
foreach my $entry (@{$content->{$section}}) {
$self->addEntry(section => $section, entry => $entry);
}
} else {
# single entry
SWITCH: {
if ($section eq 'HARDWARE') {
$self->setHardware($content->{$section});
last SWITCH;
}
if ($section eq 'BIOS') {
$self->setBios($content->{$section});
last SWITCH;
}
if ($section eq 'ACCESSLOG') {
$self->setAccessLog($content->{$section});
last SWITCH;
}
$self->addEntry(
section => $section, entry => $content->{$section}
);
}
}
}
}
sub addEntry {
my ($self, %params) = @_;
my $entry = $params{entry};
die "no entry" unless $entry;
my $section = $params{section};
my $fields = $fields{$section};
my $checks = $checks{$section};
die "unknown section $section" unless $fields;
foreach my $field (keys %$entry) {
if (!$fields->{$field}) {
# unvalid field, log error and remove
$self->{logger}->debug("unknown field $field for section $section");
delete $entry->{$field};
next;
}
if (!defined $entry->{$field}) {
# undefined value, remove
delete $entry->{$field};
next;
}
# sanitize value
my $value = getSanitizedString($entry->{$field});
# check value if appliable
if ($checks->{$field}) {
$self->{logger}->debug(
"invalid value $value for field $field for section $section"
) unless $value =~ $checks->{$field};
}
$entry->{$field} = $value;
}
# avoid duplicate entries
if ($params{noDuplicated}) {
my $md5 = md5_base64(Dumper($entry));
return if $self->{seen}->{$section}->{$md5};
$self->{seen}->{$section}->{$md5} = 1;
}
if ($section eq 'STORAGES') {
$entry->{SERIALNUMBER} = $entry->{SERIAL} if !$entry->{SERIALNUMBER}
}
push @{$self->{content}{$section}}, $entry;
}
sub computeLegacyValues {
my ($self) = @_;
# CPU-related values
my $cpus = $self->{content}->{CPUS};
if ($cpus) {
my $cpu = $cpus->[0];
$self->setHardware({
PROCESSORN => scalar @$cpus,
PROCESSORS => $cpu->{SPEED},
PROCESSORT => $cpu->{NAME},
});
}
# network related values
my $interfaces = $self->{content}->{NETWORKS};
if ($interfaces) {
my @ip_addresses =
grep { ! /^127/ }
grep { $_ }
map { $_->{IPADDRESS} }
@$interfaces;
$self->setHardware({
IPADDR => join('/', @ip_addresses),
});
}
# user-related values
my $users = $self->{content}->{USERS};
if ($users) {
my $user = $users->[-1];
my ($domain, $id);
if ($user->{LOGIN} =~ /(\S+)\\(\S+)/) {
# Windows fully qualified username: domain\user
$domain = $1;
$id = $2;
} else {
# simple username: user
$id = $user->{LOGIN};
}
$self->setHardware({
USERID => $id,
USERDOMAIN => $domain,
});
}
}
sub setHardware {
my ($self, $args) = @_;
foreach my $field (keys %$args) {
if (!$fields{HARDWARE}->{$field}) {
$self->{logger}->debug("unknown field $field for section HARDWARE");
next
}
# Do not overwrite existing value with undef
next unless $args->{$field};
$self->{content}->{HARDWARE}->{$field} =
getSanitizedString($args->{$field});
}
}
sub setOperatingSystem {
my ($self, $args) = @_;
foreach my $field (keys %$args) {
if (!$fields{OPERATINGSYSTEM}->{$field}) {
$self->{logger}->debug(
"unknown field $field for section OPERATINGSYSTEM"
);
next
}
$self->{content}->{OPERATINGSYSTEM}->{$field} =
getSanitizedString($args->{$field});
}
}
sub setBios {
my ($self, $args) = @_;
foreach my $field (keys %$args) {
if (!$fields{BIOS}->{$field}) {
$self->{logger}->debug("unknown field $field for section BIOS");
next
}
$self->{content}->{BIOS}->{$field} =
getSanitizedString($args->{$field});
}
}
sub setAccessLog {
my ($self, $args) = @_;
foreach my $field (keys %$args) {
if (!$fields{ACCESSLOG}->{$field}) {
$self->{logger}->debug(
"unknown field $field for section ACCESSLOG"
);
next
}
$self->{content}->{ACCESSLOG}->{$field} =
getSanitizedString($args->{$field});
}
}
sub setTag {
my ($self, $tag) = @_;
return unless $tag;
$self->{content}{ACCOUNTINFO} = [{
KEYNAME => "TAG",
KEYVALUE => $tag
}];
}
sub computeChecksum {
my ($self) = @_;
my $logger = $self->{logger};
# to apply to $checksum with an OR
my %mask = (
HARDWARE => 1,
BIOS => 2,
MEMORIES => 4,
SLOTS => 8,
REGISTRY => 16,
CONTROLLERS => 32,
MONITORS => 64,
PORTS => 128,
STORAGES => 256,
DRIVES => 512,
INPUT => 1024,
MODEMS => 2048,
NETWORKS => 4096,
PRINTERS => 8192,
SOUNDS => 16384,
VIDEOS => 32768,
SOFTWARES => 65536,
);
# TODO CPUS is not in the list
if ($self->{last_state_file}) {
if (-f $self->{last_state_file}) {
eval {
$self->{last_state_content} = XML::TreePP->new()->parsefile(
$self->{last_state_file}
);
};
if (ref($self->{last_state_content}) ne 'HASH') {
$self->{last_state_file} = {};
}
} else {
$logger->debug(
"last state file '$self->{last_state_file}' doesn't exist"
);
}
}
my $checksum = 0;
foreach my $section (keys %mask) {
my $hash =
md5_base64(Dumper($self->{content}->{$section}));
# check if the section did change since the last run
next if
$self->{last_state_content}->{$section} &&
$self->{last_state_content}->{$section} eq $hash;
$logger->debug("Section $section has changed since last inventory");
# add the mask of the current section to the checksum
$checksum |= $mask{$section}; ## no critic (ProhibitBitwise)
# store the new value.
$self->{last_state_content}->{$section} = $hash;
}
$self->setHardware({CHECKSUM => $checksum});
}
sub saveLastState {
my ($self) = @_;
my $logger = $self->{logger};
if (!defined($self->{last_state_content})) {
$self->processChecksum();
}
if ($self->{last_state_file}) {
eval {
XML::TreePP->new()->writefile(
$self->{last_state_file}, $self->{last_state_content}
);
}
} else {
$logger->debug(
"last state file is not defined, last state not saved"
);
}
my $tpp = XML::TreePP->new();
}
1;
__END__
=head1 NAME
FusionInventory::Agent::Inventory - Inventory data structure
=head1 DESCRIPTION
This is a data structure corresponding to an hardware and software inventory.
=head1 METHODS
=head2 new(%params)
The constructor. The following parameters are allowed, as keys of the
%params hash:
=over
=item I<logger>
a logger object
=item I<statedir>
a path to a writable directory containing the last serialized inventory
=item I<tag>
an arbitrary label, used for server-side filtering
=back
=head2 getContent()
Get content attribute.
=head2 mergeContent($content)
Merge content to the inventory.
=head2 addEntry(%params)
Add a new entry to the inventory. The following parameters are allowed, as keys
of the %params hash:
=over
=item I<section>
the entry section (mandatory)
=item I<entry>
the entry (mandatory)
=item I<noDuplicated>
ignore entry if already present
=back
=head2 setTag($tag)
Set inventory tag, an arbitrary label used for filtering on server side.
=head2 setHardware()
Save global information regarding the machine.
=head2 setOperatingSystem()
Operating System information.
=head2 setBios()
Set BIOS information.
=head2 setAccessLog()
What is that for? :)
=head2 computeChecksum()
Compute the inventory checksum. This information is used by the server to
know which parts of the inventory have changed since the last one.
=head2 computeLegacyValues()
Compute the inventory global values, meaning values in hardware section such as
CPU number, speed and model, computed from other values, but needed for OCS
compatibility.
=head2 saveLastState()
At the end of the process IF the inventory was saved
correctly, the last_state is saved.
=head1 DATA MODEL
This section presents the various entry types, with their attributes. The names
correspond to the historical OCS format.
=head2 BIOS
=over
=item SMODEL
System model
=item SMANUFACTURER
System manufacturer
=item SSN
System Serial number
=item BDATE
BIOS release date in the Month/Day/Year format (e.g: 09/27/2010)
=item BVERSION
The BIOS revision
=item BMANUFACTURER
BIOS manufacturer
=item MMANUFACTURER
Motherboard Manufacturer
=item MSN
Motherboard Serial
=item MMODEL
Motherboard model
=item ASSETTAG
=item ENCLOSURESERIAL
=item BIOSSERIAL
The optional asset tag for this machine.
=item TYPE
depcreated, replace by HARDWARE/CHASSIS_TYPE
=back
=head2 CONTROLLERS
=over
=item CAPTION
Windows CAPTION field or subsystem Name from the pci.ids table
=item DRIVER
=item NAME
The device name, the on from the PCIIDs DB
=item MANUFACTURER
The manifacturer name, the on from the PCIIDs DB
=item PCICLASS
The PCI class ID
=item PCIID
The PCI ID, e.g: 8086:2a40 (only for PCI device)
=item PCISUBSYSTEMID
The PCI subsystem ID, e.g: 8086:2a40 (only for PCI device)
=item PCISLOT
The PCI slot, e.g: 00:02.1 (only for PCI device)
=item TYPE
The controller revision, e.g: rev 02. This field may be renamed
in the future.
=item REV
Revision of the device in the XX format (e.g: 04)
=back
=head2 MEMORIES
=over
=item CAPACITY
=item CAPTION
E.g: Physical Memory
=item DESCRIPTION
=item FORMFACTOR
Only available on Windows, See Win32_PhysicalMemory documentation on MSDN.
=item REMOVABLE
=item PURPOSE
Only avalaible on Windows, See Win32_PhysicalMemory documentation on MSDN.
=item SPEED
In Mhz, e.g: 800
=item TYPE
=item NUMSLOTS
Eg. 2, start at 1, not 0
=item SERIALNUMBER
=back
=head2 CPUS
=over
=item ARCH
The CPU architecture
=item CACHESIZE
The total CPU cache size in KB. e.g: 3072
=item CORE
Number of core.
=item DESCRIPTION
=item MANUFACTURER
AMD/Intel/Transmeta/Cyrix/VIA/Sun Microsystems//Fujitsu
=item NAME
The name of the CPU, e.g: Intel(R) Core(TM)2 Duo CPU P8600 @ 2.40GHz
=item THREAD
Number of thread per core.
=item SERIAL
Serial number
=item SPEED
Frequency in MHz
=item ID
The CPU ID: http://en.wikipedia.org/wiki/CPUID
=item STEPPING
Stepping value (Contained in CPUID)
=item MODEL
Model value (Contained in CPUID)
=item FAMILYNUMBER
Family value (Contained in CPUID)
=item FAMILYNAME
Family Name
=back
=head2 DRIVES
Drive is actually a filesystem. Virtual filesystem like /proc or /sys are ignored.
=over
=item CREATEDATE
Date of creation of the filesystem in DD/MM/YYYY format.
=item DESCRIPTION
=item FREE
Free space (MB)
=item FILESYSTEM
File system name. e.g: ext3
=item LABEL
Name of the partition given by the user.
=item LETTER
Windows driver letter. Windows only
=item SERIAL
Partition serial number or UUID
=item SYSTEMDRIVE
Boolean. Is this the system partition?
=item TOTAL
Total space available (MB)
=item TYPE
The mount point on UNIX.
=item VOLUMN
System name of the partition (e.g: /dev/sda1 or server:/directory for NFS)
=back
=head2 HARDWARE
=over
=item USERID
The current user list, '/' is the delimiter. This field is deprecated, you
should use the USERS section instead.
=item OSVERSION
Version number of the operating system. This field will be deprecated in the
future, please use OPERATINGSYSTEM/VERSION or OPERATINGSYSTEM/KERNEL_VERSION
instead.
=item PROCESSORN
=item OSCOMMENTS
Service Pack on Windows, kernel build date on Linux
=item CHECKSUM
Deprecated, OCS only.
=item PROCESSORT
Deprecated, OCS only.
=item NAME
=item PROCESSORS
The processor speed in MHz, this field is deprecated, see CPUS instead.
=item SWAP
The swap space in MB.
=item ETIME
The time needed to run the inventory on the agent side.
=item TYPE
=item OSNAME
Full name of the operating system as reported by itself. This field will be
deprecated in the future, please use OPERATINGSYSTEM/NAME or
OPERATINGSYSTEM/FULL_NAME instead.
=item IPADDR
=item WORKGROUP
=item DESCRIPTION
Computer description (Windows only so far)
=item MEMORY
Total system memory in MB
=item UUID
=item DNS
=item LASTLOGGEDUSER
The login of the last logged user.
=item USERDOMAIN
This field is deprecated, you should use the USERS section instead.
=item DATELASTLOGGEDUSER
=item DEFAULTGATEWAY
=item VMSYSTEM
The virtualization technology used if the machine is a virtual machine.
Can be:
=over 5
=item Physical: (default)
=item Xen
=item VirtualBox
=item Virtual Machine: Generic if it's not possible to correctly identify the solution
=item VMware: ESX, ESXi, server, etc
=item QEMU
=item SolarisZone
=item VServer
=item OpenVZ
=item BSDJail
=item Parallels
=item Hyper-V
=item AIX_LPAR
=back
=item VMID
The ID of the Virtual machine on the hypervisor (VM only).
=item VMNAME
The name of the Virtual machine on the hypervisor (VM only).
=item WINOWNER
=item WINPRODID
=item WINPRODKEY
=item WINCOMPANY
=item WINLANG
Language code of the Windows
=item CHASSIS_TYPE
The computer chassis format (e.g: Notebook, Laptop, Server, etc)
=item ARCHNAME
Architecture of the perl binary used to call the agent, MSWin32-x86-multi-thread.
=back
=head2 OPERATINGSYSTEM
=over
=item KERNEL_NAME
The name of the kernel used by this operating system, e.g freebsd, linux, hpux,
win32, etc (linux for android).
=item KERNEL_VERSION
Version of the operating system's kernel, e.g 2.6.32 for Linux, 5.2.x.y on
Windows Server 2003, etc.
=item NAME
Name of the Operating System ("Distributor ID" in LSB terms), e.g Debian,
Ubuntu, CentOS, SUSE LINUX, Windows, MacOSX, FreeBSD, AIX, Android, etc.
=item VERSION
Version of the operating system distribution ("Release" in LSB terms), e.g 11.04
on Ubuntu natty, 5.0.8 on Debian Lenny, 5.4 on CentOS 5.4, 2003 for Windows
Server 2003, etc.
=item FULL_NAME
Full name of the operating system as reported by itself, e.g "Debian GNU/Linux
unstable (sid)" or "Microsoft(R) Windows(R) Server 2003, Enterprise Edition
x64". This is also contained in the HARDWARE/OSNAME field which will be
deprecated in the future.
=item SERVICE_PACK
The Service Pack level reported by the operating system. This field is only
present on systems which use this notion.
=item INSTALL_DATE
The operating system installation date.
=item ARCH
Operating system architecture.
=item BOOT_TIME
The date of the boot of the computer, e.g: 2012-12-09 15:58:20
=back
=head2 MONITORS
=over
=item BASE64
The uuencoded EDID trame. Optional.
=item CAPTION
=item DESCRIPTION
=item MANUFACTURER
The manufacturer retrieved from the EDID trame.
=item SERIAL
The serial number retrieved from the EDID trame.
=item UUENCODE
The uuencoded EDID trame. Optional.
=back
=head2 PORTS
Serial, Parallel, SATA, etc
=over
=item CAPTION
=item DESCRIPTION
=item NAME
=item TYPE
=back
=head2 SLOTS
Represents physical connection points including ports, motherboard slots and
peripherals, and proprietary connection points.
This information is hardly reliable.
=over
=item DESCRIPTION
The bus type.
=item DESIGNATION
=item NAME
The slot identifier.
=item STATUS
The slot usage status (free or used).
=back
=head2 STORAGES
=over
=item DESCRIPTION
The long name of the device displayed to the user.
=item DISKSIZE
The disk size in MB.
=item INTERFACE
INTERFACE can be SCSI/HDC/IDE/USB/1394/Serial-ATA/SAS or empty if unknown
=item MANUFACTURER
=item MODEL
The commercial name of the device
=item NAME
The name of the device as seen by the system. E.g: hda (Linux), \\.\PHYSICALDRIVE0 (Windows)
=item TYPE
The kind of device. There is no standard for the format of the string in this field.
=item SERIAL
The harddrive serial number
=item SERIALNUMBER
Deprecated. The harddrive serial number, same as SERIAL.
=item FIRMWARE
=item SCSI_COID
=item SCSI_CHID
=item SCSI_UNID
=item SCSI_LUN
=item WWN
World Wide Name http://fr.wikipedia.org/wiki/World_Wide_Name
=back
=head2 SOFTWARES
=over
=item COMMENTS
=item FILESIZE
=item FOLDER
=item FROM
Where the information about the software came from, can be:
registry, rpm, deb, etc
=item HELPLINK
=item INSTALLDATE
Installation day in DD/MM/YYYY format. Windows only.
=item NAME
=item NO_REMOVE
Can the software be removed.
=item RELEASE_TYPE
Windows only for now, come from the registry
=item PUBLISHER
=item UNINSTALL_STRING
Windows only, come from the registry
=item URL_INFO_ABOUT
=item VERSION
=item VERSION_MINOR
Windows only, come from the registry
=item VERSION_MAJOR
Windows only, come from the registry
=item IS64BIT
If the software is in 32 or 64bit, (1/0)
=item GUID
Windows software GUID
=item USERNAME
Name of the owner of the software.
=item USERID
ID of the owner of the software. SID on Windows.
=back
=head2 USERS
=over
=item LOGIN
=item DOMAIN
The Windows domain of the user, if available.
=back
=head2 VIDEOS
=over
=item CHIPSET
=item MEMORY
Video card memory in MB
=item NAME
=item RESOLUTION
Resolution in pixel. 1024x768.
=item PCISLOT
The local PCI slot ID if the video card use PCI.
=back
=head2 VIRTUALMACHINES
=over
=item MEMORY
Memory size, in MB.
=item NAME
The name of the virtual machine.
=item UUID
=item STATUS
The VM status: running, idle, paused, shutdown, crashed, dying, off
=item SUBSYSTEM
The virtualisation software.
E.g: VmWare ESX
=item VMTYPE
The name of the virtualisation system family. The same type found is HARDWARE/VMSYSTEM
=item VCPU
Number of CPU affected to the virtual machine
=item VMID
The ID of virtual machine in the virtual managment system.
=item MAC
The list of the MAC addresses of the virtual machine. The delimiter is '/'. e.g: 00:23:18:91:db:8d/00:23:57:31:sb:8e
=item COMMENT
a comment
=item OWNER
=back
=head2 SOUNDS
=over
=item DESCRIPTION
=item MANUFACTURER
=item NAME
=back
=head2 MODEMS
=over
=item DESCRIPTION
=item NAME
=back
=head2 ENVS
Environment variables
=over
=item KEY
=item VAL
=back
=head2 UPDATES
Windows updates
=over
=item ID
Update Id
=item KB
List of KB, delimiter is '/'
=back
=head2 USBDEVICES
USB Devices
=over
=item VENDORID
Vendor USB ID. 4 hexa char.
=item PRODUCTID
Product USB ID. 4 hexa char.
=item SERIAL
=item CLASS
USB Class (e.g: 8 for Mass Storage)
=item SUBCLASS
USB Sub Class
=item NAME
The name of the device (optional)
=back
=head2 NETWORKS
A network configuration.
=over
=item DESCRIPTION
The name of the interface as seen in the OS settings, e.g: eth0 (Linux) or AMD PCNET Family Ethernet Adapter (Windows)
=item DRIVER
The name of the driver used by the network interface
=item IPADDRESS
=item IPADDRESS6
=item IPDHCP
The IP address of the DHCP server (optional).
=item IPGATEWAY
=item IPMASK
=item IPSUBNET
=item MACADDR
=item MTU
=item PCISLOT
The PCI slot name.
=item STATUS
Up or Down
=item TYPE
Interface type: Ethernet, Wifi
=item VIRTUALDEV
If the interface exist or not (1 or empty)
=item SLAVES
Bonded interfaces list in the eth0/eth1/eth2 format (/ is the separator).
=item MANAGEMENT
Whether or not it is a HP iLO, Sun SC, HP MP or other kind of Remote Management Interface
=item SPEED
Interface speed in Mb/s
=item BSSID
Wifi only, Access point MAC Address
=item SSID
Wifi only, Access point name
=back
=head2 BATTERIES
=over
=item CAPACITY
Battery capacity in mWh
=item DATE
Manufacture date in DD/MM/YYYY format
=item NAME
Name of the device
=item SERIAL
Serial number
=item MANUFACTURER
Battery manufacturer
=item VOLTAGE
Voltage in mV
=back
=head2 PRINTERS
=over
=item COMMENT
=item DESCRIPTION
=item DRIVER
=item NAME
=item NETWORK
Network: True (1) if it's a network printer
=item PORT
=item RESOLUTION
Resolution: eg. 600x600
=item SHARED
Shared: True if the printer is shared (Win32)
=item STATUS
Status: See Win32_Printer.PrinterStatus
=item ERRSTATUS
ErrStatus: See Win32_Printer.ExtendedDetectedErrorState
=item SERVERNAME
=item SHARENAME
=item PRINTPROCESSOR
=item SERIAL
The serial number
=back
=head2 PROCESSES
=over
=item USER
The process owner
=item PID
The process Id
=item CPUUSAGE
The CPU usage.
=item MEM
The memory.
=item VIRTUALMEMORY
=item TTY
=item STARTED
When the process has been started in YYYY/MM/DD HH:MM format
=item CMD
The command.
=back
=head2 ANTIVIRUS
=over
=item COMPANY
Comapny name
=item NAME
=item GUID
Unique ID
=item ENABLED
1 if the antivirus is enabled.
=item UPTODATE
1 if the antivirus is up to date.
=item VERSION
=back
=head2 LOGICAL_VOLUMES
A LVM Logical Volume
=over
=item LVNAME
The volume name.
=item VGNAME
The volume group name.
=item ATTR
The special attribue used on this volume (e.g: a-)
=item SIZE
The size of the volume on MB.
=item UUID
The volume UUID.
=back
=head2 PHYSICAL_VOLUMES
=over
=item DEVICE
The device name. Eg.: /dev/sda1 on Linux.
=item PV_NAME
The physical device name.
=item FORMAT
The format. E.g: lvm2.
=item ATTR
The LVM attribue in use for this phyisical device.
=item SIZE
The size in MB.
=item PV_UUID
The UUID.
=item PV_PE_COUNT
Item PV_PE_COUNT
=item PE_SIZE
Item PE_SIZE
=back
=head2 VOLUME_GROUPS
A LVM Volume group.
=over
=item VGNAME
The name of the volume group.
=item PV_COUNT
=item LV_COUNT
=item ATTR
The volume group LVM attribue.
=item SIZE
The size.
=item FREE
The free space.
=item UUID
The UUID
=back
=head2 LICENSEINFOS
A license
=over
=item NAME
The name of the license
=item FULLNAME
The full name of the license (optional)
=item KEY
The key used to register the license (optional)
=item COMPONENTS
The components covered by the license (optional)
=item PRODUCTID
The ID of the installation (optional)
=back
|