smf_restarter(5)

1smf_restarter(5)      Standards, Environments, and Macros     smf_restarter(5)
2
3
4

NAME

6       smf_restarter - service management facility conventions for restarters
7

DESCRIPTION

9       All  service  instances in the service management facility must be man‐
10       aged by a restarter. This manual page  describes  configuration,  func‐
11       tionality,  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  man‐
18       ages a set of property groups to communicate the current disposition of
19       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            This is a required property. If set,  the  restarter
27                          of  an instance attempts to maintain availability of
28                          the service.
29
30
31       restarter          This is an optional property that allows the  speci‐
32                          fication  of  an  alternate  restarter to manage the
33                          service instance. If the restarter property is empty
34                          or absent, the restarter defaults to svc.startd(1M).
35
36
37       single_instance    This  is  an  optional  property. When set, only one
38                          instance of the service is allowed to transition  to
39                          an online or degraded status at any time.
40
41
42   Service Reporting
43       All  restarters report status using the restarter property group, which
44       includes the following properties:
45
46       next_state         The current state and next state,  if  currently  in
47                          transition,  for  instances  stored in these proper‐
48                          ties. See smf(5) for a description of the  potential
49                          states.
50
51
52       auxiliary_state    An  astring  with  no spaces that contains a precise
53                          term to describe the full  restarter-specific  state
54                          in  combination  with  the restarter state property.
55                          The auxiliary state cannot  always  be  set  and  is
56                          always  cleared  during transition out of any state.
57                          Each restarter must define the precise list of  aux‐
58                          iliary states it uses.
59
60
61       state_timestamp    The time when the current state was reached.
62
63
64       contract           The primary process contract ID, if any, under which
65                          the service instance is executing.
66
67

NAME

DESCRIPTION

SEE ALSO