sacadm(1m) - osol9

1sacadm(1M)              System Administration Commands              sacadm(1M)
2
3
4

NAME

6       sacadm - service access controller administration
7

SYNOPSIS

9       sacadm -a -p pmtag -t type -c cmd -v ver [-f dx] [-n count]
10            [-y comment] [-z script]
11
12
13       sacadm -r -p pmtag
14
15
16       sacadm -s -p pmtag
17
18
19       sacadm -k -p pmtag
20
21
22       sacadm -e -p pmtag
23
24
25       sacadm -d -p pmtag
26
27
28       sacadm -l [-p pmtag | -t type]
29
30
31       sacadm -L [-p pmtag | -t type]
32
33
34       sacadm -g -p pmtag [-z script]
35
36
37       sacadm -G [-z script]
38
39
40       sacadm -x [-p pmtag]
41
42

DESCRIPTION

44       sacadm is the administrative command for the upper level of the Service
45       Access Facility hierarchy (port monitor  administration).  sacadm  per‐
46       forms the following functions:
47
48           o      adds or removes a port monitor
49
50           o      starts or stops a port monitor
51
52           o      enables or disables a port monitor
53
54           o      installs or replaces a per-system configuration script
55
56           o      installs or replaces a per-port monitor configuration script
57
58           o      prints requested port monitor information
59
60
61       Requests  about the status of port monitors (-l and -L) and requests to
62       print per-port monitor and per-system configuration scripts (-g and  -G
63       without the -z option) may be executed by any user on the system. Other
64       sacadm commands may be executed only by the super-user.
65

OPTIONS

67       -a            Add a port monitor. When adding a  port  monitor,  sacadm
68                     creates  the  supporting  directory structure in /etc/saf
69                     and /var/saf and adds an entry for the new  port  monitor
70                     to  /etc/saf/_sactab.  The file _sactab already exists on
71                     the delivered system. Initially, it is empty except for a
72                     single  line,  which  contains  the version number of the
73                     Service Access Controller. Unless the command  line  that
74                     adds the new port monitor includes the -f option with the
75                     -x argument,  the  new  port  monitor  will  be  started.
76                     Because  of  the  complexity of the options and arguments
77                     that follow the - a option, it may be convenient to use a
78                     command script or the menu system to add port monitors.
79
80
81       -c cmd        Execute  the  command string cmd to start a port monitor.
82                     The -c option may be used only with a  -a.  A  -a  option
83                     requires a -c.
84
85
86       -d            Disable the port monitor pmtag.
87
88
89       -e            Enable the port monitor pmtag.
90
91
92       -f dx         The -f option  specifies one or both of the following two
93                     flags which are then included in the flags field  of  the
94                     _sactab  entry for the new port monitor. If the -f option
95                     is not included on the command line, no flags are set and
96                     the  default conditions prevail. By default, a port moni‐
97                     tor is started. A -f option with no following argument is
98                     illegal.
99
100                     d    Do not enable the new port monitor.
101
102
103                     x    Do not start the new port monitor.
104
105
106
107       -g            The  -g option is used to request output or to install or
108                     replace  the  per-port   monitor   configuration   script
109                     /etc/saf/pmtag/_config.  -g  requires a -p option. The -g
110                     option with only a -p option prints the per-port  monitor
111                     configuration  script  for  port  monitor  pmtag.  The -g
112                     option with a -p option and a  -z  option  installs   the
113                     file  script as the per-port monitor configuration script
114                     for port monitor pmtag.  Other  combinations  of  options
115                     with -g are invalid.
116
117
118       -G            The  -G option is used to request output or to install or
119                     replace    the    per-system     configuration     script
120                     /etc/saf/_sysconfig.  The  -G option by itself prints the
121                     per-system configuration script. The -G option in  combi‐
122                     nation  with a -z option  installs the file script as the
123                     per-system configuration script.  Other  combinations  of
124                     options with a -G option are invalid.
125
126
127       -k            Stop port monitor pmtag.
128
129
130       -l            The  -l  option  is used to request port monitor informa‐
131                     tion. The -l by itself lists all  port  monitors  on  the
132                     system.  The  -l option in combination with the -p option
133                     lists only the port monitor specified by pmtag. A  -l  in
134                     combination with the -t option lists all port monitors of
135                     type type. Any other combination of options with  the  -l
136                     option is invalid.
137
138
139       -L            The  -L  option is identical to the -l option except that
140                     the output appears in a condensed format.
141
142
143       -n count      Set the restart count to count. If a restart count is not
144                     specified, count is set to 0. A count of 0 indicates that
145                     the port monitor is not to be restarted if it fails.
146
147
148       -p pmtag      Specifies the tag associated with a port monitor.
149
150
151       -r            Remove port monitor pmtag. sacadm removes the port  moni‐
152                     tor entry from /etc/saf/_sactab. If the removed port mon‐
153                     itor is not running, then no further action is taken.  If
154                     the  removed  port monitor is running, the Service Access
155                     Controller (SAC) sends it SIGTERM  to  indicate  that  it
156                     should  shut down. Note that the port monitor's directory
157                     structure remains intact.
158
159
160       -s            Start a port monitor. The SAC  starts  the  port  monitor
161                     pmtag.
162
163
164       -t type       Specifies the port monitor type.
165
166
167       -v ver        Specifies  the  version  number of the port monitor. This
168                     version number may be given as
169
170                       -v `pmspec -V`
171
172
173                     where pmspec is the special  administrative  command  for
174                     port  monitor  pmtag.  This special command is ttyadm for
175                     ttymon and nlsadmin for listen. The version stamp of  the
176                     port monitor is known by the command and is returned when
177                     pmspec is invoked with a -V option.
178
179
180       -x            The -x option by itself  tells the SAC to read its  data‐
181                     base  file  (_sactab).  The  -x option with the -p option
182                     tells port monitor pmtag to read its administrative file.
183
184
185       -y comment    Include comment in the _sactab  entry  for  port  monitor
186                     pmtag.
187
188
189       -z script     Used  with the -g and -G options to specify the name of a
190                     file that contains a configuration script.  With  the  -g
191                     option,   script  is  a  per-port  monitor  configuration
192                     script; with -G it is a per-system configuration  script.
193                     Modifying  a  configuration script is a three-step proce‐
194                     dure. First a copy of the existing script is made (-g  or
195                     -G). Then the copy is edited. Finally, the copy is put in
196                     place over the existing script (-g or -G with -z).
197
198

OUTPUT

200       If successful, sacadm will exit with a status of 0. If sacadm fails for
201       any  reason,  it  will exit with a nonzero status. Options that request
202       information will write the information on the standard output.  In  the
203       condensed  format  (-L),  port  monitor  information  is  printed  as a
204       sequence of colon-separated fields; empty fields are indicated  by  two
205       successive colons. The standard format (-l) prints a header identifying
206       the columns, and port monitor information is aligned under  the  appro‐
207       priate  headings.  In  this  format,  an  empty field is indicated by a
208       hyphen. The comment character is #.
209

EXAMPLES

211       Example 1 A sample output of the sacadm command.
212
213
214       The following command line adds a port monitor. The port monitor tag is
215       npack;  its  type  is listen; if necessary, it will restart three times
216       before failing; its administrative command is nlsadmin; and the config‐
217       uration script to be read is in the file script:
218
219
220         sacadm -a -p npack -t listen -c /usr/lib/saf/listen npack
221         -v `nlsadmin -V` -n 3 -z script
222
223
224
225
226       Remove a port monitor whose tag is pmtag:
227
228
229         sacadm -r -p pmtag
230
231
232
233
234       Start the port monitor whose tag is pmtag:
235
236
237         sacadm -s -p pmtag
238
239
240
241
242       Stop the port monitor whose tag is pmtag:
243
244
245         sacadm -k -p pmtag
246
247
248
249
250       Enable the port monitor whose tag is pmtag:
251
252
253         sacadm -e -p pmtag
254
255
256
257
258       Disable the port monitor whose tag is pmtag:
259
260
261         sacadm -d -p pmtag
262
263
264
265
266       List status information for all port monitors:
267
268
269         sacadm -l
270
271
272
273
274       List status information for the port monitor whose tag is pmtag:
275
276
277         sacadm -l -p pmtag
278
279
280
281
282       List the same information in condensed format:
283
284
285         sacadm -L -p pmtag
286
287
288
289
290       List status information for all port monitors whose type is listen:
291
292
293         sacadm -l -t listen
294
295
296
297
298       Replace  the  per-port monitor configuration script associated with the
299       port monitor whose tag is pmtag with the contents of the file file.con‐
300       fig:
301
302
303         sacadm -g -p pmtag -z file.config
304
305
306

FILES

308       /etc/saf/_sactab
309
310
311       /etc/saf/_sysconfig
312
313
314       /etc/saf/pmtag/_config
315
316

ATTRIBUTES

318       See attributes(5) for descriptions of the following attributes:
319
320
321
322
323       ┌─────────────────────────────┬─────────────────────────────┐
324       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
325       ├─────────────────────────────┼─────────────────────────────┤
326       │Availability                 │SUNWcsu                      │
327       └─────────────────────────────┴─────────────────────────────┘
328