| blob | 972967267baa1944e87920ab2a5fe4f9d4b5acfe |
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. 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
5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SVCCFG 1M "Jun 29, 2009"
7 .SH NAME
8 svccfg \- import, export, and modify service configurations
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/sbin/svccfg\fR [\fB-v\fR] [\fB-s\fR \fIFMRI\fR]
13 .fi
15 .LP
16 .nf
17 \fB/usr/sbin/svccfg\fR [\fB-v\fR] [\fB-s\fR \fIFMRI\fR] \fIsubcommand\fR [\fBargs\fR]...
18 .fi
20 .LP
21 .nf
22 \fB/usr/sbin/svccfg\fR [\fB-v\fR] [\fB-s\fR \fIFMRI\fR] \fB-f\fR \fIcommand-file\fR
23 .fi
25 .SH DESCRIPTION
26 .sp
27 .LP
28 The \fBsvccfg\fR command manipulates data in the service configuration
29 repository. \fBsvccfg\fR can be invoked interactively, with an individual
30 subcommand, or by specifying a command file that contains a series of
31 subcommands.
32 .sp
33 .LP
34 Changes made to an existing service in the repository typically do not take
35 effect for that service until the next time the service instance is refreshed.
36 See the \fBrefresh\fR subcommand on the \fBsvcadm\fR(1M) man page for more
37 details.
38 .SH OPTIONS
39 .sp
40 .LP
41 The following options are supported:
42 .sp
43 .ne 2
44 .na
45 \fB\fB-f\fR \fIcommand-file\fR\fR
46 .ad
47 .sp .6
48 .RS 4n
49 Reads and executes \fBsvccfg\fR subcommands from \fIcommand-file\fR.
50 .RE
52 .sp
53 .ne 2
54 .na
55 \fB\fB-s\fR \fIFMRI\fR\fR
56 .ad
57 .sp .6
58 .RS 4n
59 Selects the entity indicated by \fIFMRI\fR (a fault management resource
60 identifier) before executing any subcommands. See \fBsmf\fR(5).
61 .RE
63 .sp
64 .ne 2
65 .na
66 \fB\fB-v\fR\fR
67 .ad
68 .sp .6
69 .RS 4n
70 Verbose.
71 .RE
73 .SH SUBCOMMANDS
74 .sp
75 .LP
76 Subcommands are divided into the categories specified in the subsections that
77 follow.
78 .sp
79 .LP
80 All subcommands that accept \fIFMRI\fRs also accept abbreviated or globbed
81 patterns. Instances and services can be abbreviated by specifying the instance
82 name, or the trailing portion of the service name. For example, given the
83 \fIFMRI\fR:
84 .sp
85 .in +2
86 .nf
87 svc:/network/smtp:sendmail
88 .fi
89 .in -2
90 .sp
92 .sp
93 .LP
94 All the following are valid abbreviations:
95 .sp
96 .in +2
97 .nf
98 sendmail
99 :sendmail
100 smtp
101 smtp:sendmail
102 network/smtp
103 .fi
104 .in -2
105 .sp
107 .sp
108 .LP
109 While the following are invalid:
110 .sp
111 .in +2
112 .nf
113 mail
114 network
115 network/smt
116 .fi
117 .in -2
118 .sp
120 .sp
121 .LP
122 Abbreviated forms of \fIFMRI\fRs are unstable, and should not be used in
123 scripts or other permanent tools. If a pattern matches more than one instance
124 or service, an error message is printed and no action is taken.
125 .SS "General Subcommands"
126 .sp
127 .ne 2
128 .na
129 \fB\fBend\fR\fR
130 .ad
131 .br
132 .na
133 \fB\fBexit\fR\fR
134 .ad
135 .br
136 .na
137 \fB\fBquit\fR\fR
138 .ad
139 .sp .6
140 .RS 4n
141 Exits immediately.
142 .RE
144 .sp
145 .ne 2
146 .na
147 \fB\fBrepository\fR \fIrepfile\fR\fR
148 .ad
149 .sp .6
150 .RS 4n
151 Uses \fIrepfile\fR as a repository. By default, \fBsvccfg\fR(1M) uses the
152 system repository.
153 .sp
154 Use repository only with files from the identical version of Solaris, including
155 patches, that you are currently running. Do not use this subcommand with the
156 system repository, \fB/etc/svc/repository.db\fR.
157 .RE
159 .sp
160 .ne 2
161 .na
162 \fB\fBset\fR [\fB-v\fR|\fB-V\fR]\fR
163 .ad
164 .sp .6
165 .RS 4n
166 Sets optional behavior. If no options are specified, set displays the options
167 currently in effect.
168 .sp
169 .ne 2
170 .na
171 \fB\fB-v\fR\fR
172 .ad
173 .sp .6
174 .RS 4n
175 Turns on verbose mode.
176 .RE
178 .sp
179 .ne 2
180 .na
181 \fB\fB-V\fR\fR
182 .ad
183 .sp .6
184 .RS 4n
185 Turns off verbose mode.
186 .RE
188 .RE
190 .SS "Service Profile Subcommands"
191 .sp
192 .ne 2
193 .na
194 \fB\fBapply\fR [\fB-n\fR] \fIfile\fR\fR
195 .ad
196 .sp .6
197 .RS 4n
198 If a \fIfile\fR is a service profile, properties, including general/enabled,
199 that are specified in the file are modified in the SMF repository.
200 Not-yet-existent properties and property groups will be created. The type of
201 the pre-existing property \fBgroups\fR will not be changed by the profile.
202 Existing properties (as distinguished from property groups) \fBcan\fR have
203 their type changed by the profile. Nonexistent services and instances are
204 ignored. Services and instances modified by the profile will be refreshed. If
205 \fB-n\fR is specified, the profile is processed and no changes are applied to
206 the SMF repository. Any syntax error found will be reported on stderr and an
207 exit code of \fB1\fR will be returned. See \fBsmf\fR(5) for a description of
208 service profiles. This command requires privileges to modify properties in the
209 service and instance. See \fBsmf_security\fR(5) for the privileges required to
210 modify properties. If \fIfile\fR is not a service profile, the subcommand
211 fails.
212 .RE
214 .sp
215 .ne 2
216 .na
217 \fB\fBextract\fR [\fI> file\fR]\fR
218 .ad
219 .sp .6
220 .RS 4n
221 Prints a service profile which represents the enabled status of the service
222 instances in the repository to standard output. The output may be redirected to
223 a file.
224 .RE
226 .SS "Service Manifest Subcommands"
227 .sp
228 .ne 2
229 .na
230 \fB\fBarchive\fR [\fB-a\fR]\fR
231 .ad
232 .sp .6
233 .RS 4n
234 Dumps a full \fBXML\fR service description for all services, instances, and
235 their persistent properties in the repository. This does not include transient
236 properties such as service state, and is suitable for a relocatable repository
237 backup.
238 .sp
239 Without the \fB-a\fR option, property groups containing protected information
240 (identified by the presence of the \fBread_authorization\fR property\(emsee
241 \fBsmf_security\fR(5)) will be archived without their property values. When the
242 \fB-a\fR option is specified, all values will be archived. An error results if
243 there are insufficient privileges to read these values.
244 .RE
246 .sp
247 .ne 2
248 .na
249 \fB\fBexport\fR [\fB-a\fR] \fIservice_FMRI\fR [\fI>file\fR]\fR
250 .ad
251 .sp .6
252 .RS 4n
253 The service description for the specified service and its instances is written
254 to standard output or redirected to the given file. Dependencies with a boolean
255 "external" property set to true are omitted in the belief that they were
256 created on behalf of another service.
257 .sp
258 Without the \fB-a\fR option, property groups containing protected information
259 (identified by the presence of the \fBread_authorization\fR property\(emsee
260 \fBsmf_security\fR(5)) will be exported without their property values. When the
261 \fB-a\fR option is specified, all values will be archived. An error results if
262 there are insufficient privileges to read these values.
263 .sp
264 Note that \fBexport\fR requires a service FMRI. If you specify an instance
265 (including an abbreviation, such as \fBapache2\fR or \fBsendmail\fR, that
266 specifies an instance), the command fails.
267 .RE
269 .sp
270 .ne 2
271 .na
272 \fB\fBimport\fR [\fB-V\fR] \fIfile\fR\fR
273 .ad
274 .sp .6
275 .RS 4n
276 If \fIfile\fR is a service manifest, then the services and instances it
277 specifies are imported into the repository. According to the file, dependencies
278 may be created in other services. See \fBsmf\fR(5) for a description of service
279 manifests. See \fBsmf_security\fR(5) for the privileges required to create and
280 modify service configurations.
281 .sp
282 Services and instances in the manifest will be validated against template data
283 in the manifest and the repository, and warnings will be issued for all
284 template violations. See \fBsmf_template\fR(5) for a description of templates.
285 If the \fB-V\fR option is specified, manifests that violate the defined
286 templates will fail to import. In interactive invocations of \fBsvccfg\fR,
287 \fB-V\fR is the default behavior.
288 .sp
289 For existing services and instances, properties which have not changed since
290 the last \fBimport\fR snapshot was taken are upgraded to those specified by the
291 manifest. Conflicts (properties which have been changed both in the repository
292 and the manifest) are reported on the standard error stream. \fBsvccfg\fR will
293 never upgrade the "general/enabled" and "general/restarter" properties, since
294 they represent administrator preference.
295 .RE
297 .sp
298 .ne 2
299 .na
300 \fB\fBinventory\fR \fIfile\fR\fR
301 .ad
302 .sp .6
303 .RS 4n
304 If \fIfile\fR is determined to be a service manifest, then the \fBFMRI\fRs of
305 the services and instances the \fIfile\fR describes are printed. For each
306 service, the \fBFMRI\fRs of its instances are displayed before the \fBFMRI\fR
307 of the service.
308 .RE
310 .sp
311 .ne 2
312 .na
313 \fB\fBrestore\fR\fR
314 .ad
315 .sp .6
316 .RS 4n
317 Restores the contents of the repository from a full XML service description
318 previously created by the \fBarchive\fR subcommand. If the archive was
319 generated without the use of the \fB-a\fR option, the contents of the
320 repository following completion of the restore will not include the values of
321 any read-protected properties (see \fBsmf_security\fR(5)). If these are
322 required, they must be restored manually.
323 .sp
324 Restoring an archive which is inconsistent with currently installed software
325 (including patch revisions) might yield unpredictable results. Therefore, prior
326 to restoring an archive, all system and application software, including any
327 service manifests, should be restored to the same state it was in at the time
328 the archive was made.
329 .RE
331 .sp
332 .ne 2
333 .na
334 \fB\fBvalidate\fR [\fIfile\fR | \fIfmri\fR]\fR
335 .ad
336 .sp .6
337 .RS 4n
338 The \fBvalidate\fR subcommand can operate on a manifest file, an instance FMRI,
339 or the current instance or snapshot entity selection. When an argument is
340 specified, \fBsvccfg\fR will check to see whether the specified file exists. If
341 the file exists, it will be validated. If a file of the specified name does not
342 exist, the argument is treated as an FMRI pattern. If a conflict arises between
343 a filename and an FMRI, use the \fBsvc:\fR and \fBfile:\fR prefixes to tell
344 \fBsvccfg\fR how to interpret the argument.
345 .sp
346 When you specify a file, the file is processed in a manner similar to
347 \fBimport\fR \fB-V\fR, but no changes are made to the repository. If any errors
348 are detected, \fBsvccfg\fR displays the errors and exits with a nonzero exit
349 status.
350 .sp
351 For an instance \fIfmri\fR, instance entity selection, or snapshot entity
352 selection, the specified instance in its composed form (see "Properties and
353 Property Groups" in \fBsmf\fR(5)) will be validated against template data in
354 the repository. Instance FMRIs and instance entity selections use the "running"
355 snapshot for validation. Warnings will be issued for all template violations.
356 See \fBsmf_template\fR(5) for a description of templates.
357 .RE
359 .SS "Entity Selection, Modification, and Navigation Subcommands"
360 .sp
361 .LP
362 An "entity" refers to a scope, service, or service instance.
363 .sp
364 .ne 2
365 .na
366 \fB\fBadd\fR \fIname\fR\fR
367 .ad
368 .sp .6
369 .RS 4n
370 A new entity with the given name is created as a child of the current
371 selection. See \fBsmf_security\fR(5) for the privileges required to create
372 entities.
373 .RE
375 .sp
376 .ne 2
377 .na
378 \fB\fBdelete\fR [\fB-f\fR] \fB{\fIname\fR | \fIfmri\fR}\fR\fR
379 .ad
380 .sp .6
381 .RS 4n
382 The named child of the current selection or the entity specified by \fIfmri\fR
383 is deleted. Attempts to delete service instances in the "online" or "degraded"
384 state will fail unless the \fB-f\fR flag is specified. If a service or service
385 instance has a "dependents" property group of type "framework", then for each
386 of its properties with type "astring" or "fmri", if the property has a single
387 value which names a service or service instance then the dependency property
388 group in the indicated service or service instance with the same name as the
389 property will be deleted. See \fBsmf_security\fR(5) for the privileges required
390 to delete service configurations.
391 .RE
393 .sp
394 .ne 2
395 .na
396 \fB\fBlist\fR [\fIpattern\fR]\fR
397 .ad
398 .sp .6
399 .RS 4n
400 The child entities of the current selection whose names match the glob pattern
401 \fIpattern\fR are displayed (see \fBfnmatch\fR(5)). \&':properties' is also
402 listed for property-bearing entities, namely services and service instances.
403 .RE
405 .sp
406 .ne 2
407 .na
408 \fB\fBselect\fR {\fIname\fR | \fIfmri\fR}\fR
409 .ad
410 .sp .6
411 .RS 4n
412 If the argument names a child of the current selection, it becomes the current
413 selection. Otherwise, the argument is interpreted as an \fBFMRI\fR and the
414 entity that the argument specifies becomes the current selection.
415 .RE
417 .sp
418 .ne 2
419 .na
420 \fB\fBunselect\fR\fR
421 .ad
422 .sp .6
423 .RS 4n
424 The parent of the current selection becomes the current selection.
425 .RE
427 .SS "Property Inspection and Modification Subcommands"
428 .sp
429 .ne 2
430 .na
431 \fB\fBaddpg\fR \fIname\fR \fItype\fR [\fIflags\fR]\fR
432 .ad
433 .sp .6
434 .RS 4n
435 Adds a property group with the given \fIname\fR and type to the current
436 selection. \fIflags\fR is a string of characters which designates the flags
437 with which to create the property group. 'P' represents
438 \fBSCF_PG_FLAG_NONPERSISTENT\fR (see \fBscf_service_add_pg\fR(3SCF)). See
439 \fBsmf_security\fR(5) for the privileges required to create property groups.
440 .RE
442 .sp
443 .ne 2
444 .na
445 \fB\fBaddpropvalue\fR \fIpg\fR\fI/name\fR [\fItype:\fR] \fIvalue\fR\fR
446 .ad
447 .sp .6
448 .RS 4n
449 Adds the given value to a property. If \fItype\fR is given and the property
450 exists, then if \fItype\fR does not agree with the property's \fItype\fR, the
451 subcommand fails. The values may be enclosed in double-quotes. String values
452 containing double-quotes or backslashes must be enclosed by double-quotes and
453 the contained double-quotes and backslashes must be quoted by backslashes.
454 Nonexistent properties are created, in which case the \fItype\fR specifier must
455 be present. See \fBscf_value_create\fR(3SCF) for a list of available property
456 types. See \fBsmf_security\fR(5) for the privileges required to modify
457 properties. The new value will be appended to the end of the list of property
458 values associated with the property.
459 .RE
461 .sp
462 .ne 2
463 .na
464 \fB\fBdelpg\fR \fIname\fR\fR
465 .ad
466 .sp .6
467 .RS 4n
468 Deletes the property group \fIname\fR of the current selection. See
469 \fBsmf_security\fR(5) for the privileges required to delete property groups.
470 .RE
472 .sp
473 .ne 2
474 .na
475 \fB\fBdelprop\fR \fIpg\fR[\fI/name\fR]\fR
476 .ad
477 .sp .6
478 .RS 4n
479 Deletes the named property group or property of the current selection. See
480 \fBsmf_security\fR(5) for the privileges required to delete properties.
481 .RE
483 .sp
484 .ne 2
485 .na
486 \fB\fBdelpropvalue\fR \fIpg/name\fR \fIglobpattern\fR\fR
487 .ad
488 .sp .6
489 .RS 4n
490 Deletes all values matching the given \fIglob\fR pattern in the named property.
491 Succeeds even if no values match. See \fBsmf_security\fR(5) for the privileges
492 required to modify properties.
493 .RE
495 .sp
496 .ne 2
497 .na
498 \fB\fBdescribe\fR [\fB-v\fR] [\fB-t\fR] [\fIpropertygroup\fR/\fIproperty\fR]\fR
499 .ad
500 .sp .6
501 .RS 4n
502 Describes either the current or the possible settings.
503 .sp
504 When invoked without arguments, \fBdescribe\fR gives basic descriptions (if
505 available) of the currently selected entity and all of its currently set
506 property groups and properties. A property group or specific property can be
507 queried by specifying either the property group name, or the property group
508 name and property name, separated by a slash (\fB/\fR), as an argument.
509 .sp
510 The \fB-v\fR option gives all information available, including descriptions for
511 current settings, constraints, and other possible setting choices.
512 .sp
513 The \fB-t\fR option shows only the template data for the selection (see
514 \fBsmf_template\fR(5)), and does not display the current settings for property
515 groups and properties.
516 .RE
518 .sp
519 .ne 2
520 .na
521 \fB\fBeditprop\fR\fR
522 .ad
523 .sp .6
524 .RS 4n
525 Comments of commands to reproduce the property groups and properties of the
526 current selection are placed in a temporary file and the program named by the
527 \fBEDITOR\fR environment variable is invoked to edit it. Upon completion, the
528 commands in the temporary file are executed. The default editor is \fBvi\fR(1).
529 See \fBsmf_security\fR(5) for the privileges required to create, modify, or
530 delete properties.
531 .RE
533 .sp
534 .ne 2
535 .na
536 \fB\fBlistpg\fR [\fIpattern\fR]\fR
537 .ad
538 .sp .6
539 .RS 4n
540 Displays the names, types, and flags of property groups of the current
541 selection. If an argument is given, it is taken as a glob pattern and only
542 property groups with names which match the argument are listed.
543 .sp
544 In interactive mode, a basic description of the property groups is also given.
545 .RE
547 .sp
548 .ne 2
549 .na
550 \fB\fBlistprop\fR [\fIpattern\fR]\fR
551 .ad
552 .sp .6
553 .RS 4n
554 Lists property groups and properties of the current selection. For property
555 groups, names, types, and flags are listed. For properties, names (prepended by
556 the property group name and a slash (/)), types, and values are listed. See
557 \fBscf_value_create\fR(3SCF) for a list of available property types. If an
558 argument is supplied it is taken as a glob pattern and only property groups and
559 properties with names which match the argument are listed.
560 .RE
562 .sp
563 .ne 2
564 .na
565 \fB\fBsetenv\fR [\fB-i\fR | \fB-s\fR] [\fB-m\fR \fImethod_name\fR] \fIenvvar
566 value\fR\fR
567 .ad
568 .sp .6
569 .RS 4n
570 Sets a method environment variable for a service or instance by changing the
571 "environment" property in the \fImethod_name\fR property group, if that
572 property group has type "method". If \fImethod_name\fR is not specified and the
573 \fB-i\fR option is used, the "method_context" property group is used, if an
574 instance is currently selected. If the \fB-s\fR option is used and a service is
575 currently selected, its "method_context" property group is used. If the
576 \fB-s\fR option is used and an instance is currently selected, the
577 "method_context" property group of its parent is used. If neither the \fB-i\fR
578 option nor the \fB-s\fR option is used, the "start" property group is searched
579 for in the currently selected entity and, if an instance is currently selected,
580 its parent is also searched. If the "inetd_start" property group is not
581 located, it is searched for in a similiar manner.
582 .sp
583 Once the property is located, all values which begin with \fIenvvar\fR followed
584 by a "=" are removed, and the value "\fIenvvar\fR=\fIvalue\fR" is added. See
585 \fBsmf_security\fR(5) for the privileges required to modify properties.
586 .RE
588 .sp
589 .ne 2
590 .na
591 \fB\fBsetprop\fR \fIpg/name\fR = [\fItype:\fR] \fIvalue\fR\fR
592 .ad
593 .br
594 .na
595 \fBsetprop \fIpg/name\fR = [\fItype:\fR] ([\fIvalues ...\fR])\fR
596 .ad
597 .sp .6
598 .RS 4n
599 Sets the \fIname\fR property of the \fIpg\fR property group of the current
600 selection to the given values of type \fItype\fR. See
601 \fBscf_value_create\fR(3SCF) for a list of available property types. If the
602 property already exists and the \fItype\fR disagrees with the existing
603 \fItype\fR on the property, the subcommand fails. Values may be enclosed in
604 double-quotes. String values which contain double-quotes or backslashes must be
605 enclosed by double-quotes and the contained double-quotes and backslashes must
606 be quoted by backslashes. If the named property does not exist, it is created,
607 as long as the type is specified. See \fBsmf_security\fR(5) for the privileges
608 required to create or modify properties. Multiple values will be stored in the
609 order in which they are specified.
610 .RE
612 .sp
613 .ne 2
614 .na
615 \fB\fBunsetenv\fR [\fB-i\fR | \fB-s\fR] [\fB-m\fR \fImethod_name\fR] \fIenvvar
616 value\fR\fR
617 .ad
618 .sp .6
619 .RS 4n
620 Removes a method environment variable for a service or instance by changing the
621 "environment" property in the \fImethod_name\fR property group, if that
622 property group has type "method". If \fImethod_name\fR is not specified and the
623 \fB-i\fR option is used, the "method_context" property group is used, if an
624 instance is currently selected. If the \fB-s\fR option is used and a service is
625 currently selected, its "method_context" property group is used. If the
626 \fB-s\fR option is used and an instance is currently selected, the
627 "method_context" property group of its parent is used. If neither the \fB-i\fR
628 option nor the \fB-s\fR option is used, the "start" property group is searched
629 for in the currently selected entity and, if an instance is currently selected,
630 its parent is also searched. If the "inetd_start" property group is not
631 located, it is searched for in a similiar manner.
632 .sp
633 Once the property is located, all values which begin with \fIenvvar\fR followed
634 by "=" are removed. See \fBsmf_security\fR(5) for the privileges required to
635 modify properties.
636 .RE
638 .SS "Snapshot Navigation and Selection Subcommands"
639 .sp
640 .ne 2
641 .na
642 \fB\fBlistsnap\fR\fR
643 .ad
644 .sp .6
645 .RS 4n
646 Displays snapshots available for the currently selected instance.
647 .RE
649 .sp
650 .ne 2
651 .na
652 \fB\fBrevert\fR [\fIsnapshot\fR]\fR
653 .ad
654 .sp .6
655 .RS 4n
656 Reverts the properties of the currently selected instance and its service to
657 those recorded in the named snapshot. If no argument is given, use the
658 currently selected snapshot and deselect it on success. The changed property
659 values can be made active via the \fBrefresh\fR subcommand of \fBsvcadm\fR(1M).
660 See \fBsmf_security\fR(5) for the privileges required to change properties.
661 .RE
663 .sp
664 .ne 2
665 .na
666 \fB\fBselectsnap\fR [\fIname\fR]\fR
667 .ad
668 .sp .6
669 .RS 4n
670 Changes the current snapshot to the one named by \fIname\fR. If no \fIname\fR
671 is specified, deselect the currently selected snapshot. Snapshots are
672 read-only.
673 .RE
675 .SS "Instance Subcommands"
676 .sp
677 .ne 2
678 .na
679 \fB\fBrefresh\fR\fR
680 .ad
681 .sp .6
682 .RS 4n
683 Commit the values from the current configuration to the running snapshot,
684 making them available for use by the currently selected instance. If the
685 repository subcommand has not been used to select a repository, direct the
686 instance's restarter to reread the updated configuration.
687 .RE
689 .SH EXAMPLES
690 .LP
691 \fBExample 1 \fRImporting a Service Description
692 .sp
693 .LP
694 The following example imports a service description for the \fBseismic\fR
695 service in the XML manifest specified on the command line.
697 .sp
698 .in +2
699 .nf
700 # \fBsvccfg import /var/svc/manifest/site/seismic.xml\fR
701 .fi
702 .in -2
703 .sp
705 .sp
706 .LP
707 Note that the manifest must follow the format specified in
708 \fBservice_bundle\fR(4).
710 .LP
711 \fBExample 2 \fRExporting a Service Description
712 .sp
713 .LP
714 To export a service description on the local system:
716 .sp
717 .in +2
718 .nf
719 # \fBsvccfg export dumpadm >/tmp/dump.xml\fR
720 .fi
721 .in -2
722 .sp
724 .LP
725 \fBExample 3 \fRDeleting a Service Instance
726 .sp
727 .LP
728 To delete a service instance:
730 .sp
731 .in +2
732 .nf
733 # \fBsvccfg delete network/inetd-upgrade:default\fR
734 .fi
735 .in -2
736 .sp
738 .LP
739 \fBExample 4 \fRChecking Properties in an Alternate Repository
740 .sp
741 .LP
742 To examine the state of a service's properties after loading an alternate
743 repository, use the sequence of commands shown below. One might use such
744 commands, for example, to determine whether a service was enabled in a
745 particular repository backup.
747 .sp
748 .in +2
749 .nf
750 # \fBsvccfg\fR
751 svc:> \fBrepository /etc/svc/repository-boot\fR
752 svc:> \fBselect telnet:default\fR
753 svc:/network/telnet:default> \fBlistprop general/enabled\fR
754 general/enabled boolean false
755 svc:/network/telnet:default> \fBexit\fR
756 .fi
757 .in -2
758 .sp
760 .LP
761 \fBExample 5 \fREnabling Debugging
762 .sp
763 .LP
764 To modify \fBLD_PRELOAD\fR for a start method and enable the use of
765 \fBlibumem\fR(3LIB) with debugging features active:
767 .sp
768 .in +2
769 .nf
770 $ \fBsvccfg -s system/service setenv LD_PRELOAD libumem.so\fR
771 $ \fBsvccfg -s system/service setenv UMEM_DEBUG default\fR
772 .fi
773 .in -2
774 .sp
776 .LP
777 \fBExample 6 \fRUsing \fBdescribe\fR Subcommand
778 .sp
779 .LP
780 The following command illustrates the use of the \fBdescribe\fR subcommand.
782 .sp
783 .in +2
784 .nf
785 # \fBsvccfg -s console-login describe ttymon\fR
786 ttymon application
787 ttymon/device astring /dev/console
788 \fBterminal device to be used for the console login prompt\fR
789 ttymon/label astring console
790 \fBappropriate entry from /etc/ttydefs\fR
791 ...
792 .fi
793 .in -2
794 .sp
796 .SH ENVIRONMENTAL VARIABLES
797 .sp
798 .ne 2
799 .na
800 \fBEDITOR\fR
801 .ad
802 .sp .6
803 .RS 4n
804 The command to run when the \fBeditprop\fR subcommand is used. The default
805 editor is \fBvi\fR(1).
806 .RE
808 .SH EXIT STATUS
809 .sp
810 .LP
811 The following exit values are returned:
812 .sp
813 .ne 2
814 .na
815 \fB\fB0\fR\fR
816 .ad
817 .sp .6
818 .RS 4n
819 Successful execution.
820 .RE
822 .sp
823 .ne 2
824 .na
825 \fB\fB1\fR\fR
826 .ad
827 .sp .6
828 .RS 4n
829 One or more subcommands resulted in failure. Error messages are written to the
830 standard error stream.
831 .RE
833 .sp
834 .ne 2
835 .na
836 \fB\fB2\fR\fR
837 .ad
838 .sp .6
839 .RS 4n
840 Invalid command line options were specified.
841 .RE
843 .SH ATTRIBUTES
844 .sp
845 .LP
846 See \fBattributes\fR(5) for descriptions of the following attributes:
847 .sp
849 .sp
850 .TS
851 box;
852 c | c
853 l | l .
854 ATTRIBUTE TYPE ATTRIBUTE VALUE
855 _
856 Interface Stability See below.
857 .TE
859 .sp
860 .LP
861 The interactive output is Uncommitted. The invocation and non-interactive
862 output are Committed.
863 .SH SEE ALSO
864 .sp
865 .LP
866 \fBsvcprop\fR(1), \fBsvcs\fR(1), \fBsvcadm\fR(1M), \fBsvc.configd\fR(1M),
867 \fBlibscf\fR(3LIB), \fBlibumem\fR(3LIB), \fBscf_service_add_pg\fR(3SCF),
868 \fBscf_value_create\fR(3SCF), \fBcontract\fR(4), \fBservice_bundle\fR(4),
869 \fBattributes\fR(5), \fBfnmatch\fR(5), \fBsmf\fR(5), \fBsmf_method\fR(5),
870 \fBsmf_security\fR(5), \fBsmf_template\fR(5)