usr/src/man/man5/smf_restarter.5

   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 SMF_RESTARTER 5 "May 23, 2008"
   7 .SH NAME
   8 smf_restarter \- service management facility conventions for restarters
   9 .SH DESCRIPTION
  10 .sp
  11 .LP
  12 All service instances in the service management facility must be managed by a
  13 restarter. This manual page describes configuration, functionality, and
  14 reporting characteristics that are common to all restarters in the framework.
  15 Characteristics specific to a particular restarter are described in the
  16 restarter's man page.
  17 .sp
  18 .LP
  19 For each managed service, a restarter relies on retrieving properties on the
  20 service instance to determine configuration. The restarter manages a set of
  21 property groups to communicate the current disposition of a service with
  22 display tools such as \fBsvcs\fR(1).
  23 .SS "Service Configuration"
  24 .sp
  25 .LP
  26 The common restarter configuration for all services is captured in the
  27 \fBgeneral\fR property group. This group includes the following required and
  28 optional property settings.
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fBenabled\fR\fR
  33 .ad
  34 .RS 19n
  35 This is a required property. If set, the restarter of an instance attempts to
  36 maintain availability of the service.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBrestarter\fR\fR
  43 .ad
  44 .RS 19n
  45 This is an optional property that allows the specification of an alternate
  46 restarter to manage the service instance. If the restarter property is empty or
  47 absent, the restarter defaults to \fBsvc.startd\fR(1M).
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBsingle_instance\fR\fR
  54 .ad
  55 .RS 19n
  56 This is an optional property. When set, only one instance of the service is
  57 allowed to transition to an online or degraded status at any time.
  58 .RE
  59
  60 .SS "Service Reporting"
  61 .sp
  62 .LP
  63 All restarters report status using the \fBrestarter\fR property group, which
  64 includes the following properties:
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBnext_state\fR\fR
  69 .ad
  70 .RS 19n
  71 The current state and next state, if currently in transition, for instances
  72 stored in these properties. See \fBsmf\fR(5) for a description of the potential
  73 states.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBauxiliary_state\fR\fR
  80 .ad
  81 .RS 19n
  82 An astring with no spaces that contains a precise term to describe the full
  83 restarter-specific state in combination with the restarter state property. The
  84 auxiliary state cannot always be set and is always cleared during transition
  85 out of any state. Each restarter must define the precise list of auxiliary
  86 states it uses.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBstate_timestamp\fR\fR
  93 .ad
  94 .RS 19n
  95 The time when the current state was reached.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBcontract\fR\fR
 102 .ad
 103 .RS 19n
 104 The primary process contract ID, if any, under which the service instance is
 105 executing.
 106 .RE
 107
 108 .SH SEE ALSO
 109 .sp
 110 .LP
 111 \fBsvcs\fR(1), \fBsvc.startd\fR(1M), \fBservice_bundle\fR(4), \fBsmf\fR(5),
 112 \fBsmf_method\fR(5)