1 SMF_RESTARTER(5)      Standards, Environments, and Macros     SMF_RESTARTER(5)
   2 
   3 
   4 
   5 NAME
   6        smf_restarter - service management facility conventions for restarters
   7 
   8 DESCRIPTION
   9        All service instances in the service management facility must be
  10        managed by a restarter. This manual page describes configuration,
  11        functionality, and reporting characteristics that are common to all
  12        restarters in the framework.  Characteristics specific to a particular
  13        restarter are described in the restarter's man page.
  14 
  15 
  16        For each managed service, a restarter relies on retrieving properties
  17        on the service instance to determine configuration. The restarter
  18        manages a set of property groups to communicate the current disposition
  19        of a service with display tools such as svcs(1).
  20 
  21    Service Configuration
  22        The common restarter configuration for all services is captured in the
  23        general property group. This group includes the following required and
  24        optional property settings.
  25 
  26        enabled
  27                           This is a required property. If set, the restarter
  28                           of an instance attempts to maintain availability of
  29                           the service.
  30 
  31 
  32        restarter
  33                           This is an optional property that allows the
  34                           specification of an alternate restarter to manage
  35                           the service instance. If the restarter property is
  36                           empty or absent, the restarter defaults to
  37                           svc.startd(1M).
  38 
  39 
  40        single_instance
  41                           This is an optional property. When set, only one
  42                           instance of the service is allowed to transition to
  43                           an online or degraded status at any time. Note that
  44                           no known implementation honours this setting, and it
  45                           should be considered obsolete.
  46 
  47 
  48    Service Reporting
  49        All restarters report status using the restarter property group, which
  50        includes the following properties:
  51 
  52        next_state
  53                           The current state and next state, if currently in
  54                           transition, for instances stored in these
  55                           properties. See smf(5) for a description of the
  56                           potential states.
  57 
  58 
  59        auxiliary_state
  60                           An astring with no spaces that contains a precise
  61                           term to describe the full restarter-specific state
  62                           in combination with the restarter state property.
  63                           The auxiliary state cannot always be set and is
  64                           always cleared during transition out of any state.
  65                           Each restarter must define the precise list of
  66                           auxiliary states it uses.
  67 
  68 
  69        state_timestamp
  70                           The time when the current state was reached.
  71 
  72 
  73        contract
  74                           The primary process contract ID, if any, under which
  75                           the service instance is executing.
  76 
  77 
  78 SEE ALSO
  79        svcs(1), svc.startd(1M), service_bundle(4), smf(5), smf_method(5)
  80 
  81 
  82 
  83                                December 11, 2019              SMF_RESTARTER(5)