Print this page
3784 Paragraph in pmadm(1M) ends prematurely
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/pmadm.1m
+++ new/usr/src/man/man1m/pmadm.1m
1 1 '\" te
2 2 .\" Copyright 1989 AT&T Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved
3 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 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 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 6 .TH PMADM 1M "Nov 10, 1998"
7 7 .SH NAME
8 8 pmadm \- port monitor administration
9 9 .SH SYNOPSIS
10 10 .LP
11 11 .nf
12 12 \fBpmadm\fR \fB-a\fR [\fB-p\fR \fIpmtag\fR | \fB-t\fR \fItype\fR] \fB-s\fR \fIsvctag\fR \fB-i\fR \fIid\fR \fB-m\fR \fIpmspecific\fR \fB-v\fR \fIver\fR
13 13 [\fB-f\fR xu]
14 14 [\fB-y\fR \fIcomment\fR] [\fB-z\fR \fI script\fR]
15 15 .fi
16 16
17 17 .LP
18 18 .nf
19 19 \fBpmadm\fR \fB-r\fR \fB-p\fR \fIpmtag\fR \fB-s\fR \fIsvctag\fR
20 20 .fi
21 21
22 22 .LP
23 23 .nf
24 24 \fBpmadm\fR \fB-e\fR \fB-p\fR \fIpmtag\fR \fB-s\fR \fIsvctag\fR
25 25 .fi
26 26
27 27 .LP
28 28 .nf
29 29 \fBpmadm\fR \fB-d\fR \fB-p\fR \fIpmtag\fR \fB-s\fR \fIsvctag\fR
30 30 .fi
31 31
32 32 .LP
33 33 .nf
34 34 \fBpmadm\fR \fB-l\fR [\fB-t\fR \fItype\fR | \fB-p\fR \fIpmtag\fR] [\fB-s\fR \fIsvctag\fR]
35 35 .fi
36 36
37 37 .LP
38 38 .nf
39 39 \fBpmadm\fR \fB-L\fR [\fB-t\fR \fItype\fR | \fB-p\fR \fIpmtag\fR] [\fB-s\fR \fIsvctag\fR]
40 40 .fi
41 41
42 42 .LP
43 43 .nf
44 44 \fBpmadm\fR \fB-g\fR \fB-p\fR \fIpmtag\fR \fB-s\fR \fIsvctag\fR [\fB-z\fR \fIscript\fR]
45 45 .fi
46 46
47 47 .LP
48 48 .nf
49 49 \fBpmadm\fR \fB-g\fR \fB-s\fR \fIsvctag\fR \fB-t\fR \fItype\fR \fB-z\fR \fIscript\fR
50 50 .fi
|
↓ open down ↓ |
50 lines elided |
↑ open up ↑ |
51 51
52 52 .SH DESCRIPTION
53 53 .sp
54 54 .LP
55 55 \fBpmadm\fR is the administrative command for the lower level of the Service
56 56 Access Facility hierarchy, that is, for service administration. A port may have
57 57 only one service associated with it although the same service may be available
58 58 through more than one port. In order to uniquely identify an instance of a
59 59 service, the \fBpmadm\fR command must identify both the port monitor or port
60 60 monitors through which the service is available (\fB-p\fR or \fB-t\fR) and the
61 -service (\fB-s\fR). See .
61 +service (\fB-s\fR). See \fBsacadm\fR(1M).
62 62 .sp
63 63 .LP
64 64 \fBpmadm\fR performs the following functions:
65 65 .RS +4
66 66 .TP
67 67 .ie t \(bu
68 68 .el o
69 69 adds or removes a service
70 70 .RE
71 71 .RS +4
72 72 .TP
73 73 .ie t \(bu
74 74 .el o
75 75 enables or disables a service
76 76 .RE
77 77 .RS +4
78 78 .TP
79 79 .ie t \(bu
80 80 .el o
81 81 installs or replaces a per-service configuration script
82 82 .RE
83 83 .RS +4
84 84 .TP
85 85 .ie t \(bu
86 86 .el o
87 87 prints requested service information
88 88 .RE
89 89 .sp
90 90 .LP
91 91 Any user on the system may invoke \fBpmadm\fR to request service status
92 92 (\fB-l\fR or \fB-L\fR) or to print per-service configuration scripts (\fB-g\fR
93 93 without the \fB-z\fR option). \fBpmadm\fR with other options may be executed
94 94 only by a privileged user.
95 95 .SH OPTIONS
96 96 .sp
97 97 .LP
98 98 The following options are supported:
99 99 .sp
100 100 .ne 2
101 101 .na
102 102 \fB\fB-a\fR\fR
103 103 .ad
104 104 .RS 17n
105 105 Add a service. \fBpmadm\fR adds an entry for the new service to the port
106 106 monitor's administrative file. Because of the complexity of the options and
107 107 arguments that follow the \fB-a\fR option, it may be convenient to use a
108 108 command script or the menu system to add services.
109 109 .RE
110 110
111 111 .sp
112 112 .ne 2
113 113 .na
114 114 \fB\fB-d\fR\fR
115 115 .ad
116 116 .RS 17n
117 117 Disable a service. Add \fBx\fR to the flag field in the entry for the service
118 118 \fIsvctag\fR in the port monitor's administrative file. This is the entry used
119 119 by port monitor \fIpmtag\fR. See the \fB-f\fR option, below, for a description
120 120 of the flags available.
121 121 .RE
122 122
123 123 .sp
124 124 .ne 2
125 125 .na
126 126 \fB\fB-e\fR\fR
127 127 .ad
128 128 .RS 17n
129 129 Enable a service. Remove \fBx\fR from the flag field in the entry for the
130 130 service \fIsvctag\fR in the port monitor administrative file. This is the entry
131 131 used by port monitor \fIpmtag\fR. See the \fB-f\fR option, below, for a
132 132 description of the flags available.
133 133 .RE
134 134
135 135 .sp
136 136 .ne 2
137 137 .na
138 138 \fB\fB-f\fR \fBxu\fR\fR
139 139 .ad
140 140 .RS 17n
141 141 The \fB-f\fR option specifies one or both of the following two flags which are
142 142 then included in the flag field of the entry for the new service in the port
143 143 monitor's administrative file. If the \fB-f\fR option is not included, no flags
144 144 are set and the default conditions prevail. By default, a new service is
145 145 enabled and no \fButmpx\fR entry is created for it. An \fB-f\fR option without
146 146 a following argument is illegal.
147 147 .sp
148 148 .ne 2
149 149 .na
150 150 \fB\fBx\fR\fR
151 151 .ad
152 152 .RS 5n
153 153 Do not enable the service \fIsvctag\fR available through port monitor
154 154 \fIpmtag\fR.
155 155 .RE
156 156
157 157 .sp
158 158 .ne 2
159 159 .na
160 160 \fB\fBu\fR\fR
161 161 .ad
162 162 .RS 5n
163 163 Create a \fButmpx\fR entry for service \fIsvctag\fR available through port
164 164 monitor \fIpmtag\fR.
165 165 .RE
166 166
167 167 .RE
168 168
169 169 .sp
170 170 .ne 2
171 171 .na
172 172 \fB\fB-g\fR\fR
173 173 .ad
174 174 .RS 17n
175 175 Print, install, or replace a per-service configuration script. The \fB-g\fR
176 176 option with a \fB-p\fR option and a \fB-s\fR option prints the per-service
177 177 configuration script for service \fIsvctag\fR available through port monitor
178 178 \fIpmtag\fR. The \fB-g\fR option with a \fB-p\fR option, a \fB-s\fR option, and
179 179 a \fB-z\fR option installs the per-service configuration script contained in
180 180 the file \fBscript\fR as the per-service configuration script for service
181 181 \fIsvctag\fR available through port monitor \fIpmtag\fR. The \fB-g\fR option
182 182 with a \fB- s\fR option, a \fB-t\fR option, and a \fB-z\fR option installs the
183 183 file \fBscript\fR as the per-service configuration script for service
184 184 \fIsvctag\fR available through any port monitor of type \fBtype\fR. Other
185 185 combinations of options with \fB-g\fR are invalid.
186 186 .RE
187 187
188 188 .sp
189 189 .ne 2
190 190 .na
191 191 \fB\fB-i\fR\fI id\fR\fR
192 192 .ad
193 193 .RS 17n
194 194 \fBid\fR is the identity that is to be assigned to service \fIsvctag\fR when it
195 195 is started. \fBid\fR must be an entry in \fB/etc/passwd\fR.
196 196 .RE
197 197
198 198 .sp
199 199 .ne 2
200 200 .na
201 201 \fB\fB-l\fR\fR
202 202 .ad
203 203 .RS 17n
204 204 The \fB-l\fR option requests service information. Used by itself and with the
205 205 options described below, it provides a filter for extracting information in
206 206 several different groupings.
207 207 .sp
208 208 .ne 2
209 209 .na
210 210 \fB\fB-l\fR\fR
211 211 .ad
212 212 .RS 23n
213 213 By itself, the \fB-l\fR option lists all services on the system.
214 214 .RE
215 215
216 216 .sp
217 217 .ne 2
218 218 .na
219 219 \fB\fB\fR\fB-l\fR\fB \fR\fB-p\fR\fB \fR\fIpmtag\fR\fR
220 220 .ad
221 221 .RS 23n
222 222 Lists all services available through port monitor \fIpmtag\fR.
223 223 .RE
224 224
225 225 .sp
226 226 .ne 2
227 227 .na
228 228 \fB\fB\fR\fB-l\fR\fB \fR\fB-s\fR\fB \fR\fIsvctag\fR\fR
229 229 .ad
230 230 .RS 23n
231 231 Lists all services with tag \fIsvctag\fR.
232 232 .RE
233 233
234 234 .sp
235 235 .ne 2
236 236 .na
237 237 \fB\fB\fR\fB-l\fR\fB \fR\fB-p\fR\fB \fR\fIpmtag\fR\fB-s\fR\fIsvctag\fR\fR
238 238 .ad
239 239 .RS 23n
240 240 Lists service \fIsvctag\fR.
241 241 .RE
242 242
243 243 .sp
244 244 .ne 2
245 245 .na
246 246 \fB\fB\fR\fB-l\fR\fB \fR\fB-t\fR\fB \fR\fItype\fR\fR
247 247 .ad
248 248 .RS 23n
249 249 Lists all services available through port monitors of type \fBtype\fR.
250 250 .RE
251 251
252 252 .sp
253 253 .ne 2
254 254 .na
255 255 \fB\fB\fR\fB-l\fR\fB \fR\fB-t\fR\fB \fR\fItype\fR\fB-s\fR\fIsvctag\fR\fR
256 256 .ad
257 257 .RS 23n
258 258 Lists all services with tag \fIsvctag\fR available through a port monitor of
259 259 type \fBtype\fR.
260 260 .RE
261 261
262 262 Other combinations of options with \fB-l\fR are invalid.
263 263 .RE
264 264
265 265 .sp
266 266 .ne 2
267 267 .na
268 268 \fB\fB-L\fR\fR
269 269 .ad
270 270 .RS 17n
271 271 The \fB-L\fR option is identical to the \fB-l\fR option except that output is
272 272 printed in a condensed format.
273 273 .RE
274 274
275 275 .sp
276 276 .ne 2
277 277 .na
278 278 \fB\fB-m\fR\fI pmspecific\fR\fR
279 279 .ad
280 280 .RS 17n
281 281 \fIpmspecific\fR is the port monitor-specific portion of the port monitor
282 282 administrative file entry for the service.
283 283 .RE
284 284
285 285 .sp
286 286 .ne 2
287 287 .na
288 288 \fB\fB-p\fR\fI pmtag\fR\fR
289 289 .ad
290 290 .RS 17n
291 291 Specifies the tag associated with the port monitor through which a service
292 292 (specified as \fB\fR\fB-s\fR\fB \fR\fIsvctag\fR) is available.
293 293 .RE
294 294
295 295 .sp
296 296 .ne 2
297 297 .na
298 298 \fB\fB-r\fR\fR
299 299 .ad
300 300 .RS 17n
301 301 Remove a service. When \fBpmadm\fR removes a service, the entry for the service
302 302 is removed from the port monitor's administrative file.
303 303 .RE
304 304
305 305 .sp
306 306 .ne 2
307 307 .na
308 308 \fB\fB-s\fR\fI svctag\fR\fR
309 309 .ad
310 310 .RS 17n
311 311 Specifies the service tag associated with a given service. The service tag is
312 312 assigned by the system administrator and is part of the entry for the service
313 313 in the port monitor's administrative file.
314 314 .RE
315 315
316 316 .sp
317 317 .ne 2
318 318 .na
319 319 \fB\fB-t\fR\fI type\fR\fR
320 320 .ad
321 321 .RS 17n
322 322 Specifies the port monitor type.
323 323 .RE
324 324
325 325 .sp
326 326 .ne 2
327 327 .na
328 328 \fB\fB-v\fR\fI ver\fR\fR
329 329 .ad
330 330 .RS 17n
331 331 Specifies the version number of the port monitor administrative file. The
332 332 version number may be given as
333 333 .sp
334 334 .in +2
335 335 .nf
336 336 \fB-v\fR \fB\&'\fR\fIpmspec\fR \fB-V\fR
337 337 .fi
338 338 .in -2
339 339 .sp
340 340
341 341 where \fIpmspec\fR is the special administrative command for port monitor
342 342 \fIpmtag\fR. This special command is \fBttyadm\fR for \fBttymon\fR and
343 343 \fBnlsadmin\fR for \fBlisten\fR. The version stamp of the port monitor is known
344 344 by the command and is returned when \fIpmspec\fR is invoked with a \fB-V\fR
345 345 option.
346 346 .RE
347 347
348 348 .sp
349 349 .ne 2
350 350 .na
351 351 \fB\fB-y\fR\fI comment\fR\fR
352 352 .ad
353 353 .RS 17n
354 354 Associate \fIcomment\fR with the service entry in the port monitor
355 355 administrative file.
356 356 .RE
357 357
358 358 .sp
359 359 .ne 2
360 360 .na
361 361 \fB\fB-z\fR\fI script\fR\fR
362 362 .ad
363 363 .RS 17n
364 364 Used with the \fB-g\fR option to specify the name of the file that contains the
365 365 per-service configuration script. Modifying a configuration script is a
366 366 three-step procedure. First a copy of the existing script is made (\fB-g\fR
367 367 alone). Then the copy is edited. Finally, the copy is put in place over the
368 368 existing script (\fB-g\fR with \fB-z\fR).
369 369 .RE
370 370
371 371 .sp
372 372 .LP
373 373 Options that request information write the requested information to the
374 374 standard output. A request for information using the \fB-l\fR option prints
375 375 column headers and aligns the information under the appropriate headings. In
376 376 this format, a missing field is indicated by a hyphen. A request for
377 377 information in the condensed format using the \fB-L\fR option prints the
378 378 information in colon-separated fields; missing fields are indicated by two
379 379 successive colons. \fB#\fR is the comment character.
380 380 .SH EXAMPLES
381 381 .LP
382 382 \fBExample 1 \fRAdding a Service to a Port Monitor with the Tag \fBpmtag\fR
383 383 .sp
384 384 .LP
385 385 The following command adds a service to a port monitor with tag \fBpmtag\fR and
386 386 gives the service the tag \fBsvctag\fR. The port monitor-specific information
387 387 is generated by \fBspecpm\fR. The service defined by \fBsvctag\fR will be
388 388 invoked with identity \fBroot\fR.
389 389
390 390 .sp
391 391 .in +2
392 392 .nf
393 393 pmadm -a -p pmtag -s svctag -i root -m `specpm -a arg1 -b arg2`-v `specpm -V`
394 394 .fi
395 395 .in -2
396 396 .sp
397 397
398 398 .LP
399 399 \fBExample 2 \fRAdding a Service with Service Tab \fBsvctag\fR
400 400 .sp
401 401 .LP
402 402 The following command adds a service with service tag \fBsvctag\fR, identity
403 403 \fBguest\fR, and port monitor-specific information generated by \fBspecpm\fR to
404 404 all port monitors of type \fBtype\fR:
405 405
406 406 .sp
407 407 .in +2
408 408 .nf
409 409 pmadm -a -s svctag -i guest -t type -m `specpm -a arg1 -b arg2`-v `specpm -V`
410 410 .fi
411 411 .in -2
412 412 .sp
413 413
414 414 .LP
415 415 \fBExample 3 \fRRemoving a Service
416 416 .sp
417 417 .LP
418 418 The following command removes the service \fBsvctag\fR from port monitor
419 419 \fBpmtag\fR:
420 420
421 421 .sp
422 422 .in +2
423 423 .nf
424 424 pmadm -r -p pmtag -s svctag
425 425 .fi
426 426 .in -2
427 427 .sp
428 428
429 429 .LP
430 430 \fBExample 4 \fREnabling a Service
431 431 .sp
432 432 .LP
433 433 The following command enables the service \fBsvctag\fR available through port
434 434 monitor \fBpmtag\fR:
435 435
436 436 .sp
437 437 .in +2
438 438 .nf
439 439 pmadm -e -p pmtag -s svctag
440 440 .fi
441 441 .in -2
442 442 .sp
443 443
444 444 .LP
445 445 \fBExample 5 \fRDisabling a Service
446 446 .sp
447 447 .LP
448 448 The following command disables the service \fBsvctag\fR available through port
449 449 monitor \fBpmtag\fR:
450 450
451 451 .sp
452 452 .in +2
453 453 .nf
454 454 pmadm -d -p pmtag -s svctag
455 455 .fi
456 456 .in -2
457 457 .sp
458 458
459 459 .LP
460 460 \fBExample 6 \fRListing Status Information
461 461 .sp
462 462 .LP
463 463 The following command lists status information for all services:
464 464
465 465 .sp
466 466 .in +2
467 467 .nf
468 468 pmadm -l
469 469 .fi
470 470 .in -2
471 471 .sp
472 472
473 473 .LP
474 474 \fBExample 7 \fRListing Status Information
475 475 .sp
476 476 .LP
477 477 The following command lists status information for all services available
478 478 through the port monitor with tag \fBports\fR:
479 479
480 480 .sp
481 481 .in +2
482 482 .nf
483 483 pmadm -l -p ports
484 484 .fi
485 485 .in -2
486 486 .sp
487 487
488 488 .LP
489 489 \fBExample 8 \fRListing Status Information in Condensed Format
490 490 .sp
491 491 .LP
492 492 The following command lists the status information for all services available
493 493 through the port monitor with tag \fBports\fR in condensed format:
494 494
495 495 .sp
496 496 .in +2
497 497 .nf
498 498 pmadm -L -p ports
499 499 .fi
500 500 .in -2
501 501 .sp
502 502
503 503 .LP
504 504 \fBExample 9 \fRListing Status Information for All Services
505 505 .sp
506 506 .LP
507 507 List status information for all services available through port monitors of
508 508 type \fBlisten\fR:
509 509
510 510 .sp
511 511 .in +2
512 512 .nf
513 513 pmadm -l -t listen
514 514 .fi
515 515 .in -2
516 516 .sp
517 517
518 518 .LP
519 519 \fBExample 10 \fRPrinting the per-service Configuration
520 520 .sp
521 521 .LP
522 522 The following command prints the per-service configuration script associated
523 523 with the service \fBsvctag\fR available through port monitor \fBpmtag\fR:
524 524
525 525 .sp
526 526 .in +2
527 527 .nf
528 528 pmadm -g -p pmtag -s svctag
529 529 .fi
530 530 .in -2
531 531 .sp
532 532
533 533 .SH EXIT STATUS
534 534 .sp
535 535 .LP
536 536 The following exit values are returned:
537 537 .sp
538 538 .ne 2
539 539 .na
540 540 \fB\fB0\fR\fR
541 541 .ad
542 542 .RS 6n
543 543 Successful operation.
544 544 .RE
545 545
546 546 .sp
547 547 .ne 2
548 548 .na
549 549 \fB\fB>0\fR\fR
550 550 .ad
551 551 .RS 6n
552 552 Operation failed.
553 553 .RE
554 554
555 555 .SH FILES
556 556 .sp
557 557 .ne 2
558 558 .na
559 559 \fB\fB/etc/saf/\fR\fIpmtag\fR\fB/_config\fR\fR
560 560 .ad
561 561 .RS 26n
562 562
563 563 .RE
564 564
565 565 .sp
566 566 .ne 2
567 567 .na
568 568 \fB\fB/etc/saf/\fR\fIpmtag\fR\fB/\fR\fIsvctag\fR\fR
569 569 .ad
570 570 .RS 26n
571 571
572 572 .RE
573 573
574 574 .sp
575 575 .ne 2
576 576 .na
577 577 \fB\fB/var/saf/\fR\fIpmtag\fR\fB/*\fR\fR
578 578 .ad
579 579 .RS 26n
580 580
581 581 .RE
582 582
583 583 .SH SEE ALSO
584 584 .sp
585 585 .LP
586 586 \fBsac\fR(1M), \fBsacadm\fR(1M), \fBdoconfig\fR(3NSL), \fBattributes\fR(5)
|
↓ open down ↓ |
515 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX