usr/src/man/man1m/svccfg.1m

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