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

FreeBSD Manual Pages


home | help
svcs(1)								       svcs(1)

       svcs - report service status

       svcs  [-aHpv?]  [-o col[,col]...]   [-R instance_FMRI]...  [-sS col]...
       [FMRI | pattern]	...

       svcs {-d	| -D}  [-Hpv?] [-o col[,col]...]  [-sS col]...	[FMRI  |  pat-
       tern] ...

       svcs -l [FMRI | pattern]	...

       svcs -x [-v] [FMRI]...

       The  svcs  command  displays  information  about	 service  instances as
       recorded	in the service configuration repository. The first form	prints
       one-line	 status	 listings for service instances	specified by the argu-
       ments. Each instance is listed only once. With no  arguments,  all  en-
       abled  service instances, even if temporarily disabled, are listed with
       the columns indicated below. The	second	form  prints  one-line	status
       listings	 for  the  dependencies	or dependents of the service instances
       specified by the	arguments. The third form prints detailed  information
       about specific services and instances.

       The  fourth form	explains the states of service instances. For each ar-
       gument, a block of human-readable text is displayed which explains what
       state  the  service  is	in, and	why it is in that state. With no argu-
       ments, problematic services are described.

       Error messages are printed to the standard error	stream.

       The following options are supported:

       -?		       Displays	an extended usage  message,  including
			       column specifiers.

       -a		       Show all	services, even disabled	ones. This op-
			       tion has	no effect if services are selected.

       -d		       Lists the services or  service  instances  upon
			       which the given service instances depend.

       -D		       Lists  the service instances that depend	on the
			       given services or service instances.

       -H		       Omits the column	headers.

       -l		       (The letter ell.) Displays all available	infor-
			       mation  about the selected services and service
			       instances, with one service attribute displayed
			       for  each  line.	 Information for different in-
			       stances are separated by	blank lines.

			       The following specific attributes require  fur-
			       ther explanation:


				   Information	about a	dependency. The	group-
				   ing and restart_on properties are displayed
				   first  and  are separated by	a/. Next, each
				   entity and its state	is listed. See	smf(5)
				   for	information  about states. In addition
				   to the standard states, each	service	depen-
				   dency can have the following	state descrip-


				       No such service is defined on the  sys-


				       The FMRI	is invalid.


				       The  entity  is a service with multiple

				   File	dependencies can only have one of  the
				   following state descriptions:


				       No such file on the system.


				       The file	exists.

				       If the file did not exist the last time
				       that svc.startd evaluated the service's
				       dependencies,  it  can consider the de-
				       pendency	to be unsatisfied.  svcadm re-
				       fresh forces dependency re-evaluation.


				       stat(2)	failed for a reason other than

				   See smf(5) for additional details about de-
				   pendencies,	grouping,  and restart_on val-


				   Whether the service is enabled or not,  and
				   whether it is enabled or disabled temporar-
				   ily (until the  next	 system	 reboot).  The
				   former  is  specified  as  either  true  or
				   false, and the latter is designated by  the
				   presence of (temporary).

				   A service might be temporarily disabled be-
				   cause an administrator has run svcadm  dis-
				   able	 -t, used "svcadm milestone, or	booted
				   the system to a specific milestone. See sv-
				   cadm(1M) for	details.

       -o col[,col]...	       Prints  the  specified columns. Each col	should
			       be a column name. See COLUMNS below for	avail-
			       able columns.

       -p		       Lists  processes	 associated  with each service
			       instance. A service instance can	have no	 asso-
			       ciated  processes.  The process ID, start time,
			       and command name	(PID, STIME,  and  CMD	fields
			       from ps(1)) are displayed for each process.

       -R instance_FMRI	       Selects	service	 instances that	have the given
			       service instance	as their restarter.

       -s col		       Sorts output by column. col should be a	column
			       name.  See COLUMNS below	for available columns.
			       Multiple	-s options behave additively.

       -S col		       Sorts by	col in the opposite  order  as	option

       -v		       Without	-x,  displays  verbose columns:	STATE,
			       NSTATE, STIME, CTID, and	FMRI.

			       With -x,	displays extra	information  for  each

       -x		       Displays	explanations for service states.

			       Without	arguments,  the	-x option explains the
			       states of services which:

				 o  are	enabled, but are not running.

				 o  are	 preventing  another  enabled  service
				    from running.

       The following operands are supported:

       instance_FMRI   An FMRI that specifes an	instance.

       FMRI	       An  FMRI	that specifes one or more instances. FMRIs can
		       be abbreviated by specifying the	instance name, or  the
		       trailing	 portion  of  the  service  name. For example,
		       given the FMRI:


		       The following are valid abbreviations:


		       The following are invalid abbreviations:


		       If the FMRI specifies a service,	then the  command  ap-
		       plies  to  all  instances  of that service, except when
		       used with the -D	option.

		       Abbreviated forms of FMRIs are unstable,	and should not
		       be used in scripts or other permanent tools.

       pattern	       A  pattern that is matched against the FMRIs of service
		       instances according to the "globbing"  rules  described
		       by fnmatch(5). If the pattern does not begin with svc:,
		       then svc:/ is prepended.

       Column names are	case insensitive. The default output format is equiva-
       lent  to	 "-o state,stime,fmri".	The default sorting columns are	STATE,
       STIME, FMRI.

       CTID	       The primary contract ID for the service	instance.  Not
		       all instances have valid	primary	contract IDs.

       DESC	       A  brief	 description of	the service, from its template
		       element.	A service might	not have a description	avail-
		       able,  in  which	case a hyphen (-) is used to denote an
		       empty value.

       FMRI	       The FMRI	of the service instance.

       INST	       The instance name of the	service	instance.

       NSTA	       The abbreviated next state of the service instance,  as
		       given  in  the STA column description. A	hyphen denotes
		       that the	instance is not	 transitioning.	 Same  as  STA

       NSTATE	       The  next state of the service. A hyphen	is used	to de-
		       note that the instance is not  transitioning.  Same  as
		       STATE otherwise.

       SCOPE	       The scope name of the service instance.

       SVC	       The service name	of the service instance.

       STA	       The abbreviated state of	the service instance:

		       DGD	degraded

		       DIS	disabled

		       LRC	legacy rc*.d script-initiated instance

		       MNT	maintenance

		       OFF	offline

		       ON	online

		       UN	uninitialized

		       Absent or unrecognized states are denoted by a question
		       mark (?)	character. An asterisk (*) is appended for in-
		       stances in transition, unless the NSTA or NSTATE	column
		       is also being displayed.

		       See smf(5) for an explanation of	service	states.

       STATE	       The state of the	service	instance. An asterisk  is  ap-
		       pended  for instances in	transition, unless the NSTA or
		       NSTATE column is	also being displayed.

		       See smf(5) for an explanation of	service	states.

       STIME	       If the  service	instance  entered  the	current	 state
		       within  the  last  24  hours, this column indicates the
		       time that it did	so. Otherwise, this  column  indicates
		       the  date  on which it did so, printed with underscores
		       (_) in place of blanks.

       Example 1: Displaying the Default Output

       This example displays default output:

       example%	svcs
       STATE	      STIME    FMRI
       legacy_run     13:25:04 lrc:/etc/rc3_d/S42myscript
       online	      13:21:50 svc:/system/svc/restarter:default
       online	      13:25:03 svc:/milestone/multi-user:default
       online	      13:25:07 svc:/milestone/multi-user-server:default

       Example 2: Listing All Local Instances

       This example lists all local instances of the service1 service.

       example%	svcs -o	state,nstate,fmri service1
       STATE	    NSTATE	  FMRI
       online	    -		  svc:/service1:instance1
       disabled	    -		  svc:/service1:instance2

       Example 3: Listing Verbose Information

       This example lists verbose information.

       example%	svcs -v	smtp
       STATE	      NSTATE	    STIME    CTID   FMRI
       online	      -		    13:25:13	141 svc:/network/smtp:sendmail

       Example 4: Listing Detailed Information

	This example lists detailed information	about all  instances  of  sys-
       tem/service3. Additional	fields can be displayed, as appropriate	to the
       managing	restarter.

       example%	svcs -l	system/service3

       fmri	    svc:/system/service3:default
       description  Example service 3
       enabled	    true
       state	    online
       next_state   none
       restarter    svc:/system/svc/restarter:default
       dependency   require_all/refresh	svc:/system/service2:default (online)
       dependency   require_all/none svc:/system/service1:default (online)

       fmri	    svc:/system/service3:backup
       description  Example service 3
       enabled	    false
       state	    disabled
       next_state   none
       restarter    svc:/system/svc/restarter:default
       dependency   require_all	svc:/system/service2:backup (absent)

       Example 5: Listing Processes

       example%	svcs -p	sendmail
       STATE	      STIME    FMRI
       online	      13:25:13 svc:/network/smtp:sendmail
		      13:25:15	 100939	sendmail
       13:25:15	  100940 sendmail

       The following exit values are returned:

       0	Successful command invocation.

       1	Fatal error.

       2	Invalid	command	line options were specified.

       See attributes(5) for descriptions of the following attributes:

       |      ATTRIBUTE	TYPE	     |	    ATTRIBUTE VALUE	   |
       |Availability		     |SUNWcsu			   |
       |Interface Stability	     |See below.		   |

       The human readable output is Unstable. The invocation is	Evolving.

       ps(1), svcprop(1),  svcadm(1M),	svccfg(1M),  svc.startd(1M),  stat(2),
       libscf(3LIB), attributes(5), fnmatch(5),	smf(5)

				  18 Mar 2005			       svcs(1)


Want to link to this manual page? Use this URL:

home | help