Name

mcsysinforeport — MagniCompSysInfo™ report output format

Synopsis

mcsysinfo --repsep '|' --format report

DESCRIPTION

This document describes the report output format from MagniComp's mcsysinfo(1) command. This format is output when the --format report option is specified to SysInfo. The format of this output is intended to be most easily parsed by software, not humans.

The report format consists of multiple fields each seperated by the | (vertical pipe) character. Other field delimiters may be specified using the --repsep option.

Each entry is terminated by a newline. Each field may optionally begin and/or end with white-space (any combination of <SPACE> and/or <TAB> characters). An empty field consists of no characters or only white-space appearing between field seperators. The content of a used field may consist of any printable ASCII character set including, but not limited to:


a-z A-Z 0-9 <SPACE> <TAB> ...

The first field specifies the class of information being provided. Each class uses the remaining fields in the same general, but varying manner as follows:

Table 1. Overview of Output

Field #ContentDescription
0Class This field names the class of information being provided. Values correspond explicitly to --class arguments. Valid values are:
deviceDevice (hardware) configuration information.
filesysMounted filesystem information.
generalGeneral information about system.
kernelKernel configuration information.
netifNetwork interface information.
networkNetwork information.
partitionFilesystem and disk partition configuration information.
printerAll printer queues defined on the system both local and remote.
siteinfoSite defined information.
softwareSoftware which is installed and registered with the OS.
sysconfSystem configuration information.
1Sub-Class This field may be empty or may contain a keyword which specifies a context specific to the Class. Common values are: name, prop, and desc. Valid Sub-Class values are defined for each Class later in this document.
2VariableSpecifies the name of a variable which the remaining fields describe.
3ValueSpecifies a value of some type.
4...The remaining fields vary in number and content based upon the Field 0 - Class value.

Class device

The Device class provides detailed information about physical hardware installed in a system.

There are multiple forms of a device entry. Each form is specified by the Field 1 Sub-Class field. Each form is described in it's entirety below:

Table 2. Format of device Information

Field #KeywordDescriptionExample
0deviceThe word device specifies the usage described in this section. device
1nameThe canonical definetion of a device.name
2NameSpecifies the name of this device.c0t0d0
3Alt NameA alternative name by which this device is known.sd0
4Master NameThe name of this device's master.ctlr0
5File ListA comma seperated list of filenames associated with this device./dev/dsk/c0t0d0s0,/dev/dsk/c0t0d0s2
6Type NameA name describing the type of device. Each name corresponds to DT_* and DTN_* values in mcsysinfo.h.diskdrive
7Type DescriptionA more verbose description of the type of device.Disk Drive
8ModelA short description specifying the device's model.ST123456
9Model DescriptionA more descriptive version of the device model.ATA
10UnitThe device's unit number.0
11AddressObsolete. 
12PrioObsolete. 
13VecObsolete. 
14Node IDThe device's unique node ID relative to the OS.0x12345
15Class NameA name describing the classification of this device relative to it's Type. These values correspond to CT_* definetions in mcsysinfo.h. SCSI
16Class DescriptionA more verbose description of the device's class. 
17VendorThe name of the device's vendor.Seagate
18Serial #The device's serial number.A1234543
19RevisionThe revision of the device.A01
20IdentifierThe device's identifier. 
21Part #The part number of the device as assigned by the manufacturer.X1234A
22Next NameThe name of the next device (relative to the parent) of the device hierarchy tree.c0t1d0
23Child NamesThe comma seperated list of slave (children) device node names of the device hierarchy. 
24CapacityThe capacity (size) of the device in device specific units.64 GB
25SpeedThe speed of the device in device specific units.320 MB/s
26BusThe bus number the device is attached to.0
27DevNumThe device number which identifies the device.0
28PortThe port number the device is connected to on the bus.0

Device CpuInfo Information

Detailed information about a CPU is indicated when field 0 is set to the word device and field 1 is set to the word cpuinfo. The following table describes the meaning of each field:

Table 3. Format of cpuinfo Information

