svccfg

- import, export, and modify service configurations

Synopsis

/usr/sbin/svccfg [-v] [-sFMRI]

/usr/sbin/svccfg [-v] [-sFMRI] subcommand [args]...

/usr/sbin/svccfg [-v] [-sFMRI] -fcommand-file

Description

The svccfg command manipulates data in the service configuration repository. svccfg can
be invoked interactively, with an individual subcommand, or by specifying a command
file that contains a series of subcommands.

Changes made to an existing service in the repository typically do not
take effect for that service until the next time the service instance
is refreshed. See the refresh subcommand, below, or the refresh subcommand in
the svcadm(1M) man page for more details.

Options

The following options are supported:

-fcommand-file

Reads and executes svccfg subcommands from command-file.

-sFMRI

Selects the entity indicated by FMRI (a fault management resource identifier) before executing any subcommands. If -fcommand-file is not provided and no subcommands are specified on the command line, then masked entities will be treated as nonexistent. See smf(5).

-v

Verbose.

SUBCOMMANDS

Subcommands are divided into the categories specified in the subsections that follow.

All subcommands that accept FMRIs also accept abbreviated or globbed patterns. Instances
and services can be abbreviated by specifying the instance name, or the
trailing portion of the service name. For example, given the FMRI:

svc:/network/smtp:sendmail

All the following are valid abbreviations:

sendmail
:sendmail
smtp
smtp:sendmail
network/smtp

While the following are invalid:

mail
network
network/smt

Abbreviated forms of FMRIs are unstable, and should not be used in
scripts or other permanent tools. If a pattern matches more than one
instance or service, an error message is printed and no action is
taken.

General Subcommands

end

exit

quit

Exits immediately.

repository [-pprefix] repfile

Uses repfile as a repository. By default, svccfg(1M) uses the system repository.

Use repository only with files from the identical version of Solaris, including patches, that you are currently running. Do not use this subcommand with the system repository, /etc/svc/repository.db.

If you use svccfg repository to pre-populate the SMF repository before deployment time, use -p option to specify the root prefix for the system standard location for manifests imported with import. This prefix will be replaced by /lib/svc/manifest and /var/svc/manifest once the repository is on a live system. If manifests from your -p directory do not appear in a system standard location at runtime, the services associated with them will be removed.

set [-v|-V]

Sets optional behavior. If no options are specified, set displays the options currently in effect.

-v

Turns on verbose mode.

-V

Turns off verbose mode.

Service Manifest and Profile Subcommands

apply [-n] [-v] file | directory

If the argument is a service profile or manifest, apply the configuration to the admin layer of the SMF repository. Services, instances, property groups, and properties will be created as necessary.

If the type attribute of a property or property group is unspecified, an attempt will be made to determine the type from existing type settings or from the service template. If a type cannot be determined, a warning will be presented and the service will be skipped so inconsistent data will not be introduced into a service and instance. Nonexistent services and instances are ignored.

To use the relaxed element definitions in a profile, the following definitions need to be added to the DOCTYPE entry:

<!ENTITY % profile "INCLUDE">
<!ENTITY % manifest "IGNORE">

Services and instances modified by the profile will be refreshed. If -n is specified, the profile is processed and no changes are applied to the SMF repository. Any syntax error found will be reported on stderr and an exit code of 1 will be returned. See smf(5) for a description of service profiles. This command requires privileges to modify properties in the service and instance. See smf_security(5) for the privileges required to modify properties.

Services and instances in the manifest or profile will be validated against template data in the manifest and the repository, and warnings will be issued for all template violations. See smf_template(5) for a description of templates. If the -V option is specified, manifests that violate the defined templates will fail to import. In interactive invocations of svccfg, -V is the default behavior.

If the argument to apply is a directory, all profiles found under that directory tree will get applied as described above. The subcommand fails if a specified file or any file found under a specified directory is not a service profile.

extract [-a] [-llayer] [fmri] [> file]

Displays a service profile for the specified FMRI or the whole system if an FMRI is not specified.

If -l is supplied, a list of layers can be selected from which to extract values. The -l option requires a layer name and takes the arguments: manifest, system-profile, site-profile, admin, current, all. current and all are synonyms, and select the highest-layer values. Multiple layers can be comma-separated or specified with multiple -l options.

If -l is not supplied, the default is -ladmin,site-profile.

If a property is defined in multiple selected layers, only the highest layer is exported in the profile.

Without the -a option, property groups containing protected information (identified by the presence of the read_authorization property—see smf_security(5)) will be extracted without their property values. When the -a option is specified, all values will be extracted. An error results if there are insufficient privileges to read these values.

If an FMRI is given and that FMRI is a service, the profile will contain customizations only for that service and the instances of the service. If the provided FMRI is an instance, the profile will contain customizations for the service and the instance provided.

export [-a] service_FMRI [>file]

Running svccfg export is equivalent to:

svccfg extract -l current [-a] service_FMRI [>file]

import [-V] [file | directory]

svccfg import on a file in a system-managed filesystem location (subdirectories of /lib/svc/manifest and /var/svc/manifest) invokes: svcadm restart manifest-import.

Placing your manifests in a system-managed location and invoking svcadm restart manifest-import to import them is the recommended practice.

svccfg import on files in other locations imports their properties as administrative customization into the admin layer. It is equivalent to:

svccfg apply [file | directory]

inventoryfile

If file is determined to be a service manifest or profile, then the FMRIs of the services and instances the file describes are printed. For each service, the FMRIs of its instances are displayed before the FMRI of the service.

validate [file | fmri]

The validate subcommand can operate on a manifest file, an instance FMRI, or the current instance or snapshot entity selection. When an argument is specified, svccfg will check to see whether the specified file exists. If the file exists, it will be validated. If a file of the specified name does not exist, the argument is treated as an FMRI pattern. If a conflict arises between a filename and an FMRI, use the svc: and file: prefixes to tell svccfg how to interpret the argument.

When you specify a file, the file is processed in a manner similar to import-V, but no changes are made to the repository. If any errors are detected, svccfg displays the errors and exits with a nonzero exit status.

For an instance fmri, instance entity selection, or snapshot entity selection, the specified instance in its composed form (see “Properties and Property Groups” in smf(5)) will be validated against template data in the repository. Instance FMRIs and instance entity selections use the “running” snapshot for validation. Warnings will be issued for all template violations. See smf_template(5) for a description of templates.

Entity Selection, Modification, and Navigation Subcommands

An “entity” refers to a scope, service, or service instance.

addname

A new entity with the given name is created as a child of the current selection. See smf_security(5) for the privileges required to create entities.

delete [-f] {name | fmri}

The named child of the current selection or the entity specified by fmri is deleted. Attempts to delete service instances in the “online” or “degraded” state will fail unless the -f flag is specified. If a service or service instance has a “dependents” property group of type “framework”, then for each of its properties with type “astring” or “fmri”, if the property has a single value which names a service or service instance then the dependency property group in the indicated service or service instance with the same name as the property will be deleted. See smf_security(5) for the privileges required to delete service configurations.

Invoking the delete subcommand with an FMRI that identifies a service with a manifest in a standard location only masks, and does not delete, that service's definition. To delete a service, you must delete its manifest, then restart the manifest-import service with the following command:

# svcadm restart manifest-import

Note that reimporting a manifest does not remove a mask.

Use the liscust subcommand with the -M option to list masked services. See EXAMPLES for an example of unmasking a service.

See smf(5) for a description of the Oracle Solaris service management facility.

list [pattern]

The child entities of the current selection whose names match the glob pattern pattern are displayed (see fnmatch(5)). ':properties' is also listed for property-bearing entities, namely services and service instances.

refresh

Commit the values from the current configuration to the running snapshot, making them available for use by the currently selected instance. If the repository subcommand has not been used to select a repository, direct the instance's restarter to reread the updated configuration. If the selection is a service, all instances of the service will be refreshed.

select {name | fmri}

If the argument names a child of the current selection, it becomes the current selection. Otherwise, the argument is interpreted as an FMRI and the entity that the argument specifies becomes the current selection.

unselect

The parent of the current selection becomes the current selection.

Property Inspection and Modification Subcommands

addpgnametype [flags]

Adds a property group with the given name and type to the current selection. flags is a string of characters which designates the flags with which to create the property group. 'P' represents SCF_PG_FLAG_NONPERSISTENT (see scf_service_add_pg(3SCF)). See smf_security(5) for the privileges required to create property groups.

addpropvaluepg/name [type:] value

Adds the given value to a property. If type is given and the property exists, then if type does not agree with the property's type, the subcommand fails. If the pg does not exist, addpropvalue will create one if it can find the pg type and flags in the template definitions. If the selection is an instance, addpropvalue will look for the pg type and flags in the service before looking up the template definitions. If no pg type and flags are found, the subcommand will fail. The values may be enclosed in double-quotes. String values containing double-quotes or backslashes must be enclosed by double-quotes and the contained double-quotes and backslashes must be quoted by backslashes. Nonexistent properties are created, in which case the type specifier must be present. See scf_value_create(3SCF) for a list of available property types. See smf_security(5) for the privileges required to modify properties. The new value will be appended to the end of the list of property values associated with the property.

delcust [-M] [pattern]

Delete any administrative customizations for the current selection. If an argument is supplied, it is taken as a glob pattern and only property groups and properties with names that match the argument are deleted.

If there is no current selection, no changes are made and the subcommand fails.

If -M is supplied, delete only masked entities.

To see what customizations delcust would remove, use listcust with the same options. As delcust can potentially remove all administrative customizations on the current selection, always run listcust first to determine you are removing what you intend to.

delpgname

Deletes the property group name of the current selection. See smf_security(5) for the privileges required to delete property groups.

If the property group is backed by a manifest or profile, it is masked. See smf(5).

delproppg[/name]

Deletes the named property group or property of the current selection. See smf_security(5) for the privileges required to delete properties.

delpropvaluepg/nameglobpattern

Deletes all values matching the given glob pattern in the named property. Succeeds even if no values match. See smf_security(5) for the privileges required to modify properties.

describe [-v] [-t] [propertygroup/property]

Describes either the current or the possible settings.

When invoked without arguments, describe gives basic descriptions (if available) of the currently selected entity and all of its currently set property groups and properties. A property group or specific property can be queried by specifying either the property group name, or the property group name and property name, separated by a slash (/), as an argument.

The -v option gives all information available, including descriptions for current settings, constraints, and other possible setting choices.

The -t option shows only the template data for the selection (see smf_template(5)), and does not display the current settings for property groups and properties.

editprop [-a]

Comments of commands to reproduce the property groups and properties of the current selection are placed in a temporary file and the program named by the VISUAL environment variable is invoked to edit it. If VISUAL is not defined, EDITOR is used instead. If both environment variables are not defined, then the default editor vi(1) is used. Upon completion, the commands in the temporary file are executed. See smf_security(5) for the privileges required to create, modify, or delete properties.

By default editprop will not display SMF infrastructure property groups such as framework, dependency, templates, firewall, and notification parameters or properties templated with visibility hidden. If an instance is selected, the composed view of the properties are placed in the temporary file. The -a option will place all properties in the temporary file, including properties in SMF infrastructure property groups and those templated with visibility hidden.

listpg [pattern]

Displays the names, types, and flags of property groups of the current selection. If an argument is given, it is taken as a glob pattern and only property groups with names which match the argument are listed.

In interactive mode, a basic description of the property groups is also given.

listprop [-llayer...] [-f | -oformat] [pattern]

Lists property groups and properties of the current selection. For property groups, names, types, and flags are listed. For properties, names (prepended by the property group name and a slash (/)), types, and values are listed. See scf_value_create(3SCF) for a list of available property types. If an argument is supplied it is taken as a glob pattern and only property groups and properties with names which match the argument are listed.

With the -l option, print the layer the value came from. The -l option requires a layer, and takes the arguments: manifest, system-profile, site-profile, admin, current, all. current prints the same property values as listprop without -l, along with the layer that value was defined in.

The -f and -o options are mutually exclusive. -f prints the file, if any, a property came from. -o allows field selection. Selectable fields include:

propname

the property name

pgname

the property group name

instname

the instance name

servicename

the service name

layer

the layer

proptype

the property type

value

the property value

file

the source file

masked

whether the property group or property is currently masked

time

the time this property last changed

listcust [-L] [-M] [pattern]

Print all admin layer customizations and masked entities for the current selection. If an argument is supplied, it is taken as a glob pattern and only property groups and properties with names that match the argument are listed.

If there is no current selection, list all customizations for all services.

If -M is supplied, print only masked entities.

If -L is supplied, show all local customizations, including those in the site profile layer in addition to those in the admin layer.

setenv [-i | -s] [-mmethod_name] envvar value

Sets a method environment variable for a service or instance by changing the “environment” property in the method_name property group, if that property group has type “method”. If method_name is not specified and the -i option is used, the “method_context” property group is used, if an instance is currently selected. If the -s option is used and a service is currently selected, its “method_context” property group is used. If the -s option is used and an instance is currently selected, the “method_context” property group of its parent is used. If neither the -i option nor the -s option is used, the “start” property group is searched for in the currently selected entity and, if an instance is currently selected, its parent is also searched. If the “inetd_start” property group is not located, it is searched for in a similar manner.

