sysinfo - MagniComp(tm) SysInfo command displays system
information in a platform neutral manner
SYNOPSIS
sysinfo [ -configdir DirName ] [ -configfile FileName ] [
-class item1,item2,... ] [ -danger ] [ -format FormatType
] [ -msgclass msgclass1,msgclass2,... ] [ -msglevel
msglevel1,msglevel2,... ] [ -offset amount ] [ -repsep
string ] [ -show item1,item2,... ] [ +|-swfiles ] [ -type
type1,type2,... ] [ +|-unknown ] [ +|-unused ] [ +|-usec-
onfig ] [ +|-useprom ]
sysinfo -list [ class|format|msgclass|msglevel|show|type ]
sysinfo -version
DESCRIPTION
The MagniComp(tm) SysInfo program displays various types
of information about the local host's hardware and operat-
ing system (OS) software. It is intended to provide
information in both human readable and program parsable
formats. System Administrators can use MagniComp(tm) Sys-
Info to obtain hardware asset information and OS configu-
ration information. Programs which use MagniComp(tm) Sys-
Info can obtain this information in a platform independent
manner.
The amount of information displayed varies by operating
system. Here are some of the types of information that
may be provided:
- Host name
- Host name aliases
- Host network addresses
- Host ID
- System serial number
- Manufacturer of the system's hardware
- System model name
- CPU type
- Application architecture
- Kernel architecture
- Amount of main memory
- Operating system name
- Operating system version
- Kernel version
- Information about devices
- Kernel parameters
- System configuration parameters
- Installed software packages
By default, MagniComp(tm) SysInfo will display a "medium"
level of output suitable for a quick glance at system con-
figuration information. The -msglevel all option provides
classes using the ``-class Name'' option. Further selec-
tion can by made specifying the class of information and a
specific item using ``-class Name -show Item''
Upon startup, MagniComp(tm) SysInfo searches for a config-
uration file to parse. If the -configfile option is
given, the specified configuration file will be used.
Otherwise MagniComp(tm) SysInfo will search for a suitable
configuration file. Searching stops when the first con-
figuration file is found. The following search order is
used:
/etc/sysinfo.cf
ConfDir/${OSname}_${OSver}.cf
ConfDir/${OSname}_${OSmajver}.cf
ConfDir/${OSname}.cf
ConfDir/Default.cf
ConfDir is /opt/sysinfo/config by default, but can be
overridden with the -configdir option or by specifying
ConfDir Dir
in the /etc/sysinfo.cf file. See sysinfo.cf(5) for more
information.
If the file /etc/sysmodel exists, the first line of the
file is read and used as the system model name.
OPTIONS
-cfdir DirName
This option is obsoleted by the -configdir option.
-cffile FileName
This option is obsoleted by the -configfile option.
-configdir DirName
Specify the name of the directory to use to find
sysinfo.cf format configuration files.
-configfile FileName
Specify the name of a sysinfo.cf format configura-
tion file to use. If the specified FileName cannot
be opened for any reason, an error message is dis-
played and the program will exit.
-class Name1,Name2,...
Limit information to a specific class or classes of
information. The default class is General.
-danger
Normally MagniComp(tm) SysInfo checks upon startup
some platforms)) as it was built on. This option
overrides/disables this check. Using this option
usually means that the information provided may be
false or incomplete.
-format FormatType
Display output in FormatType format. Valid Format-
Type values are:
pretty Output is suitible for human viewing. This
is the default.
report Output is in a format suitable for parsing
by a program. Entries are printed one per
line with fields seperated by ``|'' (verti-
cal pipe) by default. The -repsep option
can be used to change this value.
-msgclass msgclass1,msgclass2,...
Specify which class of messages should be output.
The default value for -msgclass is info,warn,cer-
ror. The list of possible msgclass values are:
all All of the below classes except for debug.
info Display normal informational messages. All
the actual useful bits of information about
your system are output as msgclass info.
warn Display warning messages about any condition
that occured while MagniComp(tm) SysInfo is
running which may affect what information is
found. Normally these are problems such as
MagniComp(tm) SysInfo not running with the
right permissions or certain things are
missing from the system which are not
required, but may result in incomplete
information.
gerror Display general error messages. These are
non-fatal errors which are usually quite
normal. For instance, a certain type of
query (such as a ioctl() call) of a device
fails because it's not supported on that
particuliar model.
cerror Display critical errors which prevent Magni-
Comp(tm) SysInfo from continuing further.
debug Print debugging information. Lots of infor-
mation you normally don't want to see, but
which is very valuable for debugging prob-
Set the level of messages that are shown.
msglevels is a comma separated list of values used
to determine what levels of message will be dis-
played. The list of possible msglevel values are:
all All possible levels of information. This
option provides the maximum amount of
detailed information about a system.
terse Display output in terse format. The affect
of this option is dependent on the Class of
information being displayed. It usually
results in the labels for each output value
being suppressed. This is useful if you are
running MagniComp(tm) SysInfo from a script
to obtain a few specific values (e.g. System
Model, CPU Architecture, etc).
brief More than terse but less than all.
general
General level of information useful for a
quick look at overall system configuration.
This is the default.
descriptions
Like general but with more descriptive
information.
config Similiar to general and descriptions
-list [ class|format|msgclass|msglevel|show|type ]
List the possible values that may be used with an
option. With no arguments are specified, a list is
valid arguments is displayed. When an argument is
supplied, the information specific to that argument
is displayed.
-offset amount
Set the number of spaces to offset (indent) when
printing device information.
-repsep string
Change the field seperator string used with -format
report to be string. The default is ``|'' (verti-
cal pipe).
-show item1,item2,...
Show information only about each comma separated
item. Run sysinfo -list show for a list of valid
item arguments. If the -class option is not speci-
fied, then the General class is assumed.
When +swfiles is specified and software class
information is being displayed, a list of files and
file data is displayed for all files belonging to
each package. The default is (-swfiles) not to
display file data.
-type item1,item2,...
Limit information to a specific type of item as
specified by item1,item2,... Run sysinfo -list
type for a list of valid item arguments.
+|-unknown
Enable (+unknown) or disable (-unknown) showing
devices that appear to be present on the system,
but are not "known" to MagniComp(tm) SysInfo. This
option is disabled by default.
+|-unused
Enable (+unused) or disable (-unused) showing par-
titions that do not appear to be in use. The
default is -unused.
+|-useconfig
Enable (+useconfig) or disable (-useconfig) use of
configuration files. This option is useful if you
want to run MagniComp(tm) SysInfo without having
the configuration files installed. Note that only
certain types of information - such as some of the
General values - will be available without use of
configuration files. The default is +useconfig.
+|-useprom
Enable (+useprom) or disable (-useprom) using val-
ues obtained from the system PROM instead of
intepreting values obtained directly from the ker-
nel. Certain values are normally obtained by look-
ing up a variable in the kernel and checking the
result against a table of values compiled into Mag-
niComp(tm) SysInfo. By enabling this option, Mag-
niComp(tm) SysInfo will attempt to obtain certain
values from the system PROM. This support is cur-
rently limited to the System Model value. Support
is also limited to those machines which support
such a system PROM.
-version
Show version information for MagniComp(tm) SysInfo.
EXAMPLES
The following command displays the maximum amount of
information about a system:
sysinfo -msglevel all
SysInfo is:
sysinfo -msglevel all -msgclass all,debug
The following example outputs just the System Model:
sysinfo -msglevel terse -show model
This command will limit the output to just information
about Kernel variables:
sysinfo -class kernel
FORMAT REPORT
The output from -format report is intended to be most
parsable by software, not humans. The report format con-
sists 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> charac-
ters). An empty field consists of no characters or only
white-space appearing between field seperators. The con-
tent 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.
partition
Filesystem and disk partition configuration
information.
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
tion for an entry.
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 dis-
covered.
Field 2 - Variable
Specifies the name of a variable which the remain-
ing 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 speci-
fied 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 associ-
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 obso-
lete.
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 mcsys-
info.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.
The device's identifier.
Additional information:
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.
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.
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 partition
When Field 0 is set to partition, information on filesys-
tems and partitions are reported as follows:
Field 0 - partition
The word partition describes this entry.
Field 1 - name
This values indicates that this is a canonical par-
tition entry.
Field 2 - Device Path
The full pathname of this entry's device.
Field 3 - Device Name
The canonical name of the device.
Field 4 - Base Name
The base filename of the Device Name or Path.
Field 5 - Partition Name
The name of this partition entry relative to the
Device Name/Path .
Field 6 - Partition Number
The numeric partition number relative to this
Device Name/Path .
Field 7 - Raw Device Path
The pathname of the raw device for this entry.
Field 8 - 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 parti-
tion. i.e. Extended DOS .
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 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 speci-
fied by the Field 1 Sub-Class field. Each form 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 pack-
age.
Specifies the name of this software package.
Field 3 - Type
Specifies the type of software entry as fol-
lows:
pkg The entry is a software package, the
lowest level component.
product
The entry represents an entire soft-
ware product which is typically com-
posed of one or more software pack-
ages (pkg).
Field 4 - Version
The version of this software entry.
Field 5 - Revision
The revision of this software entry.
Field 6 - Desc
A brief (single-line) description of this
software entry.
Field 7 - URL
A URL associated with this software entry.
Field 8 - License
License information about this entry.
Field 9 - Category
A software category this entry is associated
with.
Field 10 - SubCategory
A software sub-category this entry is asso-
ciated with.
Field 11 - OS Name
The name of the operating system (OS) this
software runs on.
Field 12 - OS Version
The OS version this software runs on.
Field 13 - Arch
The CPU architecture this software runs on.
i.e. i386, SPARCV8
Field 14 - ISArch
The instruction set architecture (platform)
ber. i.e. IA-32, SPARC
Field 15 - Install Date
The date the software was installed.
Field 16 - Build Date
The date the software was built and pack-
aged.
Field 17 - Production Stamp
Some type of identifier generated by the
software producer.
Field 18 - Base Dir
The base directory under which the software
is installed.
Field 19 - Disk Usage
The amount of disk space this software
requires for installation.
Field 20 - Vendor Name
The name of the vendor who produced the
software.
Field 21 - Vendor Email
The vendor's email address.
Field 22 - Vendor Phone
The vendor's phone number.
Field 23 - Vendor Stock
The vendor's stock/identifier for this soft-
ware.
Field 24 - Master Name
The name of the software entry to which this
entry belongs. Typically this is the pack-
age's product entry.
Field 25 - Master Version
The master's version.
Field 26 - Master Revision
The master's revision.
Additional information:
Field 0 - software
The word software specifies the usage
described in this section.
Field 1 - desc
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
Michael A. Cooper
MagniComp
http://www.MagniComp.com
HOME PAGE
http://www.magnicomp.com/sysinfo
FILES
/opt/sysinfo/config - Directory of config files
SEE ALSO
mcsysinfo(3), sysinfo.cf(5), gethostid(2), gethostname(2),
gethostbyname(3)
DIAGNOSTICS
%x: Unknown CPU type.
The CPU model for the current host could not be
determined.
(unknown)
Information could not be determined for this item.
BUGS
Not all operating systems support interfaces to various
pieces of information that MagniComp(tm) SysInfo supports.
Some devices, mostly devices that use removable media such
as tape drives and floppy disks, are only indicated
(shown) as present if media is loaded in the device and
it's on-line. This occurs because the OS does not provide
a software interface to query the device when media is not
loaded.
SunOS allows only one process at a time to have /dev/open-
prom open. This may result in certain pieces of informa-
tion not always showing up consistantly. When in doubt,
enable debugging (-msgclass debug).
Under SunOS 5.4 the ROM Version field is blank. This is
due to a change made by Sun in libkvm. Sun patch
102555-01 is suppose to fix this problem. MagniComp(tm)
Sysinfo uses a new OBP interface in SunOS 5.5 that by-
passes this problem.
Under SunOS 4.x the Serial Number field is left blank
since the kernel usually returns incorrect information.
Under SunOS 5.x the Serial Number field will show the
serial number as obtained from the system's IDPROM. This
serial number has no correspondence with the system serial
number that appears on the back of your machine.
Under SunOS there is no way to tell the difference between
an MC68020 (like the 3/60) and MC68030 (like the 3/80)
based machine.