Content-type: text/html Manpage of mcsysinfoperl

mcsysinfoperl

Section: C Library Functions (3)
Updated: 26 June 2001
Index Return to Main Contents

NAME

mcsysinfoperl - MagniComp(tm) SysInfo(tm) Perl API to obtain detailed system information in a platform neutral manner

SYNOPSIS

use lib ('/usr/local/sysinfo/lib/mcSysInfo');
use mcSysInfo;

$mcSysInfo = mcSysInfo->New;

# Optional: Specify pathname to sysinfo(1)
$mcSysInfo->Program($SysInfoPath);
# Optional: Use $InFile in place of sysinfo(1)
$mcSysInfo->InputFile($InFile);
# Optional: Limit data to class List
$mcSysInfo->Class(@List);

$mcSysInfo->Retrieve();

DESCRIPTION

The mcSysInfo perl(1) interface is part of SysInfo(tm) from MagniComp(tm). It provides a perl(1) object (API) for obtaining detailed data about the local system's configuration via a platform neutral interface.

Please see mcsysinfoc(3) if a C API is required.

When mcSysInfo->Retrieve is called it runs the sysinfo(1) command by default to obtain the system configuration data. The data is parsed into perl(1) objects and made available as members of mcSysInfo (see below for details).

OBJECT DEFINETIONS

OBJECT mcSysInfo

The following is a list of object members available for the mcSysInfo object:

Class(@List): Limit the class of information retrieved and returned to @List. The contents of @List should be valid class names as returned by sysinfo -list class The default is to return all class types.
InputFile(Path): Use the file specified by Path as input instead of running the sysinfo(1) program. The file must be the output from sysinfo -repsep '|' -format report The default is to run the sysinfo(1) program.
Program(Path): Use Path as the pathname to the sysinfo(1) program. The default is /usr/local/sysinfo/bin/sysinfo

The following mcSysInfo object members contain the system configuration data after mcSysInfo->Retrieve is called:

General: General system configuration data. See OBJECT mcGeneral below.
Hardware: Hardware (device) configuration data. See OBJECT mcHardware below.
Software: Installed software data. See OBJECT mcSoftware below.
Partition: Disk partition data. See OBJECT mcPartition below.
SysConf: System configuration data. See OBJECT mcSysConf below.
Kernel: Kernel configuration data. See OBJECT mcKernel below.

OBJECT mcGeneral

The mcGeneral object contains general system configuration data. The table below specifies the valid members of the mcGeneral object and describes their usage. See mcsysinfo(3) for more details describing each member.

Member	Description	Returns
Hostname	Host Name	Scalar
HostAliases	Host Aliases	Array
HostAddrs	Host Addresses	Array
HostId	Host ID	Scalar
Serial	Serial #	Scalar
ManShort	Manufacturer (Short)	Scalar
ManLong	Manufacturer (Long)	Scalar
Man	Manufacturer	Scalar
Model	Model	Scalar
PhysMem	Physical Memory	Scalar
VirtMem	Virtual Memory	Scalar
RomVer	ROM Version	Scalar
NumCpu	Number of CPU	Scalar
CpuType	CPU Type	Scalar
CpuSpeed	CPU Speed	Scalar
AppArch	App Architecture	Scalar
KernArch	Kernel Architecture	Scalar
OSname	OS Name	Scalar
OSver	OS Version	Scalar
OSdist	OS Distribution	Scalar
KernVer	Kernel Version	Scalar
BootTime	Boot Time	Scalar
CurrentTime	Current Time	Scalar
LibcName	Libc Name	Scalar
LibcVer	Libc Version	Scalar

OBJECT mcHardware

The mcHardware object contains data on what hardware (devices) is installed on the system. The following are valid members:

Entries: Returns a hash of mcDevInfo objects each of which details an installed device. The hash key is a unique device name. The value is an mcDevInfo object. See OBJECT mcDevInfo for details.

A special device entry with a key of TOTAL DISK contains the total amount of disk space on the system.

OBJECT mcDevInfo

The table below specifies the valid members of the mcDevInfo object and describes their usage. See mcsysinfo(3) for more details describing each member.

