Content-type: text/html Manpage of mcsysinforeport

mcsysinforeport

Section: File Formats (5)
Updated: 30 March 2003
Index Return to Main Contents
 

NAME

mcsysinforeport - MagniComp(tm) SysInfo(tm) report output format  

SYNOPSIS

mcsysinfo --repsep '|' --format report  

DESCRIPTION

This document describes the report output format from MagniComp's mcsysinfo(1) command.

The output from --format report is intended to be most parsable by software, not humans. The report format consists of multiple fields each seperated by the | (vertical pipe) character. Entry 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:

Field 0 - Class
This field names the class of information being provided. Values correspond explicitly to -class values as follows:
device
Device (hardware) configuration information.
general
General information about system.
kernel
Kernel configuration information.
netif
Network interface information.
network
Network information.
partition
Filesystem and disk partition configuration information.
printer
All printer queues defined on the system both local and remote.
software
Software which is installed and registered with the OS.
sysconf
System configuration information.
Field 1 - Sub-Class
This field may be empty or may contain one of the following sub classification names:
name
Specifies the canonical (primary) information for an entry.
cacheinfo
Entry describes a processor cache. See CacheInfo Information
desc
Describes an attribute.
part
Remaining entry describes a partition.
file
Remaining entry describes a file and it's attributes.
totaldisk
Provides the total amount of disk space discovered.
Field 2 - Variable
Specifies the name of a variable which the remaining fields describe.
Field 3 - Value
Specifies a value of some type.
Field 4 - ...
The remaining fields vary in number and content based upon the Field 1 - Class value.
 

Class device

When Field 0 is set to device, the information being described are individual device (hardware) entries. 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:

Canonical definetion of a device:

Field 0 - device
The word device specifies the usage described in this section.
Field 1 - name
The canonical definetion of a device.
Field 2 - Name
Specifies the name of this device.
Field 3 - Alt Name
A alternative name by which this device is known.
Field 4 - Master Name
The name of this device's master.
Field 5 - File List
A comma seperated list of filenames associated with this device.
Field 6 - Type Name
A name describing the type of device. Each name corresponds to DT_* and DTN_* values in mcsysinfo.h.
Field 7 - Type Description
A more verbose description of the type of device.
Field 8 - Model
A short description specifying the device's model.
Field 9 - Model Description
A more descriptive version of the device model.
Field 10 - Unit
The device's unit number.
Field 11 - Address
Field 12 - Prio
The device's kernel priority. Generally obsolete.
Field 13 - Vec
The device's kernel vector. Generally obsolete.
Field 14 - Node ID
The device's unique node ID relative to the OS.
Field 15 - Class Name
A name describing the classification of this device relative to it's Type. These values correspond to CT_* definetions in mcsysinfo.h. i.e. SCSI, IDE, USB, etc.
Field 16 - Class Description
A more verbose description of the device's class.
Field 17 - Vendor
The name of the device's vendor.
Field 18 - Serial #
The device's serial number.
Field 19 - Revision
The revision of the device.
Field 20 - Identifier
The device's identifier.
Field 21 - Part #
The part number of the device as assigned by the manufacturer.
Field 22 - Next Name
The name of the next device (relative to the parent) of the device hierarchy tree.
Field 23 - Slave Names
The comma seperated list of slave (children) device node names of the device hierarchy.
Field 24 - Capacity
The capacity (size) of the device in device specific units.
Field 25 - Speed
The speed of the device in device specific units.
Field 26 - Bus
The bus number the device is attached to.
Field 27 - DevNum
The device number which identifies the device.
Field 28 - Port
The port number the device is connected to on the bus.

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 describes the meaning of each field:

Field 0 - device
The word device specifies the usage described in this section.
Field 1 - cpuinfo
The word cpuinfo further specifies the usage described in this section.
Field 2 - Name
Specifies the device name for this entry.
Field 3 - Man
The name of the manufacturer of this CPU. i.e. Intel
Field 4 - Model
The model of CPU. i.e. Pentium-4
Field 5 - Arch
The architecture of the CPU. i.e. i686
Field 6 - ArchVer
The version of the CPU's architecture. i.e. IA32
Field 7 - Serial
The serial number of the CPU.
Field 8 - BitSize
The bitsize of the CPU. i.e. 32
Field 9 - Speed
The clock speed of the CPU. i.e. 1.1 GHz
Fields 10-25
These fields are obsolete.
Field 26 - Has FPU
Value of 1 if a Floating Point Unit (FPU) is present.
Field 27 - Stepping
The CPU's stepping value.

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:

Field 0 - device
The word device specifies the usage described in this section.
Field 1 - cacheinfo
The word cacheinfo further specifies the usage described in this section.
Field 2 - Name
Specifies the name of the processor device to which this cache is associated. i.e. cpu0.
Field 3 - CacheName
Specifies the name of the cache which is unique to the device. i.e. L1 Inst for Level 1 Instruction cache.
Field 4 - Size
The size of the cache. i.e. 64 KB
Field 5 - Associativety
The associativety of the cache. i.e. 2
Field 6 - Lines
The number of lines of the cache. i.e. 1
Field 7 - Line Size
The size of each cache line. i.e. 64
Field 8 - TLB
The CPU's instruction TLB.
Field 9 - TLB Associativety
The CPU's instruction TLB associativety.
Field 10 - Enabled
If 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.
Field 11 - Type
The type of cache:
1
Instruction
2
Data
3
Unified
Field 12 - Level
The level of cache. i.e. 1 indicates L1.
Field 13 - Speed
The speed of the cache in nano-seconds.
Field 14 - Socketed
If 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.
Field 15 - Location
The location of the cache.
Field 16 - SramType
The type of SRAM present. i.e. Pipeline Burst
Field 16 - EccType
The type of Error Correction used. i.e. Parity.
Field 17 - Mode
The mode of operation of the cache. i.e. Write Back.

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:

Field 0 - device
The word device specifies the usage described in this section.
Field 1 - desc
This entry provides additional, unclassified descriptive information about this entry.
Field 2 - Name
Specifies the name of this entry.
Field 3 - Description
The description of the entry.
Field 4 - Value
The value of the description.

NetIf DevInfo Information