Field #KeywordDescriptionExample
0deviceThe word device specifies the usage described in this section.device
1cpuinfoThe word cpuinfo further specifies the usage described in this section.cpuinfo
2NameSpecifies the device name for this entry.sd0
3ManThe name of the manufacturer of this CPU.Intel
4ModelThe model of CPU.Pentium-4
5ArchThe architecture of the CPU.i686
6ArchVerThe version of the CPU's architecture.IA32
7SerialThe serial number of the CPU.ABC123456
8BitSizeThe bitsize of the CPU.32
9SpeedThe clock speed of the CPU.1.1 GHz
10-25 These fields are obsolete. 
26Has FPUValue of 1 if a Floating Point Unit (FPU) is present.1
27SteppingThe CPU's stepping value.30

Device CacheInfo Information

Detailed information about a CPU is indicated when field 0 is set to the word device and field 1 is set to the word cacheinfo. The following describes the meaning of each field:

Table 4. Format of cacheinfo Information

Field #KeywordDescriptionExample
0deviceThe word device specifies the usage described in this section.device
1cacheinfoThe word cacheinfo further specifies the usage described in this section.cacheinfo
2NameSpecifies the name of the processor device to which this cache is associated.cpu0
3CacheNameSpecifies the name of the cache which is unique to the device.L1 Inst
4SizeThe size of the cache.64 KB
5AssociativetyThe associativety of the cache.2
6LinesThe number of lines of the cache.1
7Line SizeThe size of each cache line.64
8TLBThe CPU's instruction TLB.32
9TLB AssociativetyThe CPU's instruction TLB associativety.32
10EnabledIf this field is set to 1 the cache is present and enabled. If set to 0 the cache is present, but not enabled. If the field is unset the state is unknown.1
11TypeThe type of cache:
1Instruction
2Data
3Unified
2
12LevelThe level of cache.1
13SpeedThe speed of the cache in nano-seconds.200
14SocketedIf set to 1 the cache is socketed to the CPU. If set to 0 the cache is not socketed. If unset, the state is unknown.0
15LocationThe location of the cache.onboard
16SramTypeThe type of SRAM present.Pipeline Burst
17EccTypeThe type of Error Correction used.Parity
18ModeThe mode of operation of the cache.Write Back

Device Description Information

Unclassified information about a device is provided in the form of a description and it's value. The content of each field is free form text and varies from OS to OS. It should not be relied upon for consistency. The fields are defined as follows:

Table 5. Format of Device Description Information

Field #KeywordDescriptionExample
0deviceThe word device specifies the usage described in this section.device
1descThis entry provides additional, unclassified descriptive information about this entry.desc
2NameSpecifies the name of this entry.vendorPart
3DescriptionThe description of the entry.Vendor Specific Part Number
4ValueThe value of the description.X1234A

Device NetIf Information

Detailed information about a Network InterFace associated with a device is indicated when field 0 is set to the word device and field 1 is set to the word desc and field 3 is set to the word internet. This type of entry contains a subset of information available from the NetIf (network interface) class.

The following describes the meaning of each field:

Table 6. Format of Device Network Interface Information

Field #KeywordDescriptionExample
0deviceThe word device specifies the usage described in this section.device
1descThe word desc specifies the usage described in this section.desc
2IfThe system name of the network interface.eth0
3internetThe word internet specifies the type of address being described.internet
4HostAddrThe host address (usually IP) of the interface.10.1.2.3
5HostNameThe host name of the interface.fritz
6NetAddrThe network address (usually IP) of the interface.10.1.0.0
7NetNameThe network name of the interface.corpnet
8MACaddrThe current MAC address of the interface.0:8:20:a:b:c
9MACnameThe current MAC address name of the interface.fritz-eth0
10FacMACaddrThe factory MAC address of the interface.0:8:20:a:b:c
11FacMACnameThe factory MAC address name of the interface.fritz-eth0
12NetMaskThe network mask for this address in quaded dot format.255.255.0.0
13BroadcastThe network broadcast address for this interface.255.255.255.255

