| blob | a777621b8472090cca21f801afb656814debed4a |
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SVCS 1 "Feb 21, 2018"
7 .SH NAME
8 svcs \- report service status
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBsvcs\fR [\fB-aHpv?\fR] [\fB-Z\fR | \fB-z\fR \fIzone\fR] [\fB-o\fR \fIcol\fR[,\fIcol\fR]]... [\fB-R\fR \fIFMRI-instance\fR]...
13 [\fB-sS\fR \fIcol\fR]... [\fIFMRI\fR | \fIpattern\fR]...
14 .fi
16 .LP
17 .nf
18 \fBsvcs\fR {\fB-d\fR | \fB-D\fR} [\fB-Hpv?\fR] [\fB-Z\fR | \fB-z\fR \fIzone\fR] [\fB-o\fR \fIcol\fR[,\fIcol\fR]]... [\fB-sS\fR \fIcol\fR]...
19 [\fIFMRI\fR | \fIpattern\fR] ...
20 .fi
22 .LP
23 .nf
24 \fBsvcs\fR [\fB-l] [\fB-vZ\fR] [\fB-z\fR \fIzone\fR] [\fIFMRI\fR | \fIpattern\fR]...
25 .fi
27 .LP
28 .nf
29 \fBsvcs\fR [\fB-L\fR] [\fB-vZ\fR] [\fB-z\fR \fIzone\fR] [\fIFMRI\fR | \fIpattern\fR]...
30 .fi
32 .LP
33 .nf
34 \fBsvcs\fR \fB-x\fR [\fB-L\fR] [\fB-v\fR] [\fB-Z\fR | \fB-z\fR \fIzone\fR] [\fIFMRI\fR]...
35 .fi
37 .SH DESCRIPTION
38 .sp
39 .LP
40 The \fBsvcs\fR command displays information about service instances as recorded
41 in the service configuration repository.
42 .sp
43 .LP
44 The first form of this command prints one-line status listings for service
45 instances specified by the arguments. Each instance is listed only once. With
46 no arguments, all enabled service instances, even if temporarily disabled, are
47 listed with the columns indicated below.
48 .sp
49 .LP
50 The second form prints one-line status listings for the dependencies or
51 dependents of the service instances specified by the arguments.
52 .sp
53 .LP
54 The third form prints detailed information about specific services and
55 instances.
56 .sp
57 .LP
58 The fourth form explains the states of service instances. For each argument, a
59 block of human-readable text is displayed which explains what state the service
60 is in, and why it is in that state. With no arguments, problematic services are
61 described.
62 .sp
63 .LP
64 Error messages are printed to the standard error stream.
65 .sp
66 .LP
67 The output of this command can be used appropriately as input to the
68 \fBsvcadm\fR(8) command.
69 .SH OPTIONS
70 .sp
71 .LP
72 The following options are supported:
73 .sp
74 .ne 2
75 .na
76 \fB\fB-?\fR\fR
77 .ad
78 .RS 20n
79 Displays an extended usage message, including column specifiers.
80 .RE
82 .sp
83 .ne 2
84 .na
85 \fB\fB-a\fR\fR
86 .ad
87 .RS 20n
88 Show all services, even disabled ones. This option has no effect if services
89 are selected.
90 .RE
92 .sp
93 .ne 2
94 .na
95 \fB\fB-d\fR\fR
96 .ad
97 .RS 20n
98 Lists the services or service instances upon which the given service instances
99 depend.
100 .RE
102 .sp
103 .ne 2
104 .na
105 \fB\fB-D\fR\fR
106 .ad
107 .RS 20n
108 Lists the service instances that depend on the given services or service
109 instances.
110 .RE
112 .sp
113 .ne 2
114 .na
115 \fB\fB-H\fR\fR
116 .ad
117 .RS 20n
118 Omits the column headers.
119 .RE
121 .sp
122 .ne 2
123 .na
124 \fB\fB-l\fR\fR
125 .ad
126 .RS 20n
127 (The letter ell.) Displays all available information about the selected
128 services and service instances, with one service attribute displayed for each
129 line. Information for different instances are separated by blank lines.
130 .sp
131 The following specific attributes require further explanation:
132 .sp
133 .ne 2
134 .na
135 \fB\fBdependency\fR\fR
136 .ad
137 .RS 14n
138 Information about a dependency. The grouping and \fBrestart_on\fR properties
139 are displayed first and are separated by a forward slash (\fB/\fR). Next, each
140 entity and its state is listed. See \fBsmf\fR(5) for information about states.
141 In addition to the standard states, each service dependency can have the
142 following state descriptions:
143 .sp
144 .ne 2
145 .na
146 \fB\fBabsent\fR\fR
147 .ad
148 .RS 12n
149 No such service is defined on the system.
150 .RE
152 .sp
153 .ne 2
154 .na
155 \fB\fBinvalid\fR\fR
156 .ad
157 .RS 12n
158 The fault management resource identifier (FMRI) is invalid (see \fBsmf\fR(5)).
159 .RE
161 .sp
162 .ne 2
163 .na
164 \fB\fBmultiple\fR\fR
165 .ad
166 .RS 12n
167 The entity is a service with multiple instances.
168 .RE
170 File dependencies can only have one of the following state descriptions:
171 .sp
172 .ne 2
173 .na
174 \fB\fBabsent\fR\fR
175 .ad
176 .RS 11n
177 No such file on the system.
178 .RE
180 .sp
181 .ne 2
182 .na
183 \fB\fBonline\fR\fR
184 .ad
185 .RS 11n
186 The file exists.
187 .sp
188 If the file did not exist the last time that \fBsvc.startd\fR evaluated the
189 service's dependencies, it can consider the dependency to be unsatisfied.
190 \fBsvcadm refresh\fR forces dependency re-evaluation.
191 .RE
193 .sp
194 .ne 2
195 .na
196 \fB\fBunknown\fR\fR
197 .ad
198 .RS 11n
199 \fBstat\fR(2) failed for a reason other than \fBENOENT\fR.
200 .RE
202 See \fBsmf\fR(5) for additional details about dependencies, grouping, and
203 \fBrestart_on\fR values.
204 .RE
206 .sp
207 .ne 2
208 .na
209 \fB\fBenabled\fR\fR
210 .ad
211 .RS 14n
212 Whether the service is enabled or not, and whether it is enabled or disabled
213 temporarily (until the next system reboot). The former is specified as either
214 \fBtrue\fR or \fBfalse\fR, and the latter is designated by the presence of
215 \fB(temporary)\fR.
216 .sp
217 A service might be temporarily disabled because an administrator has run
218 \fBsvcadm disable -t\fR, used \fBsvcadm milestone\fR, or booted the system to a
219 specific milestone. See \fBsvcadm\fR(8) for details.
220 .RE
222 .RE
224 .sp
225 .ne 2
226 .na
227 \fB-L\fR
228 .ad
229 .RS 20n
230 Display the log file of the selected services and service instances, one
231 per-line. With \fB-v\fR, displays full contents of the log file. With \fB-x\fR,
232 displays the last 5 entries of the log file.
233 .RE
235 .sp
236 .ne 2
237 .na
238 \fB\fB-o\fR \fIcol\fR[,\fIcol\fR]...\fR
239 .ad
240 .RS 20n
241 Prints the specified columns. Each \fIcol\fR should be a column name. See
242 \fBCOLUMNS\fR below for available columns.
243 .RE
245 .sp
246 .ne 2
247 .na
248 \fB\fB-p\fR\fR
249 .ad
250 .RS 20n
251 Lists processes associated with each service instance. A service instance can
252 have no associated processes. The process ID, start time, and command name
253 (\fBPID\fR, \fBSTIME\fR, and \fBCMD\fR fields from \fBps\fR(1)) are displayed
254 for each process.
255 .RE
257 .sp
258 .ne 2
259 .na
260 \fB\fB-R\fR \fIFMRI-instance\fR\fR
261 .ad
262 .RS 20n
263 Selects service instances that have the given service instance as their
264 restarter.
265 .RE
267 .sp
268 .ne 2
269 .na
270 \fB\fB-s\fR \fIcol\fR\fR
271 .ad
272 .RS 20n
273 Sorts output by column. \fIcol\fR should be a column name. See \fBCOLUMNS\fR
274 below for available columns. Multiple \fB-s\fR options behave additively.
275 .RE
277 .sp
278 .ne 2
279 .na
280 \fB\fB-S\fR \fIcol\fR\fR
281 .ad
282 .RS 20n
283 Sorts by \fIcol\fR in the opposite order as option \fB-s\fR.
284 .RE
286 .sp
287 .ne 2
288 .na
289 \fB\fB-v\fR\fR
290 .ad
291 .RS 20n
292 Without \fB-x\fR or \fB-l\fR, displays verbose columns: \fBSTATE\fR,
293 \fBNSTATE\fR, \fBSTIME\fR, \fBCTID\fR, and \fBFMRI\fR.
294 .sp
295 With \fB-x\fR, displays extra information for each explanation.
296 .sp
297 With \fB-l\fR, displays user-visible properties in property groups of type
298 \fBapplication\fR and their description.
299 .RE
301 .sp
302 .ne 2
303 .na
304 \fB\fB-x\fR\fR
305 .ad
306 .RS 20n
307 Displays explanations for service states.
308 .sp
309 Without arguments, the \fB-x\fR option explains the states of services which:
310 .RS +4
311 .TP
312 .ie t \(bu
313 .el o
314 are enabled, but are not running.
315 .RE
316 .RS +4
317 .TP
318 .ie t \(bu
319 .el o
320 are preventing another enabled service from running.
321 .RE
322 .RE
324 .sp
325 .ne 2
326 .na
327 \fB-z \fIzone\fR
328 .ad
329 .RS 20n
330 Display only the services in the \fIzone\fR. This option is only applicable
331 in the global zone, see \fBzones\fR(5).
332 .RE
334 .sp
335 .ne 2
336 .na
337 \fB-Z\fR
338 .ad
339 .RS 20n
340 Display services from all zones, with an additional column indicating in which
341 zone the service is running. This option is only applicable in the global
342 zone, see \fBzones\fR(5).
343 .RE
345 .SH OPERANDS
346 .sp
347 .LP
348 The following operands are supported:
349 .sp
350 .ne 2
351 .na
352 \fB\fIFMRI\fR\fR
353 .ad
354 .RS 17n
355 A fault management resource identifier (FMRI) that specifies one or more
356 instances (see \fBsmf\fR(5)). FMRIs can be abbreviated by specifying the
357 instance name, or the trailing portion of the service name. For example, given
358 the FMRI:
359 .sp
360 .in +2
361 .nf
362 svc:/network/smtp:sendmail
363 .fi
364 .in -2
365 .sp
367 The following are valid abbreviations:
368 .sp
369 .in +2
370 .nf
371 sendmail
372 :sendmail
373 smtp
374 smtp:sendmail
375 network/smtp
376 .fi
377 .in -2
378 .sp
380 The following are invalid abbreviations:
381 .sp
382 .in +2
383 .nf
384 mail
385 network
386 network/smt
387 .fi
388 .in -2
389 .sp
391 If the FMRI specifies a service, then the command applies to all instances of
392 that service, except when used with the \fB-D\fR option.
393 .sp
394 Abbreviated forms of FMRIs are unstable, and should not be used in scripts or
395 other permanent tools.
396 .RE
398 .sp
399 .ne 2
400 .na
401 \fB\fIpattern\fR\fR
402 .ad
403 .RS 17n
404 A pattern that is matched against the \fIFMRI\fRs of service instances
405 according to the "globbing" rules described by \fBfnmatch\fR(5). If the pattern
406 does not begin with \fBsvc:\fR, then \fBsvc:/\fR is prepended. The following is
407 a typical example of a glob pattern:
408 .sp
409 .in +2
410 .nf
411 qexample% svcs \e*keyserv\e*
412 STATE STIME FMRI
413 disabled Aug_02 svc:/network/rpc/keyserv:default
414 .fi
415 .in -2
416 .sp
418 .RE
420 .sp
421 .ne 2
422 .na
423 \fB\fIFMRI-instance\fR\fR
424 .ad
425 .RS 17n
426 An FMRI that specifies an instance.
427 .RE
429 .SH COLUMNS
430 .sp
431 .LP
432 Column names are case insensitive. The default output format is equivalent to
433 "\fB-o\fR \fBstate,stime,fmri\fR". The default sorting columns are \fBSTATE\fR,
434 \fBSTIME\fR, \fBFMRI\fR.
435 .sp
436 .ne 2
437 .na
438 \fB\fBCTID\fR\fR
439 .ad
440 .RS 10n
441 The primary contract ID for the service instance. Not all instances have valid
442 primary contract IDs.
443 .RE
445 .sp
446 .ne 2
447 .na
448 \fB\fBDESC\fR\fR
449 .ad
450 .RS 10n
451 A brief description of the service, from its template element. A service might
452 not have a description available, in which case a hyphen (\fB\(hy\fR) is used
453 to denote an empty value.
454 .RE
456 .sp
457 .ne 2
458 .na
459 \fB\fBFMRI\fR\fR
460 .ad
461 .RS 10n
462 The \fIFMRI\fR of the service instance.
463 .RE
465 .sp
466 .ne 2
467 .na
468 \fB\fBINST\fR\fR
469 .ad
470 .RS 10n
471 The instance name of the service instance.
472 .RE
474 .sp
475 .ne 2
476 .na
477 \fB\fBNSTA\fR\fR
478 .ad
479 .RS 10n
480 The abbreviated next state of the service instance, as given in the \fBSTA\fR
481 column description. A hyphen denotes that the instance is not transitioning.
482 Same as \fBSTA\fR otherwise.
483 .RE
485 .sp
486 .ne 2
487 .na
488 \fB\fBNSTATE\fR\fR
489 .ad
490 .RS 10n
491 The next state of the service. A hyphen is used to denote that the instance is
492 not transitioning. Same as \fBSTATE\fR otherwise.
493 .RE
495 .sp
496 .ne 2
497 .na
498 \fB\fBSCOPE\fR\fR
499 .ad
500 .RS 10n
501 The scope name of the service instance.
502 .RE
504 .sp
505 .ne 2
506 .na
507 \fB\fBSVC\fR\fR
508 .ad
509 .RS 10n
510 The service name of the service instance.
511 .RE
513 .sp
514 .ne 2
515 .na
516 \fB\fBSTA\fR\fR
517 .ad
518 .RS 10n
519 The abbreviated state of the service instance (see \fBsmf\fR(5)):
520 .sp
521 .ne 2
522 .na
523 \fB\fBDGD\fR\fR
524 .ad
525 .RS 7n
526 degraded
527 .RE
529 .sp
530 .ne 2
531 .na
532 \fB\fBDIS\fR\fR
533 .ad
534 .RS 7n
535 disabled
536 .RE
538 .sp
539 .ne 2
540 .na
541 \fB\fBLRC\fR\fR
542 .ad
543 .RS 7n
544 legacy \fBrc*.d\fR script-initiated instance
545 .RE
547 .sp
548 .ne 2
549 .na
550 \fB\fBMNT\fR\fR
551 .ad
552 .RS 7n
553 maintenance
554 .RE
556 .sp
557 .ne 2
558 .na
559 \fB\fBOFF\fR\fR
560 .ad
561 .RS 7n
562 offline
563 .RE
565 .sp
566 .ne 2
567 .na
568 \fB\fBON\fR\fR
569 .ad
570 .RS 7n
571 online
572 .RE
574 .sp
575 .ne 2
576 .na
577 \fB\fBUN\fR\fR
578 .ad
579 .RS 7n
580 uninitialized
581 .RE
583 Absent or unrecognized states are denoted by a question mark (\fB?\fR)
584 character. An asterisk (\fB*\fR) is appended for instances in transition,
585 unless the \fBNSTA\fR or \fBNSTATE\fR column is also being displayed.
586 .sp
587 See \fBsmf\fR(5) for an explanation of service states.
588 .RE
590 .sp
591 .ne 2
592 .na
593 \fB\fBSTATE\fR\fR
594 .ad
595 .RS 10n
596 The state of the service instance. An asterisk is appended for instances in
597 transition, unless the \fBNSTA\fR or \fBNSTATE\fR column is also being
598 displayed.
599 .sp
600 See \fBsmf\fR(5) for an explanation of service states.
601 .RE
603 .sp
604 .ne 2
605 .na
606 \fB\fBSTIME\fR\fR
607 .ad
608 .RS 10n
609 If the service instance entered the current state within the last 24 hours,
610 this column indicates the time that it did so. Otherwise, this column indicates
611 the date on which it did so, printed with underscores (\fB_\fR) in place of
612 blanks.
613 .RE
615 .SH EXAMPLES
616 .LP
617 \fBExample 1 \fRDisplaying the Default Output
618 .sp
619 .LP
620 This example displays default output:
622 .sp
623 .in +2
624 .nf
625 example% svcs
626 STATE STIME FMRI
627 \&...
628 legacy_run 13:25:04 lrc:/etc/rc3_d/S42myscript
629 \&...
630 online 13:21:50 svc:/system/svc/restarter:default
631 \&...
632 online 13:25:03 svc:/milestone/multi-user:default
633 \&...
634 online 13:25:07 svc:/milestone/multi-user-server:default
635 \&...
636 .fi
637 .in -2
638 .sp
640 .LP
641 \fBExample 2 \fRListing All Local Instances
642 .sp
643 .LP
644 This example lists all local instances of the \fBservice1\fR service.
646 .sp
647 .in +2
648 .nf
649 example% svcs -o state,nstate,fmri service1
650 STATE NSTATE FMRI
651 online - svc:/service1:instance1
652 disabled - svc:/service1:instance2
653 .fi
654 .in -2
655 .sp
657 .LP
658 \fBExample 3 \fRListing Verbose Information
659 .sp
660 .LP
661 This example lists verbose information.
663 .sp
664 .in +2
665 .nf
666 example% svcs -v network/rpc/rstat:udp
667 STATE NSTATE STIME CTID FMRI
668 online - Aug_09 - svc:/network/rpc/rstat:udp
669 .fi
670 .in -2
671 .sp
673 .LP
674 \fBExample 4 \fRListing Detailed Information
675 .sp
676 .LP
677 This example lists detailed information about all instances of
678 \fBsystem/service3\fR. Additional fields can be displayed, as appropriate to
679 the managing restarter.
681 .sp
682 .in +2
683 .nf
684 example% svcs -l network/rpc/rstat:udp
686 fmri svc:/network/rpc/rstat:udp
687 enabled true
688 state online
689 next_state none
690 restarter svc:/network/inetd:default
691 contract_id
692 dependency require_all/error svc:/network/rpc/bind (online)
693 .fi
694 .in -2
695 .sp
697 .LP
698 \fBExample 5 \fRListing Processes
699 .sp
700 .in +2
701 .nf
702 example% svcs -p sendmail
703 STATE STIME FMRI
704 online 13:25:13 svc:/network/smtp:sendmail
705 13:25:15 100939 sendmail
706 13:25:15 100940 sendmail
707 .fi
708 .in -2
709 .sp
711 .LP
712 \fBExample 6 \fRExplaining Service States Using \fBsvcs\fR \fB-x\fR
713 .sp
714 .LP
715 (a) In this example, \fBsvcs\fR \fB-x\fR has identified that the print/server
716 service being disabled is the root cause of two services which are enabled but
717 not online. \fBsvcs\fR \fB-xv\fR shows that those services are
718 \fBprint/rfc1179\fR and \fBprint/ipp-listener\fR. This situation can be
719 rectified by either enabling \fBprint/server\fR or disabling \fBrfc1179\fR and
720 \fBipp-listener\fR.
722 .sp
723 .in +2
724 .nf
725 example% svcs -x
726 svc:/application/print/server:default (LP print server)
727 State: disabled since Mon Feb 13 17:56:21 2006
728 Reason: Disabled by an administrator.
729 See: http://illumos.org/msg/SMF-8000-05
730 See: lpsched(8)
731 Impact: 2 dependent services are not running. (Use -v for list.)
732 .fi
733 .in -2
734 .sp
736 .sp
737 .LP
738 (b) In this example, NFS is not working:
740 .sp
741 .in +2
742 .nf
743 example$ svcs nfs/client
744 STATE STIME FMRI
745 offline 16:03:23 svc:/network/nfs/client:default
746 .fi
747 .in -2
748 .sp
750 .sp
751 .LP
752 (c) The following example shows that the problem is \fBnfs/status\fR.
753 \fBnfs/client\fR is waiting because it depends on \fBnfs/nlockmgr\fR, which
754 depends on \fBnfs/status\fR:
756 .sp
757 .in +2
758 .nf
759 example$ svcs -xv nfs/client
760 svc:/network/nfs/client:default (NFS client)
761 State: offline since Mon Feb 27 16:03:23 2006
762 Reason: Service svc:/network/nfs/status:default
763 is not running because a method failed repeatedly.
764 See: http://illumos.org/msg/SMF-8000-GE
765 Path: svc:/network/nfs/client:default
766 svc:/network/nfs/nlockmgr:default
767 svc:/network/nfs/status:default
768 See: man -M /usr/share/man -s 8 mount_nfs
769 See: /var/svc/log/network-nfs-client:default.log
770 Impact: This service is not running.
771 .fi
772 .in -2
773 .sp
775 .SH EXIT STATUS
776 .sp
777 .LP
778 The following exit values are returned:
779 .sp
780 .ne 2
781 .na
782 \fB\fB0\fR\fR
783 .ad
784 .RS 5n
785 Successful command invocation.
786 .RE
788 .sp
789 .ne 2
790 .na
791 \fB\fB1\fR\fR
792 .ad
793 .RS 5n
794 Fatal error.
795 .RE
797 .sp
798 .ne 2
799 .na
800 \fB\fB2\fR\fR
801 .ad
802 .RS 5n
803 Invalid command line options were specified.
804 .RE
806 .SH ATTRIBUTES
807 .sp
808 .LP
809 See \fBattributes\fR(5) for descriptions of the following attributes:
810 .sp
812 .sp
813 .TS
814 box;
815 c | c
816 l | l .
817 ATTRIBUTE TYPE ATTRIBUTE VALUE
818 _
819 Interface Stability See below.
820 .TE
822 .sp
823 .LP
824 Screen output is Uncommitted. The invocation is Committed.
825 .SH SEE ALSO
826 .sp
827 .LP
828 \fBps\fR(1), \fBsvcprop\fR(1), \fBsvcadm\fR(8), \fBsvccfg\fR(8),
829 \fBsvc.startd\fR(8), \fBstat\fR(2), \fBlibscf\fR(3LIB), \fBattributes\fR(5),
830 \fBfnmatch\fR(5), \fBsmf\fR(5), \fBzones\fR(5)