Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SYSINFO(8)		    System Manager's Manual		    SYSINFO(8)

NAME
       sysinfo -- utility used to gather system	configuration information

SYNOPSIS
       sysinfo [-a] [-c] [-d] [-h] [-i]	[-v [level]] module ...

DESCRIPTION
       The sysinfo utility is a	shell script, the purpose of which is to auto-
       matically gather	system information and document	the hardware and soft-
       ware configuration of the given host system running FreeBSD.

       The  goal  is to	provide	a system operator with descriptive information
       about an	unknown	FreeBSD	installation.

       The following options are available:

       -a	   Display complete  system  information,  i.e.	 run  all  the
		   available modules.  See below.

       -c	   Toggle colorful output (useful when using less or redirect-
		   ing the output to a file).

       -d	   Toggle debug	messages.

       -h	   Display usage information.

       -i	   Toggle info messages.

       -v [level]  Set	the verbose level.  Supported values are 0 and 1.  The
		   verbose level will be set to	1 if no	argument is specified.
		   The default is 0 (no	verbose	output).

       module	   Display the system information  related  to	the  specified
		   subsystem  type.  All of the	specified modules will be run.
		   It is possible to use a short form of a module in order  to
		   run	it.   This  means  that	 an input of sy	will match the
		   system module, however an input of s	would result in	an er-
		   ror as it matches both storage  and	system	modules.   The
		   following modules are currently supported:

		   bios	     BIOS  information.	 It is required	to install the
			     dmidecode(8) tool in order	to obtain this	infor-
			     mation.   It  will	 provide  you with information
			     such as BIOS version and release date as well  as
			     BIOS vendor.

		   cpu	     CPU  details, such	as total number	of cores, num-
			     ber of cores per CPU, CPU speed as	 well  as  its
			     features, its type, architecuture,	etc.

		   mem	     System  memory details.  This module provides in-
			     formation related to physical memory and SWAP us-
			     age; lists	wired, active,	inactive,  cached  and
			     free memory statistics.

		   misc	     Miscellaneous information.	Currently provides in-
			     formation	about system crontab, current time and
			     date and statistics about open files.

		   network   Provides a	 detailed  information	about  network
			     subsystem.	  It summarizes	configuration for each
			     network device in the system and  displays	 fire-
			     wall, routing, resolver and socket	information.

		   os	     Operating	system	details	 mostly	related	to re-
			     lease version, kernel version, scheduler, process
			     statistics, information about  running  processes
			     and jails.

		   packages  Information about installed packages, such	as its
			     number,  how  many	of them	are outdated and which
			     have known	security vulnerabilities (in this case
			     it	is required to have the	portaudit(1) tool  in-
			     stalled on	the system.

		   services  Information about system services.	 Lists running
			     and  not running services,	detects	services which
			     are supposed to be	running	and  are  not.	 Lists
			     the  listening  IP	 sockets  opened by individual
			     services as well as user under  which  the	 given
			     service  is  running  as  well  as	the command by
			     which this	service	was started.

		   storage   Details about storage subsystem.  Summarizes  in-
			     formation	about  available  RAID controllers and
			     hard drives, their	size and features.  Lists  ex-
			     isting  and  mounted  file	systems, exported file
			     systems through NFS and prints disk usage and I/O
			     statistics.

		   system    System information	(hardware related), mainly CD-
			     ROM and graphics card information.	 In  case  the
			     dmidecode(8) tool is available, it	lists the Man-
			     ufacturer	of the given machine and provides some
			     information about base board.

		   user	     User related information; this  include  informa-
			     tion  about currently logged-in users, members of
			     the  wheel	 group,	 number	 of  local  users  and
			     groups.   This  module also provides some statis-
			     tics about	logged-in time about users  and	 lists
			     last login	date for each user.

       The features of sysinfo include:

	     	 Automatically	gathers	 various system	information related to
		 the hardware and software configuration of the	 FreeBSD  host
		 system.
	     	 The  tool  optionally provides	useful hints and references to
		 material containing detailed information about	 provided  re-
		 port.	These messages are prefixed by the INFO: string.
	     	 The tool is also capable to detect some missing configuration
		 or dangerous settings,	in which case it prints	a warning pre-
		 fixed by the WARNING: string.
	     	 Easy  to  customize.  Making use of several shell scripts and
		 one configuration file	it is possible to  easily  extend  al-
		 ready implemnted modules as well as add new ones.

       Please check the	sysinfo.conf(5)	manual page for	configuration options.

RETURN VALUES
       The sysinfo utility exits 0 on success, and >0 if an error occurs.

       The following exit values have been defined:

	     1	No options have	been provided on the command line.

	     2	The specified option or	module is not supported.

	     3	The configuration file has not been found.

FILES
       sysinfo.conf  The configuration file for	the sysinfo utility.

SEE ALSO
       sysinfo.conf(5)

AUTHORS
       The  sysinfo  utility and this manual page were written by Daniel Gerzo
       <danger@FreeBSD.org>.

FreeBSD	Ports 14.quarterly	 May 11, 2009			    SYSINFO(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sysinfo&sektion=8&manpath=FreeBSD+Ports+14.3.quarterly>

home | help