Class filesys

Detailed information about currently mounted filesystems (or any mount entry) is provided when field 0 is set to the word filesys.

Each new block of filesystem information begins with a name entry as follows:

Table 7. Format of filesys Name Entry

Field #KeywordDescriptionExample
0filesysThe word filesys specifies the usage described in this section. filesys
1nameThe word name specifies the usage described in this section. name
2NameThe name of the filesystem about to be described./tmp

Property information about each filesystem is presented as one property item per entry (line). The following format is used:

Table 8. Format of filesys prop Entry

Field #KeywordDescriptionExample
0filesysThe word filesys specifies the usage described in this section. filesys
1propThe word prop specifies the usage described in this section. prop
2NameThe name of the filesystem about to be described./tmp
3KeywordThis field contains a fixed set of keywords as follows:
MntNameName (path) of mount location. i.e. /var
DevPathThe location (source) of the mount point. This is usually a device name for a local filesystem or the path name on the server if this is an nfs mount. /dev/dsk/c0t0d0s3 or /vol/vol0
DevPathRawThe raw device path. For local filesystems, this is the raw device path. /dev/rdsk/c0t0d0s3
DevNameThe name of the device on which this filesystem resides.
ServerThe server (if any) from which this filesystem is mounted from.
TypeThe type of filesystem. i.e. nfs ext3 ufs etc.
OptsThe primary mount option. i.e. rw or ro
MntOptsA comma seperated list of mount options.
SizeThe total size (in Mbytes) of the filesystem.
AmtUsedThe amount of space used (in Mbytes) on the filesystem.
AmtAvailThe amount of space available (in Mbytes) on the filesystem.
 
4DescriptionA description of this entry type.Mount Location
5DataThe actually data (value) for this entry.ufs

Class general

When Field 0 is set to general, the following describes the usage of each field:

Table 9. Format of general Information

Field #KeywordDescriptionExample
0generalThe word general specifies the usage described in this section. general
1unusedThis field is unused. 
2KeywordA fixed name keyword used to uniquely identify this type of data. The keywords matches the valid values for --show variable.osname
3DescriptionDescriptive text of what this entry contains.OS Name
4ValueThe value of this entry.Solaris

Class kernel

When Field 0 is set to kernel, the following describes the usage of each field:

Table 10. Format of kernel Information

Field #KeywordDescriptionExample
0kernelThe word kernel specifies the usage described in this section. kernel
1unusedThis field is unused. 
2VariableNames the variable being described. The keywords matches the valid values for --show variable.maxproc
3DescriptionDescriptive text of Variable.Maximum Processes
4ValueThe value of this entry.500

Class license

When Field 0 is set to license, information about software licenses is provided.

Each new block of license information begins with a name entry as follows:

Table 11. Format of license Name Entry

Field #KeywordDescriptionExample
0licenseThe word license specifies the usage described in this section. license
1nameThe word name specifies the usage described in this section. name
2NameThe name of the license about to be described.StarOffice

Property information about each license is presented as one property item per entry (line). The following format is used:

Table 12. Format of license Property Information

Field #KeywordDescriptionExample
0licenseThe word license specifies the usage described in this section. license
1propThe word prop specifies the usage described in this section. prop
2NameThe name of the license this property applies to.StarOffice
3KeywordThis field contains a fixed set of keywords as follows:
softverSoftware version
typeType of license. Valid values are: float (Floating/concurrent), node (Node locked to one system).
typedescA descriptive string describing this type.
portThe port the license server is running on.
countThe total number of possible licenses.
fileThe path to the license file.
serversoftThe name of the license server software.
serververThe version of the license server software.
vendorserversoftThe name of the vendor's auxiliary license server program.
vendorserverversoftThe version of the license server software.
issuerThe organization which issued the licensed.
hostidThe hostid(1) the license is tied to.
issuedateThe date the license was issued.
startdateThe date the license is usable.
expiredateThe date the license expires and becomes unusable.
serialThe license serial number/ID.
keyThe license key.
 
