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