Member	Description	Returns
Name	Name of device	Scalar
Driver	Driver name	Scalar
Aliases	Aliases	Array
AltName	AKA Name	Scalar
Files	Files	Array
Type	Type	Scalar
ClassType	Class Type	Scalar
Vendor	Manufacturer	Scalar
Model	Model	Scalar
ModelDesc	Model Description	Scalar
Part	Part #	Scalar
Serial	Serial #	Scalar
Ident	Identifier	Scalar
Revision	Revision	Scalar
Unit	Unit	Scalar
NodeID	Node ID	Scalar
DescList	List of misc descriptions	Array
DevSpec	Device type specific data	varies
Slaves	List of child devices	Array
Next	Next peer device	Scalar

OBJECT mcCpuInfo

The table below specifies the valid members of the mcCpuInfo object and describes their usage. A mcCpuInfo object is usually available via mcDevInfo->DevSpec when mcDevInfo->Type is CPU. See mcsysinfo(3) for more details describing each member.

Member	Description	Returns
Man	Manufacturer	Scalar
Model	Model	Scalar
Arch	Architecture	Scalar
ArchVer	Architecture Version	Scalar
Serial	Serial #	Scalar
BitSize	Bit Size	Scalar
Speed	Clock Speed	Scalar
L1iCacheSize	L1 Instruction Cache Size	Scalar
L1iAssoc	L1 Instruction Associativety	Scalar
L1iLines	L1 Instruction Lines	Scalar
L1iLineSize	L1 Instruction Line Size	Scalar
InstTLB	Instruction TLB	Scalar
InstTLBAssoc	Instruction TLB Associativety	Scalar
L1dCacheSize	L1 Data Cache Size	Scalar
L1dAssoc	L1 Data Associativety	Scalar
L1dLines	L1 Data Lines	Scalar
L1dLineSize	L1 Data Line Size	Scalar
DataTLB	Data TLB	Scalar
DataTLBAssoc	Data TLB Associativety	Scalar
L2CacheSize	L2 Cache Size	Scalar
L2Assoc	L2 Associativety	Scalar
L2Lines	L2 Lines	Scalar
L2LineSize	L2 Line Size	Scalar
HasFPU	Has FPU	Scalar
Stepping	Stepping	Scalar

OBJECT mcNetIf

The table below specifies the valid members of the mcNetIf object and describes their usage. A mcNetIf object is usually available via mcDevInfo->DevSpec when mcDevInfo->Type is netif. See mcsysinfo(3) for more details describing each member.

Member	Description	Returns
Type	NIC Address Type	Scalar
HostAddr	NIC Host Address	Scalar
HostName	NIC Host Name	Scalar
MACaddr	NIC MAC Current Address	Scalar
MACname	NIC MAC Current Name	Scalar
FacMACaddr	NIC MAC Factory Address	Scalar
FacMACname	NIC MAC Factory Name	Scalar
NetAddr	NIC Network Address	Scalar
NetName	NIC Network Name	Scalar

OBJECT mcSoftware

The mcSoftware object contains data on what software is installed on the system. The following are valid members:

Entries: Returns a hash of mcSoftInfo objects each of which details an installed software package. The hash key is a unique package name. The value is an mcSoftInfo object. See OBJECT mcSoftInfo for details.

OBJECT mcSoftInfo

The table below specifies the valid members of the mcSoftInfo object and describes their usage. See mcsysinfo(3) for more details describing each member.

Member	Description	Returns
Name	Name of package	Scalar
EntryType	Entry Type	Scalar
Version	Version	Scalar
Revision	Revision	Scalar
Description	Description	Scalar
DescVerbose	Description (Verbose)	Scalar
URL	URL	Scalar
License	License	Scalar
Copyright	Copyright	Scalar
Category	Category	Scalar
SubCategory	Sub-Category	Scalar
OSname	Requires OS Name	Scalar
OSversion	Requires OS Version	Scalar
Arch	Requires Architecture	Scalar
ISArch	Requires Inst Set Arch	Scalar
InstDate	Installation Date	Scalar
BuildDate	Build Date	Scalar
ProdStamp	Production Stamp	Scalar
BaseDir	Base Directory	Scalar
DiskUsage	Disk Usage	Scalar
FileList	File List	Array
VendorName	Vendor Name	Scalar
VendorEmail	Vendor Email	Scalar
VendorPhone	Vendor Phone #	Scalar
VendorStock	Vendor Stock #	Scalar
DescList	List of misc description data	Array
Master	Name of master package	Scalar
MasterVer	Version of master	Scalar
MasterRev	Revisionof master	Scalar
Slaves	List of child packages	Array
Next	Next peer package	Scalar