Detailed information about a Network InterFace associated with a device (class 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:

Field 0 - device
The word device specifies the usage described in this section.
Field 1 - desc
The word desc further specifies the usage described in this section.
Field 3 - internet
The word internet specifies the type of address being described.
Field 4 - HostAddr
Specifies the host address (usually IP) of the interface.
Field 5 - HostName
Specifies the host name of the interface.
Field 6 - NetAddr
Specifies the network address (usually IP) of the interface.
Field 7 - NetName
Specifies the network name of the interface.
Field 8 - MACaddr
Specifies the current MAC address of the interface.
Field 9 - MACname
Specifies the current MAC address name of the interface.
Field 10 - FacMACaddr
Specifies the factory MAC address of the interface.
Field 11 - FacMACname
Specifies the factory MAC address name of the interface.
Field 12 - NetMask
Specifies the network mask for this address in quaded dot format.
Field 13 - Broadcast
Specifies the network broadcast address for this interface.

 

Class general

When Field 0 is set to general, the following describes the usage of each field:
Field 0 - general
The word general specifies the usage described in this section.
Field 1 - unused
This field is unused.
Field 2 - Variable
Names the variable being described. The variable matches the valid values for -show variable.
Field 3 - Description
Descriptive text of the variable.
Field 4 - Value
The value of this entry.

 

Class kernel

When Field 0 is set to kernel, the following describes the usage of each field:
Field 0 - kernel
The word kernel specifies the usage described in this section.
Field 1 - unused
This field is unused.
Field 2 - Variable
Names the variable being described. The variable matches the valid values for -show variable.
Field 3 - Description
Descriptive text of the variable.
Field 4 - Value
The value of this entry.

 

Class license

When Field 0 is set to license, the following describes the usage of each field:
Field 0 - license
The word license specifies the usage described in this section.
Field 1 - type
This field specifies the type of data which follows. The valid types are as follows:
Name Entry
Field 1 - name
The keyword name indicates this is the start of a new entry.
Field 2 - product
This field indicates that product is the name of the licensed application product.
Property Entry
Field 1 - prop
The keyword prop indicates this is a property entry.
Field 2 - key
This field contains one of the following values for the key keyword:
softver
Software version
type
Type of license. Valid values are:
float
Floating (concurrent).
node
Node (one system) locked.
typedesc
A descriptive string describing this type.
port
The port the license server is running on.
count
The total number of possible licenses. This is not the number of currently available licenses.
file
The path to the license file.
serversoft
The name of the license server software.
serverver
The version of the license server software.
vendorserversoft
The name of the vendor's auxiliary license server program.
vendorserverver
The version of the vendor's auxiliary license server program.
issuer
The organization which issued the licensed.
hostid
The hostid(1) the license is tied to.
issuedate
The date the license was issued.
startdate
The date the license is usable.
expiredate
The date the license expires and becomes unusable.
serial
The license serial number/ID.
key
The license key.
Field 3 - description
This field contains a verbose description of this property.
Field 4 - value
This field contains the actual value of this property.

 

Class NetIf

Detailed information about a Network InterFace is indicated when field 0 is set to the word netif . The following format applies:

Field 0 - netif
The word netif specifies the usage described in this section.
Field 1 - type
This field specifies the type of data which follows. The valid types are as follows:

Name Entry

Field 1 - name
The keyword name indicates this is the start of a new entry.
Field 2 - ifname
This field indicates that ifname is the name of the network interface being described.
Property Entry
Field 1 - prop
The keyword prop indicates this is a property entry.
Field 2 - key
This field contains one of the following values for the key keyword:
addrtype
Type of address.
iftype
Type if interface. One of the following:
physical
An actual physical interface.
virtual
A virtual interface.
hostaddr
Host address (usually IP) of the interface.
hostname
Host name of the interface.
netaddr
Network address (usually IP) of the interface.
netname
Network name of the interface.
macaddr
Current MAC address of the interface.
macname
Current MAC address name of the interface.
facmacaddr
Factory MAC address of the interface.
facmacname
Factory MAC address name of the interface.
mediatype
The type of media. i.e. "ethernet", "fddi", etc.
mediasubtype
The sub type of media. i.e. "100-base-T", "1000-base-TX", etc.
netmask
Network mask for this address in quaded dot format.
broadcast
Network broadcast address for this interface.
mtu
The MTU Size.
speed
The current link speed.
duplex
The current link duplex, either full or half.
flag
This 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.
Field 3 - description
This field contains a verbose description of this property.
Field 4 - value
This field contains the actual value of this property.

 

Class Network

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

Field 0 - network
The word network specifies the usage described in this section.
Field 1 - Reserved
This field is reserved for future use.
Field 2 - keyword
This field contains one of the following unique keywords:
defgwip
Default gateway IP address.
defgwname
Default gateway hostname.
dnsdomain
DNS domain name.
dnsserverips
DNS Server IP addresses (comma seperated).
dnsservernames
DNS Server hostnames (comma seperated).
nisdomain
NIS (formerly YP) domain name.
nisservermethod
The 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.
nisserverips
The comma seperated list of IP addresses of NIS servers. Applies only when the nisservermethod is static.
nisservernames
The comma seperated list of hostnames of NIS servers. Applies only when the nisservermethod is static.
nisserver
The name of the currently bound NIS server.
nismaster
The name of the master NIS server for this domain.
Field 3 - description
This field contains a verbose description of this property.
Field 4 - value
This field contains the actual value of this property.

 

Class partition

When Field 0 is set to partition, information on filesystems and partitions are reported as follows:
Field 0 - partition
The word partition describes this entry.
Field 1 - name
The word name indicates that this is a canonical partition definetion.
Field 2 - Device Path
The full pathname of this entry's device. i.e. /dev/sda1
Field 3 - Device Name
The name of this partition entry relative to the Device Name/Path. i.e sda1
Field 4 - Base Name
The base filename of the Device Name or Path. i.e. sda1
Field 5 - Partition Number
The numeric partition number relative to this Device Name/Path. i.e. 1
Field 6 - Raw Device Path
The pathname of the raw device for this entry. i.e. /dev/rsda1
Field 7 - Type Name
A short name describing the type of partition this is. i.e. EXTDOS, ufs.
Field 8 - Type Description
A more verbose description of the type of partition. i.e. Extended DOS.
Field 9 - Type Number
A numeric value representing the partition type.
Field 10 - Usage Status
Description of how this partition is being used. i.e. FILESYSTEM, SWAP
Field 11 - Mount Name
If this partition contains a filesystem, then this field describes the mounted name of the partition. i.e. /export
Field 12 - Mount Options
If this is a mounted filesystem, this field describes any options used to mount the filesystem.
Field 13 - Size
The total size of this partition in bytes.
Field 14 - Amount Used
The total amount of used space on this partition in bytes.
Field 15 - Sector Size
The size of a single sector in bytes.
Field 16 - Starting Sector
The sector number this partition starts on.
Field 17 - Ending Sector
The sector number this partition ends on.
Field 18 - Number of Sectors
The total number of sectors this partition uses.

 

Class printer

When Field 0 is set to printer, the information being described is that of a printer queue. There are multiple forms of a printer entry. Each form is specified by the Field 1 Sub-Class field and is described in it's entirety below:

Canonical definetion of a printer:
Field 0 - printer
The word printer specifies this entry.
Field 1 - name
The word name indicates that this entry contains the primary information regarding a printer.
Field 2 - Queue
The canonical name of this printer queue.
Field 3 - Aliases
A comma seperated list of aliases for this printer.
Field 4 - Description
A text description of this printer queue. The format is usually site dependent.
Field 5 - Vendor
The name of the vendor who manufactures or sells this printer.
Field 6 - Model
The model of printer.
Field 7 - Protocol
The 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.
Field 7 - Device
The name or path of the local device, if any, on which the printer is attached.
Field 8 - Server
The name of the remote server, if any, which provides service for the printer.
Field 9 - RemoteQueue
The name of the remote queue on the remote Server
Field 10 - Languages
A comma seperated list of printer languages which the printer supports.
Field 11 - SpoolDir
The name of the local directory used for spooling print jobs for the printer queue.
Field 12 - MaxJobSize
The maximum sized job accepted for the printer queue.

Additional information:
Field 0 - printer
The word printer specifies the usage described in this section.
Field 1 - desc
This entry provides additional, unclassified descriptive information about a printer entry.
Field 2 - Name
Specifies the name of the printer.
Field 3 - Description
The description of the entry.
Field 4 - Value
The value of the description.

 

Class software

When Field 0 is set to software, the information being described are individual software packages. There are multiple forms of a software entry. Each form is specified by the Field 1 Sub-Class field and is described in it's entirety below:

Canonical definetion of a software package:
Field 0 - software
The word software specifies the usage described in this section.
Field 1 - name
The canonical definetion of a software package.
Field 2 - Name
Specifies the name of this software package.
Field 3 - Type
Specifies the type of software entry as follows:
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).
Field 4 - Name
Specifies the name of this software package. This is a duplicate of field 2.
Field 5 - Version
The version of this software entry.
Field 6 - Revision
The revision of this software entry.
Field 7 - Desc
A brief (single-line) description of this software entry.
Field 8 - URL
A URL associated with this software entry.
Field 9 - License
License information about this entry.
Field 10 - Category
A software category this entry is associated with.
Field 11 - SubCategory
A software sub-category this entry is associated with.
Field 12 - OS Name
The name of the operating system (OS) this software runs on.
Field 13 - OS Version
The OS version this software runs on.
Field 14 - Arch
The CPU architecture this software runs on. i.e. i386, SPARCV8
Field 15 - ISArch
The instruction set architecture (platform) this software runs on. This is the more general platform of which the Arch is a member. i.e. IA-32, SPARC
Field 16 - Install Date
The date the software was installed.
Field 17 - Build Date
The date the software was built and packaged.
Field 18 - Production Stamp
Some type of identifier generated by the software producer.
Field 19 - Base Dir
The base directory under which the software is installed.
Field 20 - Disk Usage
The amount of disk space this software requires for installation.
Field 21 - Vendor Name
The name of the vendor who produced the software.
Field 22 - Vendor Email
The vendor's email address.
Field 23 - Vendor Phone
The vendor's phone number.
Field 24 - Vendor Stock
The vendor's stock/identifier for this software.
Field 25 - Master Name
The name of the software entry to which this entry belongs. Typically this is the package's product entry.
Field 26 - Master Version
The master's version.
Field 27 - Master Revision
The master's revision.
Field 28 - Desc Verbose
A verbose description describing the product. Newlines are indicated by \n strings embedded in the field.
Field 29 - Copyright
A copyright statement for the product. Newlines are indicated by \n strings embedded in the field.
Field 30 - Next
The name of the next software entry in the hierarchy.
Field 31 - Slaves
A comma seperated list of software entries for which this entry is the parent.
Field 32 - PkgDeps
A comma seperated list of package names + version for which this package depends upon.