4DescriptionThe description for this property type.Software Version
5ValueThe property value for this entry.1.1

Class NetIf

Detailed information about a Network InterFace is provided when field 0 is set to the word netif.

Each new block of netif information begins with a name entry as follows:

Table 13. Format of netif Name Entry

Field #KeywordDescriptionExample
0netifThe word netif specifies the usage described in this section. netif
1nameThe word name specifies the usage described in this section. name
2NameThe name of the netif about to be described.eth0

Property information about each netif is presented as one property item per entry (line). The following format is used:

Table 14. Format of netif Property Information

Field #KeywordDescriptionExample
0netifThe word netif specifies the usage described in this section. netif
1propThe word prop specifies the usage described in this section. prop
2NameThe name of the netif this property applies to.eth0
3KeywordThis field contains a fixed set of keywords as follows:
addrtypeType of address.
iftypeType of interface. Possible values are: physical (An actual physical interface), virtual (A virtual (software) interface)
hostaddrHost address (usually IP) of the interface.
hostnameHost name of the interface.
netaddrNetwork address (usually IP) of the interface.
netnameNetwork name of the interface.
macaddrCurrent MAC address of the interface.
macnameCurrent MAC address name of the interface.
facmacaddrFactory MAC address of the interface.
facmacnameFactory MAC address name of the interface.
mediatypeThe type of media. i.e. ethernet, fddi
mediasubtypeThe sub type of media. i.e. 100-base-T, 1000-base-TX
netmaskNetwork mask for this address in quaded dot format.
broadcastNetwork broadcast address for this interface.
mtuThe MTU Size.
speedThe current link speed.
duplexThe current link duplex, either full or half
flagThis is a special entry which lists one of the flags set for this interface. When this field (field 3) is set to flag the flag keyword is found in field 4 and the description of this flag is found in field 5.
 
4DescriptionThe description for this property type.Address Type
5ValueThe property value for this entry.Internet

Class Network

Detailed information about various network related parameters is provided when field 0 is set to the word network. The following format applies:

Table 15. Format of a network Entry

Field #KeywordDescriptionExample
0networkThe word network specifies the usage described in this section. network
1ReservedThis field is reserved for future use. 
2KeywordThis field contains a fixed set of keywords as follows:
defgwipDefault gateway IP address.
defgwnameDefault gateway hostname.
dnsdomainDNS domain name.
dnsserveripsDNS Server IP addresses (comma seperated).
dnsservernamesDNS Server hostnames (comma seperated).
nisdomainNIS (formerly YP) domain name.
nisservermethodThe method by which a NIS server is selected. The value field will contain one of the following: broadcast (The system broadcasts for a server), static (One or more servers are statically defined).
nisserveripsThe comma seperated list of IP addresses of NIS servers. Applies only when the nisservermethod is set to static.
nisservernamesThe comma seperated list of hostnames of NIS servers. Applies only when the nisservermethod is set to static
nisserverThe name of the currently bound NIS server.
nismasterThe name of the master NIS server for this domain.
 
3DescriptionThe description for this property type.DNS Domain
4ValueThe property value for this entry.foo.com

Class partition

The Partition class provides information about disk partitions on a system. The format is as follows:

Table 16. Format of a partition Entry

Field #KeywordDescriptionExample
0partitionThe word partition specifies the usage described in this section. partition
1nameThe word name specifies the usage described in this section. name
2Device PathThe full pathname of this entry's device./dev/sda1
3Device NameThe name of this partition entry relative to the Device Path.sda1
4Base NameThe base filename of the Device Name or Path.sda1
5Partition NumberThe numeric partition number relative to this Device Name/Path1
6Raw Device PathThe pathname of the raw device for this entry./dev/rsda1
7Type NameA short name describing the type of partition this is.EXTDOS, ufs
8Type DescriptionA more verbose description of the type of partition.Extended DOS
9Type NumberA numeric value representing the partition type.83
10Usage StatusDescription of how this partition is being used.FILESYSTEM, SWAP
11Mount NameIf this partition contains a filesystem, then this field describes the mounted name of the partition./export
12Mount OptionsIf this is a mounted filesystem, this field describes any options used to mount the filesystem.rw,quota
13SizeThe total size of this partition in bytes.5010000
14Amount UsedThe total amount of used space on this partition in bytes.201000
15Sector SizeThe size of a single sector in bytes.512
16Starting SectorThe sector number this partition starts on.54
17Ending SectorThe sector number this partition ends on.10054
18Number of SectorsThe total number of sectors this partition uses.10000