Once the property is located, all values which begin with envvar followed by a “=” are removed, and the value “envvar=value” is added. See smf_security(5) for the privileges required to modify properties.

setproppg/name = [[type:] value]

setprop pg/name = [type:] ([values ...])

Sets the name property of the pg property group of the current selection to the given values of type type. See scf_value_create(3SCF) for a list of available property types. If the pg does not exist setprop will create one if it can find the pg type and flags in the template definitions. If the selection is an instance, setprop will look for the pg type and flags in the service before looking up the template definitions. If no pg type and flags are found, the subcommand will fail. If the named property does not exist, it is created, as long as the type is specified. If the property already exists and the type disagrees with the existing type on the property, the subcommand fails. If no type and no value are provided, setprop will delete all values for the pg/name. Values may be enclosed in double-quotes. String values which contain double-quotes or backslashes must be enclosed by double-quotes and the contained double-quotes and backslashes must be quoted by backslashes. Multiple values will be stored in the order in which they are specified. See smf_security(5) for the privileges required to create or modify properties.

unsetenv [-i | -s] [-mmethod_name] envvar

Removes a method environment variable for a service or instance by changing the “environment” property in the method_name property group, if that property group has type “method”. If method_name is not specified and the -i option is used, the “method_context” property group is used, if an instance is currently selected. If the -s option is used and a service is currently selected, its “method_context” property group is used. If the -s option is used and an instance is currently selected, the “method_context” property group of its parent is used. If neither the -i option nor the -s option is used, the “start” property group is searched for in the currently selected entity and, if an instance is currently selected, its parent is also searched. If the “inetd_start” property group is not located, it is searched for in a similar manner.

Once the property is located, all values which begin with envvar followed by “=” are removed. See smf_security(5) for the privileges required to modify properties.

Notification Parameters Subcommands

Used to set system-wide notification parameters for SMF state transition. See smf(5). These notification parameters are set in svc:/system/svc/global:default regardless of any svccfg current selection. This subcommand refreshes all instances it modifies.

Comma-separated list of SMF state transitions. See smf(5) Notification Parameters.

notification_parameters

URI format for each notification mechanism implemented: For SMTP use:

mailto:addr[?header1=value1[&header2=value2]]

...or:

mailto:{[active]|inactive}

...and for SNMP traps use:

snmp:{[active]|inactive}

The parameter msg_template defined in smtp-notify(1M) can be set as a header value in the mailto URI. For example:

mailto:root@localhost?msg_template=<path to template file>

SNMP traps are directed to the host as defined by the trapsink directive in /etc/net-snmp/snmp/snmpd.conf or as specified by the SNMP trap notification daemon. See smtp-notify(1M).

The notification parameters are specific to the class or tset specified and overwrite preexisting notification parameters. The active/inactive form does not overwrite previous notification parameters. It just switches on or off the notification mechanism for the specified class or tset. Setting notification parameters implicitly sets them as active.

listnotify [-g] [tset] | class

Displays the existing notification parameters for the specified class or tset. With the -g option, the notification parameters in svc:/system/svc/global:default are displayed. If tset is omitted, all is implied.

delnotify [-g] tset | class

Delete the existing notification parameters for the specified class or tset. With the -g option, the notification parameters in svc:/system/svc/global:default are deleted.

Snapshot Navigation and Selection Subcommands

listsnap

Displays snapshots available for the currently selected instance.

revert [snapshot]

Reverts the administrative customizations of the currently selected instance and its service to those recorded in the named snapshot. If no argument is given, use the currently selected snapshot and deselect it on success. The changed property values can be made active via the refresh subcommand of svcadm(1M). See smf_security(5) for the privileges required to change properties.

selectsnap [name]

Changes the current snapshot to the one named by name. If no name is specified, deselect the currently selected snapshot. Snapshots are read-only.

Instance Subcommands

refresh

Commit the values from the current configuration to the running snapshot, making them available for use by the currently selected instance. If the repository subcommand has not been used to select a repository, direct the instance's restarter to reread the updated configuration.

Examples

Example 1 Importing a Service Description

The following example imports a service description for the seismic service in
the XML manifest specified on the command line.

To examine the state of a service's properties after loading an alternate
repository, use the sequence of commands shown below. One might use such
commands, for example, to determine whether a service was enabled in a
particular repository backup.