OBJECT mcPartition

The mcPartition object contains data on what disk partitions are on the system. The following are valid members:

Entries: Returns a hash of mcPartInfo objects each of which details a partition entry. The hash key is a unique partition name. The value is an mcPartInfo object. See OBJECT mcPartInfo for details.

OBJECT mcPartInfo

The table below specifies the valid members of the mcPartInfo object and describes their usage. See mcsysinfo(3) for more details describing each member.

Member	Description	Returns
Name	Partition Name	Scalar
DevName	Device Name	Scalar
DevPath	Device Path	Scalar
DevPathRaw	Device Path Raw	Scalar
BaseName	Base Name	Scalar
Slice	Slice	Scalar
Num	Partition #	Scalar
Type	Type	Scalar
TypeDesc	Type Description	Scalar
TypeNum	Type Number	Scalar
UsageStatus	Usage Status	Scalar
MntName	Mount Name	Scalar
MntOpts	Mount Options	Array
Size	Size (MB)	Scalar
AmtUsed	Amount Used (MB)	Scalar
SecSize	Sector Size (bytes)	Scalar
StartSect	Starting Sector	Scalar
EndSect	Ending Sector	Scalar
NumSect	Number of Sectors	Scalar

OBJECT mcKernel

The mcKernel object contains data on kernel variables and configuration. The following are valid members:

Entries: Returns a hash of mcName objects each of which details a kernel entry. The hash key is a unique variable name. The value is an mcName object. See OBJECT mcName for details.

OBJECT mcSysConf

The mcSysConf object contains data on system configuration data obtained via sysconf(3). The following are valid members:

Entries: Returns a hash of mcName objects each of which details a SysConf entry. The hash key is a unique SysConf variable name. The value is an mcName object. See OBJECT mcName for details.

OBJECT mcName

The table below specifies the valid members of the mcName object and describes their usage. See mcsysinfo(3) for more details describing each member.

Member	Description	Returns
Name	Variable name	Scalar
Desc	Description of entry	Scalar
Value	Value of this variable	Scalar

EXAMPLES

For detailed examples please take a look at /usr/local/sysinfo/lib/ui/uiGUI.pm This is the main model which implements the GUI for sysinfo(1) which utilizes the mcSysInfo interface.

The following example displays the hostname and system model:



use lib ('/usr/local/sysinfo/lib/mcSysInfo');
use mcSysInfo;

$si = mcSysInfo->New;
# Only retrieve the info we need
$si->Class('General');
$si->Retrieve();

printf ("System hostname is %s\n", $si->General->Hostname);
printf ("System model is %s\n", $si->General->Model);

The following example displays a list of all device names and their model (if known):


use lib ('/usr/local/sysinfo/lib/mcSysInfo');

use mcSysInfo;

$si = mcSysInfo->New;
# Only retrieve the info we need
$si->Class('Hardware');
$si->Retrieve();

foreach my $Key (keys %{ $si->Hardware->Entries }) {
        my $di = $si->Hardware->Entries->{$Key};
        printf ("Device %s is a %s\n", $Key, $di->Model);
}

FILES

/usr/local/sysinfo/bin/sysinfo - Path to sysinfo program

URL

http://www.MagniComp.com/sysinfo

Index

NAME

SYNOPSIS

DESCRIPTION

OBJECT DEFINETIONS

OBJECT mcSysInfo
OBJECT mcGeneral
OBJECT mcHardware
OBJECT mcDevInfo
OBJECT mcCpuInfo
OBJECT mcNetIf
OBJECT mcSoftware
OBJECT mcSoftInfo
OBJECT mcPartition
OBJECT mcPartInfo
OBJECT mcKernel
OBJECT mcSysConf
OBJECT mcName

This document was created by man2html, using the manual pages.
Time: 20:34:21 GMT, July 09, 2001