Class printer

The Printer class provides information about printer queues known to the local system. The format is as follows: There are multiple forms of printer entries. Each form is specified by the Field 1 Sub-Class field.

Table 17. Format of a printer name Entry

Field #KeywordDescriptionExample
0printerThe word printer specifies the usage described in this section. printer
1nameThe word name specifies the usage described in this section. name
2QueueThe canonical name of this printer queue.fastcolor1
3AliasesA comma seperated list of aliases for this printer.bucket,bolts
4DescriptionA text description of this printer queue. The format is usually site dependent.Acme EZ100 Color Printer in room 101
5VendorThe name of the vendor who manufactures or sells this printer.Acme
6ModelThe model of printer.EZ100
7ProtocolThe protocol used to connect to this printer. Valid names are: local (The printer is attached to a local device such as a serial or parallel port), LPD (The printer is on a remote server which uses the LPD protocol for communication), SYSV (The printer is on a remote server which uses the AT&T System V printer protocol), SMB (The printer is on a remote server which uses the Windows SMB printer protocol).  
8DeviceThe name or path of the local device, if any, on which the printer is attached./dev/lp0
9ServerThe name of the remote server, if any, which provides service for the printer.printsrv1
10RemoteQueueThe name of the remote queue on the remote Serverfastcolor1
11LanguagesA comma seperated list of printer languages which the printer supports.PS
12SpoolDirThe name of the local directory used for spooling print jobs for the printer queue./var/spool/print/fastcolor1
13MaxJobSizeThe maximum sized job accepted for the printer queue.500000

Table 18. Format of a printer desc Entry

Field #KeywordDescriptionExample
0printerThe word printer specifies the usage described in this section.printer
1descThe word desc specifies the usage described in this section.desc
2NameThe name of the printer.fastcolor1
3DescriptionThe description of the entry.Color Ink Type
4ValueThe value of the description.messy

Class siteinfo

The siteinfo class provides site defined information specific to each customer.

Each new block of site information begins with a name entry as follows:

Table 19. Format of siteinfo Name Entry

Field #KeywordDescriptionExample
0siteinfoThe word siteinfo specifies the usage described in this section. siteinfo
1nameThe word name specifies the usage described in this section. name
2VariableThe site info variable about to be described.Location

Property information about each site info variable is presented as one property item per entry (line). The following format is used:

Table 20. Format of siteinfo prop Entry

Field #KeywordDescriptionExample
0siteinfoThe word siteinfo specifies the usage described in this section. siteinfo
1propThe word prop specifies the usage described in this section. prop
2VariableThe unique variable name identifying this property.Location
3KeyA predefined keyword which identifies the type of data. Valid values are: Var (Variable), Desc (Description), Value (Value). Var
4DescriptionA description of what the Key means.Variable
5ValueThe property value.Room-101

Class software

The Software class provides data about installed and registered software.

There are multiple format entries which are defined as follows:

Table 21. Canonical definetion of a software package

