Print this page
6506 wrong prop_pattern name in restarter service manifest
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/cmd/svc/milestone/restarter.xml
+++ new/usr/src/cmd/svc/milestone/restarter.xml
1 1 <?xml version="1.0"?>
2 2 <!DOCTYPE service_bundle SYSTEM "/usr/share/lib/xml/dtd/service_bundle.dtd.1">
3 3 <!--
4 4 Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
5 + Copyright 2015 Nexenta Systems, Inc. All rights reserved.
5 6
6 7 CDDL HEADER START
7 8
8 9 The contents of this file are subject to the terms of the
9 10 Common Development and Distribution License (the "License").
10 11 You may not use this file except in compliance with the License.
11 12
12 13 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
13 14 or http://www.opensolaris.org/os/licensing.
14 15 See the License for the specific language governing permissions
15 16 and limitations under the License.
16 17
17 18 When distributing Covered Code, include this CDDL HEADER in each
18 19 file and include the License file at usr/src/OPENSOLARIS.LICENSE.
19 20 If applicable, add the following below this CDDL HEADER, with the
20 21 fields enclosed by brackets "[]" replaced with your own identifying
21 22 information: Portions Copyright [yyyy] [name of copyright owner]
22 23
23 24 CDDL HEADER END
24 25
25 26 NOTE: This service manifest is not editable; its contents will
26 27 be overwritten by package or patch operations, including
27 28 operating system upgrade. Make customizations in a different
28 29 file.
29 30 -->
30 31
31 32 <service_bundle type='manifest' name='SUNWcsr:restarter'>
32 33
33 34 <service
34 35 name='system/svc/restarter'
35 36 type='restarter'
36 37 version='1'>
37 38
38 39 <!--
39 40 svc.startd manages itself. However, this manifest allows
40 41 us to set non-persistent properties before filesystems
41 42 have been mounted r/w.
42 43 -->
43 44
44 45 <create_default_instance enabled='true' />
45 46
46 47 <single_instance/>
47 48
48 49 <!--
49 50 The restarter is actually started by init, so these methods are
50 51 ignored. However, they are required by definition and are
51 52 included here to avoid spurious validation errors.
52 53 -->
53 54 <exec_method
54 55 type='method'
55 56 name='start'
56 57 exec=':true'
57 58 timeout_seconds='0' />
58 59
59 60 <exec_method
60 61 type='method'
61 62 name='stop'
62 63 exec=':true'
63 64 timeout_seconds='0' />
64 65
65 66 <stability value='Unstable' />
66 67
67 68 <template>
68 69 <common_name>
69 70 <loctext xml:lang='C'>
70 71 master restarter
71 72 </loctext>
72 73 </common_name>
73 74 <documentation>
74 75 <manpage title='svc.startd' section='1M'
75 76 manpath='/usr/share/man' />
76 77 <manpage title='smf_method' section='5'
77 78 manpath='/usr/share/man' />
78 79 <manpage title='smf' section='5'
79 80 manpath='/usr/share/man' />
80 81 </documentation>
81 82
82 83 <!--
83 84 Much of the restarter pg is populated by librestart, but
84 85 because svc.startd augments the property group, we choose
85 86 to define the entire property group as restarter-specific
86 87 rather than define it globally and miss some of the
87 88 properties. Templates does not currently provide a way
88 89 to have multiple entities 'own' and describe a property
89 90 group.
90 91 -->
91 92 <pg_pattern name='restarter' type='framework'
92 93 target='delegate' required='false'>
93 94 <description>
94 95 <loctext xml:lang='C'>
95 96 Communicate restarter-set status of the service.
96 97 </loctext>
97 98 </description>
98 99 <prop_pattern name='alt_logfile' type='astring'
99 100 required='false'>
100 101 <description>
101 102 <loctext xml:lang='C'>
102 103 The logfile for restarter actions on this service and any direct output from its methods which occurred before the /var filesystem was available.
103 104 </loctext>
104 105 </description>
105 106 <visibility value='readonly'/>
106 107 <cardinality min='1' max='1'/>
107 108 </prop_pattern>
108 109 <prop_pattern name='logfile' type='astring'
109 110 required='false'>
110 111 <description>
111 112 <loctext xml:lang='C'>
112 113 The logfile for restarter actions on this service and any direct output from its methods.
113 114 </loctext>
114 115 </description>
115 116 <visibility value='readonly'/>
116 117 <cardinality min='1' max='1'/>
117 118 </prop_pattern>
118 119 <prop_pattern name='contract' type='count'
119 120 required='false'>
120 121 <description>
121 122 <loctext xml:lang='C'>
122 123 Primary process contract for a 'contract' or 'child' service.
123 124 </loctext>
124 125 </description>
125 126 <visibility value='readonly'/>
126 127 <cardinality min='1' max='1'/>
127 128 </prop_pattern>
128 129 <prop_pattern name='start_pid' type='count'
129 130 required='false'>
130 131 <description>
131 132 <loctext xml:lang='C'>
132 133 PID last launched as the start method for this service.
133 134 </loctext>
134 135 </description>
135 136 <visibility value='readonly'/>
136 137 <cardinality min='1' max='1'/>
137 138 </prop_pattern>
138 139 <prop_pattern name='start_method_timestamp' type='time'
139 140 required='false'>
140 141 <description>
141 142 <loctext xml:lang='C'>
142 143 Time the start method was last run.
143 144 </loctext>
144 145 </description>
145 146 <visibility value='readonly'/>
146 147 <cardinality min='1' max='1'/>
147 148 </prop_pattern>
148 149 <prop_pattern name='auxiliary_state' type='astring'
149 150 required='false'>
150 151 <description>
151 152 <loctext xml:lang='C'>
152 153 Restarter-set auxiliary information about the current state.
153 154 </loctext>
154 155 </description>
155 156 <visibility value='readonly'/>
156 157 <cardinality min='1' max='1'/>
157 158 </prop_pattern>
158 159 <prop_pattern name='auxiliary_fmri' type='astring'
159 160 required='false'>
160 161 <description>
161 162 <loctext xml:lang='C'>
162 163 Auxiliary fmri information for service state diagnosis.
163 164 </loctext>
164 165 </description>
165 166 <visibility value='hidden' />
166 167 </prop_pattern>
167 168 <prop_pattern name='state_timestamp' type='time'
168 169 required='false'>
169 170 <description>
170 171 <loctext xml:lang='C'>
171 172 Time the current state was reached.
172 173 </loctext>
173 174 </description>
174 175 <visibility value='readonly'/>
175 176 <cardinality min='1' max='1'/>
176 177 </prop_pattern>
177 178 <prop_pattern name='state' type='astring'
178 179 required='false'>
179 180 <description>
180 181 <loctext xml:lang='C'>
181 182 The current state of this service instance.
182 183 </loctext>
183 184 </description>
184 185 <visibility value='readonly'/>
185 186 <cardinality min='1' max='1'/>
186 187 <constraints>
187 188 <value name="online">
188 189 <description>
189 190 <loctext xml:lang='C'>
190 191 The instance is online and running.
191 192 </loctext>
192 193 </description>
193 194 </value>
194 195 <value name="offline">
195 196 <description>
196 197 <loctext xml:lang='C'>
197 198 The instance is enabled, but not yet running or available to run. The most common reason for service instances to be in this state is because one or more of their dependencies are not satisfied.
198 199 </loctext>
199 200 </description>
200 201 </value>
201 202 <value name="uninitialized">
202 203 <description>
203 204 <loctext xml:lang='C'>
204 205 The initial state for all instances before svc.startd has had a chance to evaluate on them. Instances are in this state when their restarter has not yet started.
205 206 </loctext>
206 207 </description>
207 208 </value>
208 209 <value name="degraded">
209 210 <description>
210 211 <loctext xml:lang='C'>
211 212 The instance is enabled and running or available to run. The instance, however, is functioning at a limited capacity in comparison to normal operation.
212 213 </loctext>
213 214 </description>
214 215 </value>
215 216 <value name="disabled">
216 217 <description>
217 218 <loctext xml:lang='C'>
218 219 The instance is disabled.
219 220 </loctext>
220 221 </description>
221 222 </value>
222 223 <value name="maintenance">
223 224 <description>
224 225 <loctext xml:lang='C'>
225 226 The instance is enabled, but not able to run. Administrative action is required to restore the instance to offline and subsequent states.
226 227 </loctext>
227 228 </description>
228 229 </value>
229 230 </constraints>
230 231 </prop_pattern>
231 232 <prop_pattern name='next_state' type='astring'
232 233 required='false'>
233 234 <description>
234 235 <loctext xml:lang='C'>
235 236 The next expected state of this instance.
236 237 </loctext>
237 238 </description>
238 239 <visibility value='readonly'/>
239 240 <cardinality min='1' max='1'/>
240 241 <constraints>
241 242 <value name="online">
242 243 <description>
243 244 <loctext xml:lang='C'>
244 245 The instance is being started, and will soon be online and running. This transition may fail and the instance may end up in offiline or maintenance instead.
245 246 </loctext>
246 247 </description>
247 248 </value>
248 249 <value name="offline">
249 250 <description>
250 251 <loctext xml:lang='C'>
251 252 The instance has been temporarily stopped. Most instances will leave this state once their dependencies are satisfied.
252 253 </loctext>
253 254 </description>
254 255 </value>
255 256 <value name="degraded">
256 257 <description>
257 258 <loctext xml:lang='C'>
258 259 The instance will be enabled and availble to run, although in a limited capacity.
259 260 </loctext>
260 261 </description>
261 262 </value>
262 263 <value name="disabled">
263 264 <description>
264 265 <loctext xml:lang='C'>
265 266 The instance will be disabled.
266 267 </loctext>
267 268 </description>
268 269 </value>
269 270 <value name="maintenance">
270 271 <description>
271 272 <loctext xml:lang='C'>
272 273 The instance will be in maintenance, and administrative action will be required to restore the instance to offline and subsequent states.
273 274 </loctext>
274 275 </description>
275 276 </value>
276 277 <value name="none">
277 278 <description>
278 279 <loctext xml:lang='C'>
279 280 The instance is not currently transitioning between states.
280 281 </loctext>
281 282 </description>
282 283 </value>
283 284 </constraints>
284 285 </prop_pattern>
285 286 </pg_pattern>
286 287
287 288 <pg_pattern name='options' type='application'
288 289 target='this' required='false'>
289 290 <description>
290 291 <loctext xml:lang='C'>
291 292 Specify options for the svc.startd restarter.
292 293 </loctext>
293 294 </description>
294 295
295 296 <prop_pattern name='boot_messages' type='astring'
296 297 required='false'>
297 298 <description>
298 299 <loctext xml:lang='C'>
299 300 Define verbosity of messages to print to the console during boot.
300 301 </loctext>
301 302 </description>
302 303 <cardinality min='1' max='1'/>
303 304 <constraints>
304 305 <value name='quiet'>
305 306 <description>
306 307 <loctext xml:lang='C'>
307 308 Issue console messages only on service failures.
308 309 </loctext>
309 310 </description>
310 311 </value>
311 312 <value name='verbose'>
312 313 <description>
313 314 <loctext xml:lang='C'>
314 315 Print a message per service started to indicate success or failure.
315 316 </loctext>
316 317 </description>
317 318 </value>
318 319 </constraints>
319 320 <choices>
320 321 <include_values type='constraints'/>
321 322 </choices>
322 323 </prop_pattern>
323 324
324 325 <prop_pattern name='logging' type='astring'
325 326 required='false'>
326 327 <description>
327 328 <loctext xml:lang='C'>
328 329 Control the level of global service logging for svc.startd.
329 330 </loctext>
330 331 </description>
331 332 <cardinality min='1' max='1'/>
332 333 <constraints>
333 334 <value name='quiet'>
334 335 <description>
335 336 <loctext xml:lang='C'>
336 337 Send error messages requiring administrative intervention to console, syslog, and svc.startd's global logfile.
337 338 </loctext>
338 339 </description>
339 340 </value>
340 341 <value name='verbose'>
341 342 <description>
342 343 <loctext xml:lang='C'>
343 344 Sends a message per service started to the console, error messages requiring administrative intervention to console, syslog, and svc.startd's global logfile, and information about errors which do not require intervention to the logfile.
344 345 </loctext>
345 346 </description>
346 347 </value>
347 348 <value name='debug'>
348 349 <description>
349 350 <loctext xml:lang='C'>
350 351 Send debug messages to svc.startd's global logfile, error messages requiring administrative intervention to the console, syslog, and the logfile, and a message per service started to the console.
351 352 </loctext>
352 353 </description>
353 354 </value>
354 355 </constraints>
355 356 <choices>
356 357 <include_values type='constraints'/>
357 358 </choices>
358 359 </prop_pattern>
359 360
360 361 <prop_pattern name='milestone' type='astring'
361 362 required='false'>
362 363 <description>
363 364 <loctext xml:lang='C'>
364 365 An FRMI which defines the milestone used as the default boot level.
365 366 </loctext>
366 367 </description>
367 368 <cardinality min='1' max='1'/>
368 369 <constraints>
369 370 <value
370 371 name='svc:/milestone/single-user:default'>
371 372 </value>
372 373 <value
373 374 name='svc:/milestone/multi-user:default'>
374 375 </value>
375 376 <value name=
376 377 'svc:/milestone/multi-user-server:default'>
377 378 </value>
378 379 <value name='all'>
379 380 <description>
380 381 <loctext xml:lang='C'>
381 382 Start all enabled services.
382 383 </loctext>
383 384 </description>
|
↓ open down ↓ |
369 lines elided |
↑ open up ↑ |
384 385 </value>
385 386 <value name='none'>
386 387 <description>
387 388 <loctext xml:lang='C'>
388 389 Start no services.
389 390 </loctext>
390 391 </description>
391 392 </value>
392 393 </constraints>
393 394 </prop_pattern>
394 - <prop_pattern name='info_event_all' type='boolean'
395 + <prop_pattern name='info_events_all' type='boolean'
395 396 required='false'>
396 397 <description>
397 398 <loctext xml:lang='C'>
398 399 Override notification parameters and raise Information Events on all state transitions
399 400 </loctext>
400 401 </description>
401 402 <visibility value='hidden' />
402 403 </prop_pattern>
403 404 </pg_pattern>
404 405
405 406 <pg_pattern name='system' type='framework'
406 407 target='this' required='false'>
407 408 <prop_pattern name='reconfigure' type='boolean'
408 409 required='false'>
409 410 <description>
410 411 <loctext xml:lang='C'>
411 412 Indicates that a reconfiguration reboot has been requested.
412 413 </loctext>
413 414 </description>
414 415 <visibility value='readonly'/>
415 416 <cardinality min='1' max='1'/>
416 417 </prop_pattern>
417 418 </pg_pattern>
418 419
419 420 <pg_pattern name='startd' type='framework'
420 421 target='delegate' required='false'>
421 422 <description>
422 423 <loctext xml:lang='C'>
423 424 Information about how a service instance is managed by svc.startd, which is supplied by the service author, sometimes modified by the administrator.
424 425 </loctext>
425 426 </description>
426 427
427 428 <prop_pattern name='duration' type='astring'
428 429 required='false'>
429 430 <description>
430 431 <loctext xml:lang='C'>
431 432 Defines the service's model.
432 433 </loctext>
433 434 </description>
434 435 <cardinality min='1' max='1'/>
435 436 <constraints>
436 437 <value name='contract'>
437 438 <description>
438 439 <loctext xml:lang='C'>
439 440 A standard system daemon, which runs forever to provide a service. It is not considered online until the start method process exits, though child processes are monitored for errors.
440 441 </loctext>
441 442 </description>
442 443 </value>
443 444 <value name='transient'>
444 445 <description>
445 446 <loctext xml:lang='C'>
446 447 The service is online as soon as its start method returns -- child processes are not monitored.
447 448 </loctext>
448 449 </description>
449 450 </value>
450 451 <value name='child'>
451 452 <description>
452 453 <loctext xml:lang='C'>
453 454 A service which runs for the lifetime of the child process, and is restarted when that process exits.
454 455 </loctext>
455 456 </description>
456 457 </value>
457 458 </constraints>
458 459 <choices>
459 460 <include_values type='constraints'/>
460 461 </choices>
461 462 </prop_pattern>
462 463 <prop_pattern name='ignore_error' type='astring'
463 464 required='false'>
464 465 <description>
465 466 <loctext xml:lang='C'>
466 467 A list of events which should not be considered service errors by svc.startd.
467 468 </loctext>
468 469 </description>
469 470 <cardinality min='1' max='1'/>
470 471 <!--
471 472 We won't recommend this as a choice since
472 473 it's only here to work around the fact
473 474 that startd defines this as a single
474 475 value rather than a value list *and*
475 476 templates doesn't currently take care
476 477 of assembling separately defined
477 478 values with the defined internal separator.
478 479 -->
479 480 <values>
480 481 <value name='signal,core'>
481 482 <description>
482 483 <loctext xml:lang='C'>
483 484 svc.startd should ignore coredumps and signals sent from outside the service.
484 485 </loctext>
485 486 </description>
486 487 </value>
487 488 </values>
488 489 <choices>
489 490 <value name='core'>
490 491 <description>
491 492 <loctext xml:lang='C'>
492 493 svc.startd should ignore coredumps from subprocesses.
493 494 </loctext>
494 495 </description>
495 496 </value>
496 497 <value name='signal'>
497 498 <description>
498 499 <loctext xml:lang='C'>
499 500 svc.startd should ignore signals sent from outside the service.
500 501 </loctext>
501 502 </description>
502 503 </value>
503 504 <value name='core,signal'>
504 505 <description>
505 506 <loctext xml:lang='C'>
506 507 svc.startd should ignore coredumps and signals sent from outside the service.
507 508 </loctext>
508 509 </description>
509 510 </value>
510 511 </choices>
511 512 </prop_pattern>
512 513 <prop_pattern name='need_session' type='boolean'
513 514 required='false'>
514 515 <description>
515 516 <loctext xml:lang='C'>
516 517 The instance should be launched in its own session per setpgrp(2).
517 518 </loctext>
518 519 </description>
519 520 <cardinality min='1' max='1'/>
520 521 </prop_pattern>
521 522 <prop_pattern name='utmpx_prefix' type='astring'
522 523 required='false'>
523 524 <description>
524 525 <loctext xml:lang='C'>
525 526 The instance requires that svc.startd create a valid utmpx entry prior to start method execution.
526 527 </loctext>
527 528 </description>
528 529 <cardinality min='1' max='1'/>
529 530 </prop_pattern>
530 531 </pg_pattern>
531 532
532 533 <pg_pattern name='start' type='method' target='delegate'
533 534 required='true'>
534 535 <description>
535 536 <loctext xml:lang='C'>
536 537 The start method defines how svc.startd should start the instance.
537 538 </loctext>
538 539 </description>
539 540 <prop_pattern name='exec' type='astring'
540 541 required='true'>
541 542 <common_name>
542 543 <loctext xml:lang='C'>
543 544 method executable
544 545 </loctext>
545 546 </common_name>
546 547 <description>
547 548 <loctext xml:lang='C'>
548 549 The method executable may be a script, program, or keyword.
549 550 </loctext>
550 551 </description>
551 552 <cardinality min='1' max='1'/>
552 553 <values>
553 554 <value name=':true'>
554 555 <description>
555 556 <loctext xml:lang='C'>
556 557 Always returns SMF_EXIT_OK. This token should be used when the start method is unnecessary for the particular service implementation.
557 558 </loctext>
558 559 </description>
559 560 </value>
560 561 <value name=':kill [-signal]'>
561 562 <description>
562 563 <loctext xml:lang='C'>
563 564 Sends the specified signal, which is SIGTERM by default, to all processes in the primary instance contract. Always returns SMF_EXIT_OK. This token should be used to replace common pkill invocations.
564 565
565 566 </loctext>
566 567 </description>
567 568 </value>
568 569 </values>
569 570 <choices>
570 571 <include_values type='values'/>
571 572 </choices>
572 573 </prop_pattern>
573 574
574 575 <prop_pattern name='type' type='astring'
575 576 required='true'>
576 577 <description>
577 578 <loctext xml:lang='C'>
578 579 A method may only be of type method.
579 580 </loctext>
580 581 </description>
581 582 <cardinality min='1' max='1'/>
582 583 <constraints>
583 584 <value name="method"/>
584 585 </constraints>
585 586 </prop_pattern>
586 587
587 588 <prop_pattern name='timeout_seconds' type='count'
588 589 required='true'>
589 590 <description>
590 591 <loctext xml:lang='C'>
591 592 Number of seconds before the method is considered unresponsive. After the method timeout expires, the method will be killed.
592 593 </loctext>
593 594 </description>
594 595 <cardinality min='1' max='1'/>
595 596 <values>
596 597 <value name="0">
597 598 <common_name>
598 599 <loctext xml:lang='C'>
599 600 infinite
600 601 </loctext>
601 602 </common_name>
602 603 <description>
603 604 <loctext xml:lang='C'>
604 605 This method will never time out.
605 606 </loctext>
606 607 </description>
607 608 </value>
608 609 <value name="-1">
609 610 <common_name>
610 611 <loctext xml:lang='C'>
611 612 infinite (legacy)
612 613 </loctext>
613 614 </common_name>
614 615 <description>
615 616 <loctext xml:lang='C'>
616 617 This method will never time out. 0 is the preferred value.
617 618 </loctext>
618 619 </description>
619 620 </value>
620 621 </values>
621 622 </prop_pattern>
622 623
623 624 <!-- method_context direct properties -->
624 625 <prop_pattern name='working_directory' type='astring'
625 626 required='false'>
626 627 <description>
627 628 <loctext xml:lang='C'>
628 629 The working directory to launch the method from. ":default" can be used as a token to indicate the home directory of the user specified by the credential or profile.
629 630 </loctext>
630 631 </description>
631 632 <cardinality min='1' max='1'/>
632 633 </prop_pattern>
633 634 <prop_pattern name='project' type='astring'
634 635 required='false'>
635 636 <description>
636 637 <loctext xml:lang='C'>
637 638 The project ID in numeric or text form. :default can be used as a token to indicate a project identified by getdefaultproj(3PROJECT) for the user whose uid is used to launch the method.
638 639 </loctext>
639 640 </description>
640 641 <cardinality min='1' max='1'/>
641 642 </prop_pattern>
642 643 <prop_pattern name='resource_pool' type='astring'
643 644 required='false'>
644 645 <common_name>
645 646 <loctext xml:lang='C'>
646 647 method context resource pool
647 648 </loctext>
648 649 </common_name>
649 650 <description>
650 651 <loctext xml:lang='C'>
651 652 The resource pool name on which to launch the method. :default can be used
652 653 as a token to indicate the pool specified in the project(4) entry given in
653 654 the project attribute.
654 655 </loctext>
655 656 </description>
656 657 <cardinality min='1' max='1'/>
657 658 </prop_pattern>
658 659
659 660 <!-- method_credential properties -->
660 661 <prop_pattern name='user' type='astring'
661 662 required='false'>
662 663 <common_name>
663 664 <loctext xml:lang='C'>
664 665 method credential user
665 666 </loctext>
666 667 </common_name>
667 668 <description>
668 669 <loctext xml:lang='C'>
669 670 The user ID in numeric or text form.
670 671 </loctext>
671 672 </description>
672 673 <cardinality min='1' max='1'/>
673 674 </prop_pattern>
674 675 <prop_pattern name='group' type='astring'
675 676 required='false'>
676 677 <common_name>
677 678 <loctext xml:lang='C'>
678 679 method credential group
679 680 </loctext>
680 681 </common_name>
681 682 <description>
682 683 <loctext xml:lang='C'>
683 684 The group ID in numeric or text form.
684 685 </loctext>
685 686 </description>
686 687 <cardinality min='1' max='1'/>
687 688 </prop_pattern>
688 689 <prop_pattern name='supp_groups' type='astring'
689 690 required='false'>
690 691 <common_name>
691 692 <loctext xml:lang='C'>
692 693 method credential supplemental groups
693 694 </loctext>
694 695 </common_name>
695 696 <description>
696 697 <loctext xml:lang='C'>
697 698 An optional string that specifies the supplemental group memberships by ID,
698 699 in numeric or text form.
699 700 </loctext>
700 701 </description>
701 702 <cardinality min='1' max='1'/>
702 703 <internal_separators>,</internal_separators>
703 704 </prop_pattern>
704 705 <prop_pattern name='privileges' type='astring'
705 706 required='false'>
706 707 <common_name>
707 708 <loctext xml:lang='C'>
708 709 method credential privileges
709 710 </loctext>
710 711 </common_name>
711 712 <description>
712 713 <loctext xml:lang='C'>
713 714 An optional string specifying the privilege set as defined in privileges(5).
714 715 </loctext>
715 716 </description>
716 717 <cardinality min='1' max='1'/>
717 718 <internal_separators>,</internal_separators>
718 719 </prop_pattern>
719 720 <prop_pattern name='limit_privileges' type='astring'
720 721 required='false'>
721 722 <common_name>
722 723 <loctext xml:lang='C'>
723 724 method credential limit privilege set
724 725 </loctext>
725 726 </common_name>
726 727 <description>
727 728 <loctext xml:lang='C'>
728 729 An optional string specifying the limit privilege set as defined in
729 730 privileges(5).
730 731 </loctext>
731 732 </description>
732 733 <cardinality min='1' max='1'/>
733 734 <internal_separators>,</internal_separators>
734 735 </prop_pattern>
735 736
736 737 <!-- method_profile properties -->
737 738 <prop_pattern name='use_profile' type='boolean'
738 739 required='false'>
739 740 <description>
740 741 <loctext xml:lang='C'>
741 742 A boolean that specifies whether the profile should be used instead of the
742 743 user, group, privileges, and limit_privileges properties.
743 744 </loctext>
744 745 </description>
745 746 <cardinality min='1' max='1'/>
746 747 </prop_pattern>
747 748 <prop_pattern name='profile' type='astring'
748 749 required='false'>
749 750 <common_name>
750 751 <loctext xml:lang='C'>
751 752 method profile RBAC profile specification
752 753 </loctext>
753 754 </common_name>
754 755 <description>
755 756 <loctext xml:lang='C'>
756 757 The name of an RBAC (role-based access control) profile which, along with the
757 758 method executable, identifies an entry in exec_attr(4).
758 759 </loctext>
759 760 </description>
760 761 <cardinality min='1' max='1'/>
761 762 </prop_pattern>
762 763
763 764 <!-- method_environment properties -->
764 765 <prop_pattern name='environment' type='astring'
765 766 required='false'>
766 767 <common_name>
767 768 <loctext xml:lang='C'>
768 769 method environment variables
769 770 </loctext>
770 771 </common_name>
771 772 <description>
772 773 <loctext xml:lang='C'>
773 774 Environment variables to insert into the environment of the method, in the
774 775 form of a number of NAME=value strings.
775 776 </loctext>
776 777 </description>
777 778 </prop_pattern>
778 779 </pg_pattern>
779 780
780 781 <pg_pattern name='stop' type='method' target='delegate'
781 782 required='true'>
782 783 <description>
783 784 <loctext xml:lang='C'>
784 785 The stop method defines how svc.startd should stop the instance.
785 786 </loctext>
786 787 </description>
787 788 <prop_pattern name='exec' type='astring'
788 789 required='true'>
789 790 <common_name>
790 791 <loctext xml:lang='C'>
791 792 method executable
792 793 </loctext>
793 794 </common_name>
794 795 <description>
795 796 <loctext xml:lang='C'>
796 797 The method executable may be a script, program, or keyword.
797 798 </loctext>
798 799 </description>
799 800 <cardinality min='1' max='1'/>
800 801 <values>
801 802 <value name=':true'>
802 803 <description>
803 804 <loctext xml:lang='C'>
804 805 Always returns SMF_EXIT_OK. This token should be used when the stop method is unnecessary for the particular service implementation.
805 806 </loctext>
806 807 </description>
807 808 </value>
808 809 <value name=':kill [-signal]'>
809 810 <description>
810 811 <loctext xml:lang='C'>
811 812 Sends the specified signal, which is SIGTERM by default, to all processes in the primary instance contract. Always returns SMF_EXIT_OK. This token should be used to replace common pkill invocations.
812 813 </loctext>
813 814 </description>
814 815 </value>
815 816 </values>
816 817 <choices>
817 818 <include_values type='values'/>
818 819 </choices>
819 820 </prop_pattern>
820 821
821 822 <prop_pattern name='type' type='astring'
822 823 required='true'>
823 824 <description>
824 825 <loctext xml:lang='C'>
825 826 A method may only be of type method.
826 827 </loctext>
827 828 </description>
828 829 <cardinality min='1' max='1'/>
829 830 <constraints>
830 831 <value name="method"/>
831 832 </constraints>
832 833 </prop_pattern>
833 834
834 835 <prop_pattern name='timeout_seconds' type='count'
835 836 required='true'>
836 837 <description>
837 838 <loctext xml:lang='C'>
838 839 Number of seconds before the method is considered unresponsive. After the method timeout expires, the method will be killed.
839 840 </loctext>
840 841 </description>
841 842 <cardinality min='1' max='1'/>
842 843 <values>
843 844 <value name="0">
844 845 <common_name>
845 846 <loctext xml:lang='C'>
846 847 infinite
847 848 </loctext>
848 849 </common_name>
849 850 <description>
850 851 <loctext xml:lang='C'>
851 852 This method will never time out.
852 853 </loctext>
853 854 </description>
854 855 </value>
855 856 <value name="-1">
856 857 <common_name>
857 858 <loctext xml:lang='C'>
858 859 infinite (legacy)
859 860 </loctext>
860 861 </common_name>
861 862 <description>
862 863 <loctext xml:lang='C'>
863 864 This method will never time out. 0 is the preferred value.
864 865 </loctext>
865 866 </description>
866 867 </value>
867 868 </values>
868 869 </prop_pattern>
869 870
870 871 <!-- method_context direct properties -->
871 872 <prop_pattern name='working_directory' type='astring'
872 873 required='false'>
873 874 <description>
874 875 <loctext xml:lang='C'>
875 876 The working directory to launch the method from. ":default" can be used as a token to indicate the home directory of the user specified by the credential or profile.
876 877 </loctext>
877 878 </description>
878 879 <cardinality min='1' max='1'/>
879 880 </prop_pattern>
880 881 <prop_pattern name='project' type='astring'
881 882 required='false'>
882 883 <description>
883 884 <loctext xml:lang='C'>
884 885 The project ID in numeric or text form. :default can be used as a token to indicate a project identified by getdefaultproj(3PROJECT) for the user whose uid is used to launch the method.
885 886 </loctext>
886 887 </description>
887 888 <cardinality min='1' max='1'/>
888 889 </prop_pattern>
889 890 <prop_pattern name='resource_pool' type='astring'
890 891 required='false'>
891 892 <common_name>
892 893 <loctext xml:lang='C'>
893 894 method context resource pool
894 895 </loctext>
895 896 </common_name>
896 897 <description>
897 898 <loctext xml:lang='C'>
898 899 The resource pool name on which to launch the method. :default can be used
899 900 as a token to indicate the pool specified in the project(4) entry given in
900 901 the project attribute.
901 902 </loctext>
902 903 </description>
903 904 <cardinality min='1' max='1'/>
904 905 </prop_pattern>
905 906
906 907 <!-- method_credential properties -->
907 908 <prop_pattern name='user' type='astring'
908 909 required='false'>
909 910 <common_name>
910 911 <loctext xml:lang='C'>
911 912 method credential user
912 913 </loctext>
913 914 </common_name>
914 915 <description>
915 916 <loctext xml:lang='C'>
916 917 The user ID in numeric or text form.
917 918 </loctext>
918 919 </description>
919 920 <cardinality min='1' max='1'/>
920 921 </prop_pattern>
921 922 <prop_pattern name='group' type='astring'
922 923 required='false'>
923 924 <common_name>
924 925 <loctext xml:lang='C'>
925 926 method credential group
926 927 </loctext>
927 928 </common_name>
928 929 <description>
929 930 <loctext xml:lang='C'>
930 931 The group ID in numeric or text form.
931 932 </loctext>
932 933 </description>
933 934 <cardinality min='1' max='1'/>
934 935 </prop_pattern>
935 936 <prop_pattern name='supp_groups' type='astring'
936 937 required='false'>
937 938 <common_name>
938 939 <loctext xml:lang='C'>
939 940 method credential supplemental groups
940 941 </loctext>
941 942 </common_name>
942 943 <description>
943 944 <loctext xml:lang='C'>
944 945 An optional string that specifies the supplemental group memberships by ID,
945 946 in numeric or text form.
946 947 </loctext>
947 948 </description>
948 949 <cardinality min='1' max='1'/>
949 950 <internal_separators>,</internal_separators>
950 951 </prop_pattern>
951 952 <prop_pattern name='privileges' type='astring'
952 953 required='false'>
953 954 <common_name>
954 955 <loctext xml:lang='C'>
955 956 method credential privileges
956 957 </loctext>
957 958 </common_name>
958 959 <description>
959 960 <loctext xml:lang='C'>
960 961 An optional string specifying the privilege set as defined in privileges(5).
961 962 </loctext>
962 963 </description>
963 964 <cardinality min='1' max='1'/>
964 965 <internal_separators>,</internal_separators>
965 966 </prop_pattern>
966 967 <prop_pattern name='limit_privileges' type='astring'
967 968 required='false'>
968 969 <common_name>
969 970 <loctext xml:lang='C'>
970 971 method credential limit privilege set
971 972 </loctext>
972 973 </common_name>
973 974 <description>
974 975 <loctext xml:lang='C'>
975 976 An optional string specifying the limit privilege set as defined in
976 977 privileges(5).
977 978 </loctext>
978 979 </description>
979 980 <cardinality min='1' max='1'/>
980 981 <internal_separators>,</internal_separators>
981 982 </prop_pattern>
982 983
983 984 <!-- method_profile properties -->
984 985 <prop_pattern name='use_profile' type='boolean'
985 986 required='false'>
986 987 <description>
987 988 <loctext xml:lang='C'>
988 989 A boolean that specifies whether the profile should be used instead of the
989 990 user, group, privileges, and limit_privileges properties.
990 991 </loctext>
991 992 </description>
992 993 <cardinality min='1' max='1'/>
993 994 </prop_pattern>
994 995 <prop_pattern name='profile' type='astring'
995 996 required='false'>
996 997 <common_name>
997 998 <loctext xml:lang='C'>
998 999 method profile RBAC profile specification
999 1000 </loctext>
1000 1001 </common_name>
1001 1002 <description>
1002 1003 <loctext xml:lang='C'>
1003 1004 The name of an RBAC (role-based access control) profile which, along with the
1004 1005 method executable, identifies an entry in exec_attr(4).
1005 1006 </loctext>
1006 1007 </description>
1007 1008 <cardinality min='1' max='1'/>
1008 1009 </prop_pattern>
1009 1010
1010 1011 <!-- method_environment properties -->
1011 1012 <prop_pattern name='environment' type='astring'
1012 1013 required='false'>
1013 1014 <common_name>
1014 1015 <loctext xml:lang='C'>
1015 1016 method environment variables
1016 1017 </loctext>
1017 1018 </common_name>
1018 1019 <description>
1019 1020 <loctext xml:lang='C'>
1020 1021 Environment variables to insert into the environment of the method, in the
1021 1022 form of a number of NAME=value strings.
1022 1023 </loctext>
1023 1024 </description>
1024 1025 </prop_pattern>
1025 1026 </pg_pattern>
1026 1027
1027 1028 <pg_pattern name='refresh' type='method' target='delegate'
1028 1029 required='false'>
1029 1030 <description>
1030 1031 <loctext xml:lang='C'>
1031 1032 The refresh method defines how svc.startd should upload new configuration to the service without interrupting its operation.
1032 1033 </loctext>
1033 1034 </description>
1034 1035 <prop_pattern name='exec' type='astring'
1035 1036 required='true'>
1036 1037 <common_name>
1037 1038 <loctext xml:lang='C'>
1038 1039 method executable
1039 1040 </loctext>
1040 1041 </common_name>
1041 1042 <description>
1042 1043 <loctext xml:lang='C'>
1043 1044 The method executable may be a script, program, or keyword.
1044 1045 </loctext>
1045 1046 </description>
1046 1047 <cardinality min='1' max='1'/>
1047 1048 <values>
1048 1049 <value name=':true'>
1049 1050 <description>
1050 1051 <loctext xml:lang='C'>
1051 1052 Always returns SMF_EXIT_OK.
1052 1053 </loctext>
1053 1054 </description>
1054 1055 </value>
1055 1056 <value name=':kill [-signal]'>
1056 1057 <description>
1057 1058 <loctext xml:lang='C'>
1058 1059 Sends the specified signal, which is SIGTERM by default, to all processes in the primary instance contract. Always returns SMF_EXIT_OK. This token should be used to replace common kill -HUP invocations.
1059 1060 </loctext>
1060 1061 </description>
1061 1062 </value>
1062 1063 </values>
1063 1064 <choices>
1064 1065 <include_values type='values'/>
1065 1066 </choices>
1066 1067 </prop_pattern>
1067 1068
1068 1069 <prop_pattern name='type' type='astring'
1069 1070 required='true'>
1070 1071 <description>
1071 1072 <loctext xml:lang='C'>
1072 1073 A method may only be of type method.
1073 1074 </loctext>
1074 1075 </description>
1075 1076 <cardinality min='1' max='1'/>
1076 1077 <constraints>
1077 1078 <value name="method"/>
1078 1079 </constraints>
1079 1080 </prop_pattern>
1080 1081
1081 1082 <prop_pattern name='timeout_seconds' type='count'
1082 1083 required='true'>
1083 1084 <description>
1084 1085 <loctext xml:lang='C'>
1085 1086 Number of seconds before the method is considered unresponsive. After the method timeout expires, the method will be killed.
1086 1087 </loctext>
1087 1088 </description>
1088 1089 <cardinality min='1' max='1'/>
1089 1090 <values>
1090 1091 <value name="0">
1091 1092 <common_name>
1092 1093 <loctext xml:lang='C'>
1093 1094 infinite
1094 1095 </loctext>
1095 1096 </common_name>
1096 1097 <description>
1097 1098 <loctext xml:lang='C'>
1098 1099 This method will never time out.
1099 1100 </loctext>
1100 1101 </description>
1101 1102 </value>
1102 1103 <value name="-1">
1103 1104 <common_name>
1104 1105 <loctext xml:lang='C'>
1105 1106 infinite (legacy)
1106 1107 </loctext>
1107 1108 </common_name>
1108 1109 <description>
1109 1110 <loctext xml:lang='C'>
1110 1111 This method will never time out. 0 is the preferred value.
1111 1112 </loctext>
1112 1113 </description>
1113 1114 </value>
1114 1115 </values>
1115 1116 </prop_pattern>
1116 1117
1117 1118 <!-- method_context direct properties -->
1118 1119 <prop_pattern name='working_directory' type='astring'
1119 1120 required='false'>
1120 1121 <description>
1121 1122 <loctext xml:lang='C'>
1122 1123 The working directory to launch the method from. ":default" can be used as a token to indicate the home directory of the user specified by the credential or profile.
1123 1124 </loctext>
1124 1125 </description>
1125 1126 <cardinality min='1' max='1'/>
1126 1127 </prop_pattern>
1127 1128 <prop_pattern name='project' type='astring'
1128 1129 required='false'>
1129 1130 <description>
1130 1131 <loctext xml:lang='C'>
1131 1132 The project ID in numeric or text form. :default can be used as a token to indicate a project identified by getdefaultproj(3PROJECT) for the user whose uid is used to launch the method.
1132 1133 </loctext>
1133 1134 </description>
1134 1135 <cardinality min='1' max='1'/>
1135 1136 </prop_pattern>
1136 1137 <prop_pattern name='resource_pool' type='astring'
1137 1138 required='false'>
1138 1139 <common_name>
1139 1140 <loctext xml:lang='C'>
1140 1141 method context resource pool
1141 1142 </loctext>
1142 1143 </common_name>
1143 1144 <description>
1144 1145 <loctext xml:lang='C'>
1145 1146 The resource pool name on which to launch the method. :default can be used
1146 1147 as a token to indicate the pool specified in the project(4) entry given in
1147 1148 the project attribute.
1148 1149 </loctext>
1149 1150 </description>
1150 1151 <cardinality min='1' max='1'/>
1151 1152 </prop_pattern>
1152 1153
1153 1154 <!-- method_credential properties -->
1154 1155 <prop_pattern name='user' type='astring'
1155 1156 required='false'>
1156 1157 <common_name>
1157 1158 <loctext xml:lang='C'>
1158 1159 method credential user
1159 1160 </loctext>
1160 1161 </common_name>
1161 1162 <description>
1162 1163 <loctext xml:lang='C'>
1163 1164 The user ID in numeric or text form.
1164 1165 </loctext>
1165 1166 </description>
1166 1167 <cardinality min='1' max='1'/>
1167 1168 </prop_pattern>
1168 1169 <prop_pattern name='group' type='astring'
1169 1170 required='false'>
1170 1171 <common_name>
1171 1172 <loctext xml:lang='C'>
1172 1173 method credential group
1173 1174 </loctext>
1174 1175 </common_name>
1175 1176 <description>
1176 1177 <loctext xml:lang='C'>
1177 1178 The group ID in numeric or text form.
1178 1179 </loctext>
1179 1180 </description>
1180 1181 <cardinality min='1' max='1'/>
1181 1182 </prop_pattern>
1182 1183 <prop_pattern name='supp_groups' type='astring'
1183 1184 required='false'>
1184 1185 <common_name>
1185 1186 <loctext xml:lang='C'>
1186 1187 method credential supplemental groups
1187 1188 </loctext>
1188 1189 </common_name>
1189 1190 <description>
1190 1191 <loctext xml:lang='C'>
1191 1192 An optional string that specifies the supplemental group memberships by ID,
1192 1193 in numeric or text form.
1193 1194 </loctext>
1194 1195 </description>
1195 1196 <cardinality min='1' max='1'/>
1196 1197 <internal_separators>,</internal_separators>
1197 1198 </prop_pattern>
1198 1199 <prop_pattern name='privileges' type='astring'
1199 1200 required='false'>
1200 1201 <common_name>
1201 1202 <loctext xml:lang='C'>
1202 1203 method credential privileges
1203 1204 </loctext>
1204 1205 </common_name>
1205 1206 <description>
1206 1207 <loctext xml:lang='C'>
1207 1208 An optional string specifying the privilege set as defined in privileges(5).
1208 1209 </loctext>
1209 1210 </description>
1210 1211 <cardinality min='1' max='1'/>
1211 1212 <internal_separators>,</internal_separators>
1212 1213 </prop_pattern>
1213 1214 <prop_pattern name='limit_privileges' type='astring'
1214 1215 required='false'>
1215 1216 <common_name>
1216 1217 <loctext xml:lang='C'>
1217 1218 method credential limit privilege set
1218 1219 </loctext>
1219 1220 </common_name>
1220 1221 <description>
1221 1222 <loctext xml:lang='C'>
1222 1223 An optional string specifying the limit privilege set as defined in
1223 1224 privileges(5).
1224 1225 </loctext>
1225 1226 </description>
1226 1227 <cardinality min='1' max='1'/>
1227 1228 <internal_separators>,</internal_separators>
1228 1229 </prop_pattern>
1229 1230
1230 1231 <!-- method_profile properties -->
1231 1232 <prop_pattern name='use_profile' type='boolean'
1232 1233 required='false'>
1233 1234 <description>
1234 1235 <loctext xml:lang='C'>
1235 1236 A boolean that specifies whether the profile should be used instead of the
1236 1237 user, group, privileges, and limit_privileges properties.
1237 1238 </loctext>
1238 1239 </description>
1239 1240 <cardinality min='1' max='1'/>
1240 1241 </prop_pattern>
1241 1242 <prop_pattern name='profile' type='astring'
1242 1243 required='false'>
1243 1244 <common_name>
1244 1245 <loctext xml:lang='C'>
1245 1246 method profile RBAC profile specification
1246 1247 </loctext>
1247 1248 </common_name>
1248 1249 <description>
1249 1250 <loctext xml:lang='C'>
1250 1251 The name of an RBAC (role-based access control) profile which, along with the
1251 1252 method executable, identifies an entry in exec_attr(4).
1252 1253 </loctext>
1253 1254 </description>
1254 1255 <cardinality min='1' max='1'/>
1255 1256 </prop_pattern>
1256 1257
1257 1258 <!-- method_environment properties -->
1258 1259 <prop_pattern name='environment' type='astring'
1259 1260 required='false'>
1260 1261 <common_name>
1261 1262 <loctext xml:lang='C'>
1262 1263 method environment variables
1263 1264 </loctext>
1264 1265 </common_name>
1265 1266 <description>
1266 1267 <loctext xml:lang='C'>
1267 1268 Environment variables to insert into the environment of the method, in the
1268 1269 form of a number of NAME=value strings.
1269 1270 </loctext>
1270 1271 </description>
1271 1272 </prop_pattern>
1272 1273 </pg_pattern>
1273 1274
1274 1275 </template>
1275 1276 </service>
1276 1277
1277 1278 </service_bundle>
|
↓ open down ↓ |
873 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX