share/man/man8/sacadm.8

   1 '\" te
   2 .\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH SACADM 8 "Sep 14, 1992"
   8 .SH NAME
   9 sacadm \- service access controller administration
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBsacadm\fR \fB-a\fR \fB-p\fR \fIpmtag\fR \fB-t\fR \fItype\fR \fB-c\fR \fIcmd\fR \fB-v\fR \fIver\fR [\fB-f\fR dx] [\fB-n\fR \fIcount\fR]
  14      [\fB-y\fR \fIcomment\fR] [\fB-z\fR \fIscript\fR]
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBsacadm\fR \fB-r\fR \fB-p\fR \fIpmtag\fR
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBsacadm\fR \fB-s\fR \fB-p\fR \fIpmtag\fR
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBsacadm\fR \fB-k\fR \fB-p\fR \fIpmtag\fR
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBsacadm\fR \fB-e\fR \fB-p\fR \fIpmtag\fR
  35 .fi
  36
  37 .LP
  38 .nf
  39 \fBsacadm\fR \fB-d\fR \fB-p\fR \fIpmtag\fR
  40 .fi
  41
  42 .LP
  43 .nf
  44 \fBsacadm\fR \fB-l\fR [\fB-p\fR \fIpmtag\fR | \fB-t\fR \fItype\fR]
  45 .fi
  46
  47 .LP
  48 .nf
  49 \fBsacadm\fR \fB-L\fR [\fB-p\fR \fIpmtag\fR | \fB-t\fR \fItype\fR]
  50 .fi
  51
  52 .LP
  53 .nf
  54 \fBsacadm\fR \fB-g\fR \fB-p\fR \fIpmtag\fR [\fB-z\fR \fIscript\fR]
  55 .fi
  56
  57 .LP
  58 .nf
  59 \fBsacadm\fR \fB-G\fR [\fB-z\fR \fIscript\fR]
  60 .fi
  61
  62 .LP
  63 .nf
  64 \fBsacadm\fR \fB-x\fR [\fB-p\fR \fIpmtag\fR]
  65 .fi
  66
  67 .SH DESCRIPTION
  68 .sp
  69 .LP
  70 \fBsacadm\fR is the administrative command for the upper level of the Service
  71 Access Facility hierarchy (port monitor administration). \fBsacadm\fR performs
  72 the following functions:
  73 .RS +4
  74 .TP
  75 .ie t \(bu
  76 .el o
  77 adds or removes a port monitor
  78 .RE
  79 .RS +4
  80 .TP
  81 .ie t \(bu
  82 .el o
  83 starts or stops a port monitor
  84 .RE
  85 .RS +4
  86 .TP
  87 .ie t \(bu
  88 .el o
  89 enables or disables a port monitor
  90 .RE
  91 .RS +4
  92 .TP
  93 .ie t \(bu
  94 .el o
  95 installs or replaces a per-system configuration script
  96 .RE
  97 .RS +4
  98 .TP
  99 .ie t \(bu
 100 .el o
 101 installs or replaces a per-port monitor configuration script
 102 .RE
 103 .RS +4
 104 .TP
 105 .ie t \(bu
 106 .el o
 107 prints requested port monitor information
 108 .RE
 109 .sp
 110 .LP
 111 Requests about the status of port monitors (\fB-l\fR and \fB-L\fR) and requests
 112 to print per-port monitor and per-system configuration scripts (\fB-g\fR and
 113 \fB-G\fR without the \fB-z\fR option) may be executed by any user on the
 114 system. Other \fBsacadm\fR commands may be executed only by the super-user.
 115 .SH OPTIONS
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-a\fR\fR
 120 .ad
 121 .RS 14n
 122 Add a port monitor. When adding a port monitor, \fBsacadm\fR creates the
 123 supporting directory structure in \fB/etc/saf\fR and \fB/var/saf\fR and adds an
 124 entry for the new port monitor to \fB/etc/saf/_sactab\fR. The file
 125 \fB_sactab\fR already exists on the delivered system. Initially, it is empty
 126 except for a single line, which contains the version number of the Service
 127 Access Controller. Unless the command line that adds the new port monitor
 128 includes the \fB-f\fR option with the \fB-x\fR argument, the new port monitor
 129 will be started. Because of the complexity of the options and arguments that
 130 follow the \fB- a\fR option, it may be convenient to use a command script or
 131 the menu system to add port monitors.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fB-c\fR \fIcmd\fR\fR
 138 .ad
 139 .RS 14n
 140 Execute the command string \fIcmd\fR to start a port monitor. The \fB-c\fR
 141 option may be used only with a \fB-a\fR. A \fB-a\fR option requires a \fB-c\fR.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fB-d\fR\fR
 148 .ad
 149 .RS 14n
 150 Disable the port monitor \fIpmtag\fR.
 151 .RE
 152
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fB-e\fR\fR
 157 .ad
 158 .RS 14n
 159 Enable the port monitor \fIpmtag\fR.
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fB-f\fR \fBdx\fR\fR
 166 .ad
 167 .RS 14n
 168 The \fB-f\fR option  specifies one or both of the following two flags which are
 169 then included in the flags field of the \fB_sactab\fR entry for the new port
 170 monitor. If the \fB-f\fR option is not included on the command line, no flags
 171 are set and the default conditions prevail. By default, a port monitor is
 172 started. A \fB-f\fR option with no following argument is illegal.
 173 .sp
 174 .ne 2
 175 .na
 176 \fBd\fR
 177 .ad
 178 .RS 5n
 179 Do not enable the new port monitor.
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fBx\fR
 186 .ad
 187 .RS 5n
 188 Do not start the new port monitor.
 189 .RE
 190
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fB-g\fR\fR
 197 .ad
 198 .RS 14n
 199 The \fB-g\fR option is used to request output or to install or replace the
 200 per-port monitor configuration script \fB/etc/saf/\fR\fIpmtag\fR\fB/_config\fR.
 201 \fB-g\fR requires a \fB-p\fR option. The \fB-g\fR option with only a \fB-p\fR
 202 option prints the per-port monitor configuration script for port monitor
 203 \fIpmtag\fR. The \fB-g\fR option with a \fB-p\fR option and a \fB-z\fR option
 204 installs  the file \fBscript\fR as the per-port monitor configuration script
 205 for port monitor \fIpmtag\fR. Other combinations of options with \fB-g\fR are
 206 invalid.
 207 .RE
 208
 209 .sp
 210 .ne 2
 211 .na
 212 \fB\fB-G\fR\fR
 213 .ad
 214 .RS 14n
 215 The \fB-G\fR option is used to request output or to install or replace the
 216 per-system configuration script \fB/etc/saf/_sysconfig\fR. The \fB-G\fR option
 217 by itself prints the per-system configuration script. The \fB-G\fR option in
 218 combination with a \fB-z\fR option  installs the file \fBscript\fR as the
 219 per-system configuration script. Other combinations of options with a \fB-G\fR
 220 option are invalid.
 221 .RE
 222
 223 .sp
 224 .ne 2
 225 .na
 226 \fB\fB-k\fR\fR
 227 .ad
 228 .RS 14n
 229 Stop port monitor \fIpmtag\fR.
 230 .RE
 231
 232 .sp
 233 .ne 2
 234 .na
 235 \fB\fB-l\fR\fR
 236 .ad
 237 .RS 14n
 238 The \fB-l\fR option is used to request port monitor information. The \fB-l\fR
 239 by itself lists all port monitors on the system. The \fB-l\fR option in
 240 combination with the \fB-p\fR option lists only the port monitor specified by
 241 \fIpmtag\fR. A \fB-l\fR in combination with the \fB-t\fR option lists all port
 242 monitors of type \fBtype\fR. Any other combination of options with the \fB-l\fR
 243 option is invalid.
 244 .RE
 245
 246 .sp
 247 .ne 2
 248 .na
 249 \fB\fB-L\fR\fR
 250 .ad
 251 .RS 14n
 252 The \fB-L\fR option is identical to the \fB-l\fR option except that the output
 253 appears in a condensed format.
 254 .RE
 255
 256 .sp
 257 .ne 2
 258 .na
 259 \fB\fB-n\fR \fIcount\fR\fR
 260 .ad
 261 .RS 14n
 262 Set the restart count to \fIcount\fR. If a restart count is not specified,
 263 count is set to \fB0\fR. A count of \fB0\fR indicates that the port monitor is
 264 not to be restarted if it fails.
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fB\fB-p\fR \fIpmtag\fR\fR
 271 .ad
 272 .RS 14n
 273 Specifies the tag associated with a port monitor.
 274 .RE
 275
 276 .sp
 277 .ne 2
 278 .na
 279 \fB\fB-r\fR\fR
 280 .ad
 281 .RS 14n
 282 Remove port monitor \fIpmtag\fR. \fBsacadm\fR removes the port monitor entry
 283 from \fB/etc/saf/_sactab\fR. If the removed port monitor is not running, then
 284 no further action is taken. If the removed port monitor is running, the Service
 285 Access Controller (SAC) sends it \fBSIGTERM\fR to indicate that it should shut
 286 down. Note that the port monitor's directory structure remains intact.
 287 .RE
 288
 289 .sp
 290 .ne 2
 291 .na
 292 \fB\fB-s\fR\fR
 293 .ad
 294 .RS 14n
 295 Start a port monitor. The SAC starts the port monitor \fIpmtag\fR.
 296 .RE
 297
 298 .sp
 299 .ne 2
 300 .na
 301 \fB\fB-t\fR \fBtype\fR\fR
 302 .ad
 303 .RS 14n
 304 Specifies the port monitor type.
 305 .RE
 306
 307 .sp
 308 .ne 2
 309 .na
 310 \fB\fB-v\fR \fBver\fR\fR
 311 .ad
 312 .RS 14n
 313 Specifies the version number of the port monitor. This version number may be
 314 given as
 315 .sp
 316 .in +2
 317 .nf
 318 \fB\fR\fB-v\fR\fB `\fR\fIpmspec\fR \fB-V\fR`
 319 .fi
 320 .in -2
 321 .sp
 322
 323 where \fIpmspec\fR is the special administrative command for port monitor
 324 \fIpmtag\fR. This special command is \fBttyadm\fR for \fBttymon\fR and
 325 \fBnlsadmin\fR for \fBlisten\fR. The version stamp of the port monitor is known
 326 by the command and is returned when \fIpmspec\fR is invoked with a \fB-V\fR
 327 option.
 328 .RE
 329
 330 .sp
 331 .ne 2
 332 .na
 333 \fB\fB-x\fR\fR
 334 .ad
 335 .RS 14n
 336 The \fB-x\fR option by itself  tells the SAC to read its database file
 337 (\fB_sactab\fR). The \fB-x\fR option with the \fB-p\fR option tells port
 338 monitor \fIpmtag\fR to read its administrative file.
 339 .RE
 340
 341 .sp
 342 .ne 2
 343 .na
 344 \fB\fB-y\fR \fIcomment\fR\fR
 345 .ad
 346 .RS 14n
 347 Include \fIcomment\fR in the \fB_sactab\fR entry for port monitor \fIpmtag\fR.
 348 .RE
 349
 350 .sp
 351 .ne 2
 352 .na
 353 \fB\fB-z\fR \fBscript\fR\fR
 354 .ad
 355 .RS 14n
 356 Used with the \fB-g\fR and \fB-G\fR options to specify the name of a file that
 357 contains a configuration script. With the \fB-g\fR option, \fBscript\fR is a
 358 per-port monitor configuration script; with \fB-G\fR it is a per-system
 359 configuration script. Modifying a configuration script is a three-step
 360 procedure. First a copy of the existing script is made (\fB-g\fR or \fB-G\fR).
 361 Then the copy is edited. Finally, the copy is put in place over the existing
 362 script (\fB-g\fR or \fB-G\fR with \fB-z\fR).
 363 .RE
 364
 365 .SH OUTPUT
 366 .sp
 367 .LP
 368 If successful, \fBsacadm\fR will exit with a status of \fB0\fR. If \fBsacadm\fR
 369 fails for any reason, it will exit with a nonzero status. Options that request
 370 information will write the information on the standard output. In the condensed
 371 format (\fB-L\fR), port monitor information is printed as a sequence of
 372 colon-separated fields; empty fields are indicated by two successive colons.
 373 The standard format (\fB-l\fR) prints a header identifying the columns, and
 374 port monitor information is aligned under the appropriate headings. In this
 375 format, an empty field is indicated by a hyphen. The comment character is
 376 \fB#\fR.
 377 .SH EXAMPLES
 378 .LP
 379 \fBExample 1 \fRA sample output of the \fBsacadm\fR command.
 380 .sp
 381 .LP
 382 The following command line adds a port monitor. The port monitor tag is
 383 \fBnpack\fR; its type is \fBlisten\fR; if necessary, it will restart three
 384 times before failing; its administrative command is \fBnlsadmin\fR; and the
 385 configuration script to be read is in the file \fBscript\fR:
 386
 387 .sp
 388 .in +2
 389 .nf
 390 \fBsacadm \fR\fB-a\fR\fB \fR\fB-p\fR\fB npack \fR\fB-t\fR\fB listen \fR\fB-c\fR\fB /usr/lib/saf/listen npack\fR
 391 \fB\fR\fB-v\fR\fB `nlsadmin \fR\fB-V\fR\fB` \fR\fB-n\fR\fB 3 \fR\fB-z\fR\fB script\fR
 392 .fi
 393 .in -2
 394 .sp
 395
 396 .sp
 397 .LP
 398 Remove a port monitor whose tag is \fBpmtag\fR:
 399
 400 .sp
 401 .in +2
 402 .nf
 403 \fBsacadm\fR \fB-r\fR \fB-p\fR \fBpmtag\fR
 404 .fi
 405 .in -2
 406 .sp
 407
 408 .sp
 409 .LP
 410 Start the port monitor whose tag is \fBpmtag\fR:
 411
 412 .sp
 413 .in +2
 414 .nf
 415 \fBsacadm\fR \fB-s\fR \fB-p\fR \fBpmtag\fR
 416 .fi
 417 .in -2
 418 .sp
 419
 420 .sp
 421 .LP
 422 Stop the port monitor whose tag is \fBpmtag\fR:
 423
 424 .sp
 425 .in +2
 426 .nf
 427 \fBsacadm\fR \fB-k\fR \fB-p\fR \fBpmtag\fR
 428 .fi
 429 .in -2
 430 .sp
 431
 432 .sp
 433 .LP
 434 Enable the port monitor whose tag is \fBpmtag\fR:
 435
 436 .sp
 437 .in +2
 438 .nf
 439 \fBsacadm\fR \fB-e\fR \fB-p\fR \fBpmtag\fR
 440 .fi
 441 .in -2
 442 .sp
 443
 444 .sp
 445 .LP
 446 Disable the port monitor whose tag is \fBpmtag\fR:
 447
 448 .sp
 449 .in +2
 450 .nf
 451 \fBsacadm\fR \fB-d\fR \fB-p\fR \fBpmtag\fR
 452 .fi
 453 .in -2
 454 .sp
 455
 456 .sp
 457 .LP
 458 List status information for all port monitors:
 459
 460 .sp
 461 .in +2
 462 .nf
 463 \fBsacadm\fR \fB-l\fR
 464 .fi
 465 .in -2
 466 .sp
 467
 468 .sp
 469 .LP
 470 List status information for the port monitor whose tag is \fBpmtag\fR:
 471
 472 .sp
 473 .in +2
 474 .nf
 475 \fBsacadm\fR \fB-l\fR \fB-p\fR \fBpmtag\fR
 476 .fi
 477 .in -2
 478 .sp
 479
 480 .sp
 481 .LP
 482 List the same information in condensed format:
 483
 484 .sp
 485 .in +2
 486 .nf
 487 \fBsacadm\fR \fB-L\fR \fB-p\fR \fBpmtag\fR
 488 .fi
 489 .in -2
 490 .sp
 491
 492 .sp
 493 .LP
 494 List status information for all port monitors whose type is \fBlisten\fR:
 495
 496 .sp
 497 .in +2
 498 .nf
 499 \fBsacadm\fR \fB-l\fR \fB-t\fR \fBlisten\fR
 500 .fi
 501 .in -2
 502 .sp
 503
 504 .sp
 505 .LP
 506 Replace the per-port monitor configuration script associated with the port
 507 monitor whose tag is \fBpmtag\fR with the contents of the file
 508 \fBfile.config\fR:
 509
 510 .sp
 511 .in +2
 512 .nf
 513 \fBsacadm\fR \fB-g\fR \fB-p\fR \fBpmtag\fR \fB-z\fR \fBfile.config\fR
 514 .fi
 515 .in -2
 516 .sp
 517
 518 .SH FILES
 519 .sp
 520 .ne 2
 521 .na
 522 \fB\fB/etc/saf/_sactab\fR\fR
 523 .ad
 524 .RS 26n
 525
 526 .RE
 527
 528 .sp
 529 .ne 2
 530 .na
 531 \fB\fB/etc/saf/_sysconfig\fR\fR
 532 .ad
 533 .RS 26n
 534
 535 .RE
 536
 537 .sp
 538 .ne 2
 539 .na
 540 \fB\fB/etc/saf/\fIpmtag\fR\fR\fB/_config\fR\fR
 541 .ad
 542 .RS 26n
 543
 544 .RE
 545
 546 .SH SEE ALSO
 547 .sp
 548 .LP
 549 \fBpmadm\fR(8), \fBsac\fR(8), \fBdoconfig\fR(3NSL), \fBattributes\fR(5)