Field #KeywordDescriptionExample
0softwareThe word software specifies the usage described in this section. software
1nameThe word name specifies the usage described in this section. name
2NameThe canonical name of this software package or product.glib
3TypeThe type of software entry being described. Values are: pkg (The entry is a software package, the lowest level component) product (The entry represents an entire software product which is typically composed of one or more software packages (pkg)) pkg
4NameThe name of this software package. This is a duplicate of field 2.glib
5VersionThe version of this software entry.2.2
6RevisionThe revision of this software entry.5
7DescA brief (single-line) description of this software entry.The GNU C library.
8URLA URL associated with this software entry.http://www.gnu.org
9LicenseLicense information about this entry.The GNU GPL license applies.
10CategoryA software category this entry is associated with.library
11SubCategoryA software sub-category this entry is associated with.general
12OS NameThe name of the operating system (OS) this software runs on.linux
13OS VersionThe OS version this software runs on.2.4
14ArchThe CPU architecture this software runs on.i386
15ISArchThe instruction set architecture (platform) this software runs on. This is the more general platform of which the Arch is a member.IA32
16Install DateThe date the software was installed.1049489752
17Build DateThe date the software was built and packaged.1029489752
18Production StampSome type of identifier generated by the software producer.porky.devel.redhat.com
19Base DirThe base directory under which the software is installed./usr/lib
20Disk UsageThe amount of disk space this software requires for installation (bytes).347311
21Vendor NameThe name of the vendor who produced the software.Red Hat, Inc.
22Vendor EmailThe vendor's email address.support@redhat.com
23Vendor PhoneThe vendor's phone number.+1-408-555-1212
24Vendor StockThe vendor's stock/identifier for this software.X1234A
25Master NameThe name of the software entry to which this entry belongs. Typically this is the package's product entry.System Environment/Libraries
26Master VersionThe master's version.7.2
27Master RevisionThe master's revision.5
28Desc VerboseA verbose description describing the product. Newlines are indicated by \n strings embedded in the field.A very\ngood general C library.
29CopyrightA copyright statement for the product. Newlines are indicated by \n strings embedded in the field.Copyright Red Hat Inc.\nAll rights reserved.
30NextThe name of the next software entry in the hierarchy.bzip2-libs
31SlavesA comma seperated list of software entries for which this entry is the parent.libcutil
32PkgDepsA comma seperated list of package names + version for which this package depends upon.baseos-1.1,kernel-2.4

Information about files associated with software packages is provided when the +swfiles option is specified. The format of the output is as follows:

Table 22. Software File Information

Field #KeywordDescriptionExample
0softwareThe word software specifies the usage described in this section. software
1fileThe word file specifies the usage described in this section. file
2NameThe canonical name of the software package or product.glib
3typeThe type of file entry:
File
Directory
Hard-link
Symbolic-Link
Character-Device
Black-Device
File
4pathThe pathname of the file entry./usr/lib/libc.so
5linktoIf the entry is a symlink, this field specifies what the link points at./usr/lib/libc.so.3
6sizeThe size of the file in bytes.893100
7md5The MD5 checksum.abcdefawd230982434asdf
8checksumA platform specific checksum.100343
9pkgnamesList of all package names to which this entry belongs.glib

Table 23. Format of a software desc Entry

Field #KeywordDescriptionExample
0softwareThe word software specifies the usage described in this section.software
1descThe word desc specifies the usage described in this section.desc
2NameThe name of the software.glib
3DescriptionThe description of the entry.Software Passed QA?
4ValueThe value of the description.YES

Class sysconf

The SysConf class provides information about general system configuration parameters. The format of this data is as follows:

Table 24. Format of a printer desc Entry

Field #KeywordDescriptionExample
0sysconfThe word sysconf specifies the usage described in this section.sysconf
1unusedThis field is unused. 
2VariableNames the variable being described. The variable matches the valid values for --show variable._SC_OPEN_MAX
3DescriptionDescription of what this variable means.Max open files per process
4ValueThe value of this entry.1024

NOTES

The --format report format is subject to additive changes. That is, the placement of existing fields will not be changed, but new fields may be added. If a field is made obsolete, it's position in the output will remain, but the content will be empty.

AUTHOR

MagniComp http://www.MagniComp.com

URL

http://www.magnicomp.com/sysinfo

FILES

/opt/sysinfo-6.0/config - Directory of config files

SEE ALSO

mcsysinfo(1), mcsysinfoc(3), mcsysinfoperl(3), sysinfo.cf(5),