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 # | Content | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
0 | Class |
This field names the
class of information being provided. Values
correspond explicitly to
--class arguments.
Valid values are:
| ||||||||||||||||||||||
1 | Sub-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.
| ||||||||||||||||||||||
2 | Variable | Specifies the name of a variable which the remaining fields describe. | ||||||||||||||||||||||
3 | Value | Specifies a value of some type. | ||||||||||||||||||||||
4 | ... | The remaining fields vary in number and content based upon the Field 0 - Class value. |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | device | The word
device
specifies the usage described in this section.
| device |
1 | name | The canonical definetion of a device. | name |
2 | Name | Specifies the name of this device. | c0t0d0 |
3 | Alt Name | A alternative name by which this device is known. | sd0 |
4 | Master Name | The name of this device's master. | ctlr0 |
5 | File List | A comma seperated list of filenames associated with this device. | /dev/dsk/c0t0d0s0,/dev/dsk/c0t0d0s2 |
6 | Type Name | A name describing the type of device.
Each name corresponds to DT_* and DTN_* values in
mcsysinfo.h. | diskdrive |
7 | Type Description | A more verbose description of the type of device. | Disk Drive |
8 | Model | A short description specifying the device's model. | ST123456 |
9 | Model Description | A more descriptive version of the device model. | ATA |
10 | Unit | The device's unit number. | 0 |
11 | Address | Obsolete. | |
12 | Prio | Obsolete. | |
13 | Vec | Obsolete. | |
14 | Node ID | The device's unique node ID relative to the OS. | 0x12345 |
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.
| SCSI |
16 | Class Description | A more verbose description of the device's class. | |
17 | Vendor | The name of the device's vendor. | Seagate |
18 | Serial # | The device's serial number. | A1234543 |
19 | Revision | The revision of the device. | A01 |
20 | Identifier | The device's identifier. | |
21 | Part # | The part number of the device as assigned by the manufacturer. | X1234A |
22 | Next Name | The name of the next device (relative to the parent) of the device hierarchy tree. | c0t1d0 |
23 | Child Names | The comma seperated list of slave (children) device node names of the device hierarchy. | |
24 | Capacity | The capacity (size) of the device in device specific units. | 64 GB |
25 | Speed | The speed of the device in device specific units. | 320 MB/s |
26 | Bus | The bus number the device is attached to. | 0 |
27 | DevNum | The device number which identifies the device. | 0 |
28 | Port | The port number the device is connected to on the bus. | 0 |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | device | The word
device
specifies the usage described in this section. | device |
1 | cpuinfo | The word
cpuinfo
further specifies the usage described in this section. | cpuinfo |
2 | Name | Specifies the device name for this entry. | sd0 |
3 | Man | The name of the manufacturer of this CPU. | Intel |
4 | Model | The model of CPU. | Pentium-4 |
5 | Arch | The architecture of the CPU. | i686 |
6 | ArchVer | The version of the CPU's architecture. | IA32 |
7 | Serial | The serial number of the CPU. | ABC123456 |
8 | BitSize | The bitsize of the CPU. | 32 |
9 | Speed | The clock speed of the CPU. | 1.1 GHz |
10-25 | | These fields are obsolete. | |
26 | Has FPU | Value of
1 if a Floating Point Unit (FPU) is present. | 1 |
27 | Stepping | The CPU's stepping value. | 30 |
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 # | Keyword | Description | Example | ||||||
---|---|---|---|---|---|---|---|---|---|
0 | device | The word
device
specifies the usage described in this section. | device | ||||||
1 | cacheinfo | The word
cacheinfo
further specifies the usage described in this section. | cacheinfo | ||||||
2 | Name | Specifies the name of the processor device to which this cache is associated. | cpu0 | ||||||
3 | CacheName | Specifies the name of the cache which is unique to the device. | L1 Inst | ||||||
4 | Size | The size of the cache. | 64 KB | ||||||
5 | Associativety | The associativety of the cache. | 2 | ||||||
6 | Lines | The number of lines of the cache. | 1 | ||||||
7 | Line Size | The size of each cache line. | 64 | ||||||
8 | TLB | The CPU's instruction TLB. | 32 | ||||||
9 | TLB Associativety | The CPU's instruction TLB associativety. | 32 | ||||||
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. | 1 | ||||||
11 | Type | The type of cache:
| 2 | ||||||
12 | Level | The level of cache. | 1 | ||||||
13 | Speed | The speed of the cache in nano-seconds. | 200 | ||||||
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. | 0 | ||||||
15 | Location | The location of the cache. | onboard | ||||||
16 | SramType | The type of SRAM present. | Pipeline Burst | ||||||
17 | EccType | The type of Error Correction used. | Parity | ||||||
18 | Mode | The mode of operation of the cache. | Write Back |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | device | The word
device
specifies the usage described in this section. | device |
1 | desc | This entry provides additional, unclassified descriptive information about this entry. | desc |
2 | Name | Specifies the name of this entry. | vendorPart |
3 | Description | The description of the entry. | Vendor Specific Part Number |
4 | Value | The value of the description. | X1234A |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | device | The word
device
specifies the usage described in this section. | device |
1 | desc | The word
desc
specifies the usage described in this section. | desc |
2 | If | The system name of the network interface. | eth0 |
3 | internet | The word
internet
specifies the type of address being described. | internet |
4 | HostAddr | The host address (usually IP) of the interface. | 10.1.2.3 |
5 | HostName | The host name of the interface. | fritz |
6 | NetAddr | The network address (usually IP) of the interface. | 10.1.0.0 |
7 | NetName | The network name of the interface. | corpnet |
8 | MACaddr | The current MAC address of the interface. | 0:8:20:a:b:c |
9 | MACname | The current MAC address name of the interface. | fritz-eth0 |
10 | FacMACaddr | The factory MAC address of the interface. | 0:8:20:a:b:c |
11 | FacMACname | The factory MAC address name of the interface. | fritz-eth0 |
12 | NetMask | The network mask for this address in quaded dot format. | 255.255.0.0 |
13 | Broadcast | The network broadcast address for this interface. | 255.255.255.255 |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | filesys | The word
filesys
specifies the usage described in this section.
| filesys |
1 | name | The word
name
specifies the usage described in this section.
| name |
2 | Name | The 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 # | Keyword | Description | Example | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
0 | filesys | The word
filesys
specifies the usage described in this section.
| filesys | ||||||||||||||||||||||
1 | prop | The word
prop
specifies the usage described in this section.
| prop | ||||||||||||||||||||||
2 | Name | The name of the filesystem about to be described. | /tmp | ||||||||||||||||||||||
3 | Keyword | This field contains a fixed set of keywords as follows:
| | ||||||||||||||||||||||
4 | Description | A description of this entry type. | Mount Location | ||||||||||||||||||||||
5 | Data | The actually data (value) for this entry. | ufs |
When
Field 0
is set to
general
,
the following describes the usage of each field:
Table 9. Format of general
Information
Field # | Keyword | Description | Example |
---|---|---|---|
0 | general | The word
general
specifies the usage described in this section.
| general |
1 | unused | This field is unused. | |
2 | Keyword | A fixed name keyword used to uniquely identify this
type of data.
The keywords matches the valid values for
--show
variable. | osname |
3 | Description | Descriptive text of what this entry contains. | OS Name |
4 | Value | The value of this entry. | Solaris |
When
Field 0
is set to
kernel
,
the following describes the usage of each field:
Table 10. Format of kernel
Information
Field # | Keyword | Description | Example |
---|---|---|---|
0 | kernel | The word
kernel
specifies the usage described in this section.
| kernel |
1 | unused | This field is unused. | |
2 | Variable | Names the variable being described.
The keywords matches the valid values for
--show
variable . | maxproc |
3 | Description | Descriptive text of Variable . | Maximum Processes |
4 | Value | The value of this entry. | 500 |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | license | The word
license
specifies the usage described in this section.
| license |
1 | name | The word
name
specifies the usage described in this section.
| name |
2 | Name | The 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 # | Keyword | Description | Example | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
0 | license | The word
license
specifies the usage described in this section.
| license | ||||||||||||||||||||||||||||||||||
1 | prop | The word
prop
specifies the usage described in this section.
| prop | ||||||||||||||||||||||||||||||||||
2 | Name | The name of the license this property applies to. | StarOffice | ||||||||||||||||||||||||||||||||||
3 | Keyword | This field contains a fixed set of keywords as follows:
| |||||||||||||||||||||||||||||||||||
4 | Description | The description for this property type. | Software Version | ||||||||||||||||||||||||||||||||||
5 | Value | The property value for this entry. | 1.1 |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | netif | The word
netif
specifies the usage described in this section.
| netif |
1 | name | The word
name
specifies the usage described in this section.
| name |
2 | Name | The 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 # | Keyword | Description | Example | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
0 | netif | The word
netif
specifies the usage described in this section.
| netif | ||||||||||||||||||||||||||||||||||||
1 | prop | The word
prop
specifies the usage described in this section.
| prop | ||||||||||||||||||||||||||||||||||||
2 | Name | The name of the netif this property applies to. | eth0 | ||||||||||||||||||||||||||||||||||||
3 | Keyword | This field contains a fixed set of keywords as follows:
| |||||||||||||||||||||||||||||||||||||
4 | Description | The description for this property type. | Address Type | ||||||||||||||||||||||||||||||||||||
5 | Value | The property value for this entry. | Internet |
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 # | Keyword | Description | Example | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
0 | network | The word
network
specifies the usage described in this section.
| network | ||||||||||||||||||||||
1 | Reserved | This field is reserved for future use. | | ||||||||||||||||||||||
2 | Keyword | This field contains a fixed set of keywords as follows:
| |||||||||||||||||||||||
3 | Description | The description for this property type. | DNS Domain | ||||||||||||||||||||||
4 | Value | The property value for this entry. | foo.com |
The Partition class provides information about disk partitions on a system. The format is as follows:
Table 16. Format of a partition
Entry
Field # | Keyword | Description | Example |
---|---|---|---|
0 | partition | The word
partition
specifies the usage described in this section.
| partition |
1 | name | The word
name
specifies the usage described in this section.
| name |
2 | Device Path | The full pathname of this entry's device. | /dev/sda1 |
3 | Device Name | The name of this partition entry relative to the
Device Path . | sda1 |
4 | Base Name | The base filename of the Device Name or Path. | sda1 |
5 | Partition Number | The numeric partition number relative to this
Device Name/Path | 1 |
6 | Raw Device Path | The pathname of the raw device for this entry. | /dev/rsda1 |
7 | Type Name | A short name describing the type of partition this is. | EXTDOS , ufs |
8 | Type Description | A more verbose description of the type of partition. | Extended DOS |
9 | Type Number | A numeric value representing the partition type. | 83 |
10 | Usage Status | Description of how this partition is being used. | FILESYSTEM , SWAP |
11 | Mount Name | If this partition contains a filesystem, then this field describes the mounted name of the partition. | /export |
12 | Mount Options | If this is a mounted filesystem, this field describes any options used to mount the filesystem. | rw,quota |
13 | Size | The total size of this partition in bytes. | 5010000 |
14 | Amount Used | The total amount of used space on this partition in bytes. | 201000 |
15 | Sector Size | The size of a single sector in bytes. | 512 |
16 | Starting Sector | The sector number this partition starts on. | 54 |
17 | Ending Sector | The sector number this partition ends on. | 10054 |
18 | Number of Sectors | The total number of sectors this partition uses. | 10000 |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | printer | The word
printer
specifies the usage described in this section.
| printer |
1 | name | The word
name
specifies the usage described in this section.
| name |
2 | Queue | The canonical name of this printer queue. | fastcolor1 |
3 | Aliases | A comma seperated list of aliases for this printer. | bucket,bolts |
4 | Description | A text description of this printer queue. The format is usually site dependent. | Acme EZ100 Color Printer in room 101 |
5 | Vendor | The name of the vendor who manufactures or sells this printer. | Acme |
6 | Model | The model of printer. | EZ100 |
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).
| |
8 | Device | The name or path of the local device, if any, on which the printer is attached. | /dev/lp0 |
9 | Server | The name of the remote server, if any, which provides service for the printer. | printsrv1 |
10 | RemoteQueue | The name of the remote queue on the remote Server | fastcolor1 |
11 | Languages | A comma seperated list of printer languages which the printer supports. | PS |
12 | SpoolDir | The name of the local directory used for spooling print jobs for the printer queue. | /var/spool/print/fastcolor1 |
13 | MaxJobSize | The maximum sized job accepted for the printer queue. | 500000 |
Table 18. Format of a printer
desc
Entry
Field # | Keyword | Description | Example |
---|---|---|---|
0 | printer | The word
printer
specifies the usage described in this section. | printer |
1 | desc | The word
desc
specifies the usage described in this section. | desc |
2 | Name | The name of the printer. | fastcolor1 |
3 | Description | The description of the entry. | Color Ink Type |
4 | Value | The value of the description. | messy |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | siteinfo | The word
siteinfo
specifies the usage described in this section.
| siteinfo |
1 | name | The word
name
specifies the usage described in this section.
| name |
2 | Variable | The 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 # | Keyword | Description | Example |
---|---|---|---|
0 | siteinfo | The word
siteinfo
specifies the usage described in this section.
| siteinfo |
1 | prop | The word
prop
specifies the usage described in this section.
| prop |
2 | Variable | The unique variable name identifying this property. | Location |
3 | Key | A predefined keyword which identifies the type of data. Valid values are:
Var (Variable),
Desc (Description),
Value (Value).
| Var |
4 | Description | A description of what the Key means. | Variable |
5 | Value | The property value. | Room-101 |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | software | The word
software
specifies the usage described in this section.
| software |
1 | name | The word
name
specifies the usage described in this section.
| name |
2 | Name | The canonical name of this software package or product. | glib |
3 | Type | The 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 |
4 | Name | The name of this software package. This is a duplicate of field 2. | glib |
5 | Version | The version of this software entry. | 2.2 |
6 | Revision | The revision of this software entry. | 5 |
7 | Desc | A brief (single-line) description of this software entry. | The GNU C library. |
8 | URL | A URL associated with this software entry. | http://www.gnu.org |
9 | License | License information about this entry. | The GNU GPL license applies. |
10 | Category | A software category this entry is associated with. | library |
11 | SubCategory | A software sub-category this entry is associated with. | general |
12 | OS Name | The name of the operating system (OS) this software runs on. | linux |
13 | OS Version | The OS version this software runs on. | 2.4 |
14 | Arch | The CPU architecture this software runs on. | i386 |
15 | ISArch | The instruction set architecture (platform) this software runs on.
This is the more general platform of which the
Arch
is a member. | IA32 |
16 | Install Date | The date the software was installed. | 1049489752 |
17 | Build Date | The date the software was built and packaged. | 1029489752 |
18 | Production Stamp | Some type of identifier generated by the software producer. | porky.devel.redhat.com |
19 | Base Dir | The base directory under which the software is installed. | /usr/lib |
20 | Disk Usage | The amount of disk space this software requires for installation (bytes). | 347311 |
21 | Vendor Name | The name of the vendor who produced the software. | Red Hat, Inc. |
22 | Vendor Email | The vendor's email address. | [email protected] |
23 | Vendor Phone | The vendor's phone number. | +1-408-555-1212 |
24 | Vendor Stock | The vendor's stock/identifier for this software. | X1234A |
25 | Master Name | The name of the software entry to which this entry belongs. Typically this is the package's product entry. | System Environment/Libraries |
26 | Master Version | The master's version. | 7.2 |
27 | Master Revision | The master's revision. | 5 |
28 | Desc Verbose | A verbose description describing the product. Newlines are indicated
by
\n
strings embedded in the field. | A very\ngood general C library. |
29 | Copyright | A copyright statement for the product. Newlines are indicated by \n strings embedded in the field. | Copyright Red Hat Inc.\nAll rights reserved. |
30 | Next | The name of the next software entry in the hierarchy. | bzip2-libs |
31 | Slaves | A comma seperated list of software entries for which this entry is the parent. | libcutil |
32 | PkgDeps | A 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 # | Keyword | Description | Example | ||||||
---|---|---|---|---|---|---|---|---|---|
0 | software | The word
software
specifies the usage described in this section.
| software | ||||||
1 | file | The word
file
specifies the usage described in this section.
| file | ||||||
2 | Name | The canonical name of the software package or product. | glib | ||||||
3 | type | The type of file entry:
| File | ||||||
4 | path | The pathname of the file entry. | /usr/lib/libc.so | ||||||
5 | linkto | If the entry is a symlink, this field specifies what the link points at. | /usr/lib/libc.so.3 | ||||||
6 | size | The size of the file in bytes. | 893100 | ||||||
7 | md5 | The MD5 checksum. | abcdefawd230982434asdf | ||||||
8 | checksum | A platform specific checksum. | 100343 | ||||||
9 | pkgnames | List of all package names to which this entry belongs. | glib |
Table 23. Format of a software
desc
Entry
Field # | Keyword | Description | Example |
---|---|---|---|
0 | software | The word
software
specifies the usage described in this section. | software |
1 | desc | The word
desc
specifies the usage described in this section. | desc |
2 | Name | The name of the software. | glib |
3 | Description | The description of the entry. | Software Passed QA? |
4 | Value | The value of the description. | YES |
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 # | Keyword | Description | Example |
---|---|---|---|
0 | sysconf | The word
sysconf
specifies the usage described in this section. | sysconf |
1 | unused | This field is unused. | |
2 | Variable | Names the variable being described.
The variable matches the valid values for
--show
variable . | _SC_OPEN_MAX |
3 | Description | Description of what this variable means. | Max open files per process |
4 | Value | The value of this entry. | 1024 |