Software file information associated with each software package:

The +swfiles option must be specified to enable this data output.

Field 0 - software
Field 1 - file
Field 2 - pkgname
The name of the package this entry belongs to.
Field 3 - type
The type of file entry:
File
Directory
Hard-link
Symbolic-Link
Character-Device
Black-Device
Field 4 - path
The pathname of the file entry.
Field 5 - linkto
If the entry is a symlink, this field specifies what the link points at.
Field 6 - size
The size of the file in bytes.
Field 7 - md5
The MD5 checksum.
Field 8 - checksum
A platform specific checksum.
Field 9 - pkgnames
List of all package names to which this entry belongs.

Additional information:
Field 0 - software
The word software specifies the usage described in this section.
Field 1 - desc
This entry provides additional, unclassified descriptive information about a software entry.
Field 2 - Name
Specifies the name of this software package.
Field 3 - Description
The description of the entry.
Field 4 - Value
The value of the description.

 

Class sysconf

When Field 0 is set to sysconf, the following describes the usage of each field:
Field 0 - sysconf
The word sysconf specifies the usage described in this section.
Field 1 - unused
This field is unused.
Field 2 - Variable
Names the variable being described. The variable matches the valid values for -show variable.
Field 3 - Description
Descriptive text of the variable.
Field 4 - Value
The value of this entry.

 

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/config    - Directory of config files
 

SEE ALSO

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


 

Index

NAME
SYNOPSIS
DESCRIPTION
Class device
Class general
Class kernel
Class license
Class NetIf
Class Network
Class partition
Class printer
Class software
Class sysconf
NOTES
AUTHOR
URL
FILES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 16:24:15 GMT, May 20, 2003