Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Friday, February 2, 2018
 
 

svccfg(8)

Name

svccfg - import, export, and modify service configurations

Synopsis

/usr/sbin/svccfg [-v] [-s
 FMRI]
/usr/sbin/svccfg [-v] [-s
 FMRI] subcommand [
args]...
/usr/sbin/svccfg [-v] [-s
 FMRI] -f command-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(8) man page for more details.

Options

The following options are supported:

–f command-file

Reads and executes svccfg subcommands from command-file.

–s FMRI

Selects the entity indicated by FMRI (a fault management resource identifier) before executing any subcommands. If –f command-file is not provided and no subcommands are specified on the command line, then masked entities will be treated as non-existent. For more information, see the smf(7) man page.

–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 [–p prefix] repfile

Uses repfile as a repository. By default, svccfg uses the system repository.

Use the repository subcommand only on files from the identical version of Oracle Solaris which is running in your system, including all SRUs. In other words, the version of the 'entire' package as reported by pkg(1) should match exactly. 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 svccfg import. This prefix will be replaced by /lib/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] file | directory

If the file is a service profile or manifest in a standard location or the directory is a standard location, apply the configuration to the layer of the SMF repository that corresponds to that location.

If a conflict exists between property values in the same profile or manifest layer, a message similar to the following is displayed and the configuration is not applied to the running snapshot:

svccfg: svc:/service-name:instance-name: property group "pg-name" has a conflict.

If the file is a service profile or manifest in a non-standard location, apply the configuration to the admin layer of the SMF repository.

If the operand is a directory, all profiles found under that directory tree are applied.

The command fails if a specified file or any file found under a specified directory is not a service profile.

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. Non-existent 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(7) for a description of service profiles. This command requires privileges to modify properties in the service and instance. See smf_security(7) for the privileges required to modify properties.

extract [–a] [–l layer] [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 , enterprise-profile, site-profile, node-profile, sysconfig-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 –l admin,sysconfig-profile,node-profile,site-profile,enterprise-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(7)) 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]

The output from svccfg export is similar to the following svccfg extract command output. The difference is that export generates a manifest, while extract generates a profile as described above.

svccfg extract -l current [-a] service_FMRI [>file]
import [–V] [file | directory]

svccfg import on a file in a subdirectoryof /lib/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].

inventory file

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(7)) 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(7) for a description of templates.

Entity Selection, Modification, and Navigation Subcommands

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

add name

A new entity with the given name is created as a child of the current selection. See smf_security(7) 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(7) 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(7) 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(7)). ':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

addpg name type [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(7) for the privileges required to create property groups.

If –G option is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option, the property group name must be encoded if a reserved character is used (see smf(7)). Specifying multiple –G arguments will create a nested property group. The parent property group must always exist, and the property group hierarchy will be traversed in the order the –G options appear.

addpropvalue –G pg [–G pg ...] –P name [–T type] value
addpropvalue pg/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, found, the subcommand will fail. The value may be enclosed in double-quotes. When so enclosed, any character preceded by a backslash will be passed through with no additional interpretation or special meaning. String values containing whitespace, double-quotes or backslashes must be enclosed by double-quotes and the contained double-quotes and backslashes must be quoted by backslashes. When invoked non-interactively, care must be taken to ensure that your shell quoting conventions do not consume the required double quotes and backslashes. Non-existent properties are created, in which case the type specifier must be present. See the smf(7) man page for a list of available property types. See the smf_security(7) 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.

If the –G option is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option, the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

If –P option is supplied, the specified argument is used as the property name and may not specify a pattern. When not using the –P option, the property name must be encoded if a reserved character is used. For more information, see the smf(7) man page.

If –T option is supplied, the specified argument is used as the property's type and may not specify a pattern.

decode [–n] name

Decode the given name as per RFC 3986 guidelines.

If the –n option is supplied, the newline at the end of the string is omitted from the output.

delcust [–M] [–G pg [–G pg ...] [–P name]]
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.

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

If –P is supplied, the specified argument is used as the property name and may not specify a pattern. When not using the –P option, the property name must be encoded if a reserved character is used. For more information, see the smf(7) man page.

delpg –G name [–G name ...]
delpg name

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

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

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

delprop –G pg [–G pg ...] [–P name]
delprop pg[/name]

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

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

If –P is supplied, the specified argument is used as the property name and may not specify a pattern. When not using the –P option, the property name must be encoded if a reserved character is used. For more information, see the smf(7) man page.

delpropvalue –G pg [–G pg ...] –P name globpattern
delpropvalue pg/name globpattern

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

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

If –P is supplied, the specified argument is used as the property name and may not specify a pattern. When not using the –P option, the property name must be encoded if a reserved character is used. For more information, see the smf(7) man page.

describe [–v] [–t] [–G propertygroup [–G propertygroup ...] [–P property]]
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(7)), and does not display the current settings for property groups and properties.

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

If –P is supplied, the specified argument is used as the property name and may not specify a pattern. When not using the –P option, the property name must be encoded if a reserved character is used. For more information, see the smf(7) man page.

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(7) 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.

encode [–n] name

Encode the given name as per RFC 3986 guidelines.

If –n is supplied, the newline at the end of the string is omitted from the output.

listpg [–G name ...]
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.

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

listprop [–l layer...] [–f | –o format] [–G pg [–G pg ...] [–P name]]
listprop [–l layer...] [–f | –o format ] [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 the smf(7) man page 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, enterprise-profile, site-profile, node-profile, sysconfig-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

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

If –P is supplied, the specified argument is used as the property name and may not specify a pattern. When not using the –P option, the property name must be encoded if a reserved character is used. For more information, see the smf(7) man page.


Note -  listprop output is not appropriate for parsing in shell scripts, instead use svcprop in such cases.
listcust [–L] [–M] [–G pg [–G pg...] [–P name]]
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 enterprise-profile, site-profile, node-profile, andsysconfig-profile layers in addition to those in the admin layer.

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

If –P is supplied, the specified argument is used as the property name and may not specify a pattern. When not using the –P option, the property name must be encoded if a reserved character is used. For more information, see the smf(7) man page.

setenv [–i | –s] [–m method_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(7) for the privileges required to modify properties.

setprop –G pg [–G pg ...] –P name [–T type] [value]...
setprop pg/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 the smf(7) man page 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 the values for the pg or name. Values may be enclosed in double-quotes. When so enclosed, any character preceded by a backslash will be passed through with no additional interpretation or special meaning. String values containing whitespace, double-quotes, or backslashes must be enclosed by double-quotes, and the contained double-quotes and backslashes must be quoted by backslashes. When invoked non-interactively, care must be taken to ensure that your shell quoting conventions do not consume the required double quotes and backslashes. Multiple values will be stored in the order in which they are specified. For more information about the privileges required to create or modify properties, see the smf_security(7) man page.

If –G is supplied, the specified argument is used as the property group name and may not specify a pattern. When not using the –G option the property group name must be encoded if a reserved character is used. When multiple –G options appear then the options indicate how to traverse the property group hierarchy.

If –P is supplied, the specified argument is used as the property name and may not specify a pattern. When not using the –P option, the property name must be encoded if a reserved character is used.

If –T is supplied the specified argument is used as the property's type and may not specify a pattern.

unsetenv [–i | –s] [–m method_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(7) for the privileges required to modify properties.

Notification Parameters Subcommands

setnotify {[–g] tset | class} notification_parameters

Sets notifications parameters for software events and Fault Management problem lifecycle events in the SMF repository.

–g

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

class

Comma-separated list of FMA Event classes or aliases. See smf(7) Notification Parameters.

tset

Comma-separated list of SMF state transitions. See smf(7) 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(8) 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(8).

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(8). See smf_security(7) 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. If the repository has been used, snapshots will be refreshed automatically.

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.

# svccfg import /lib/svc/manifest/site/seismic.xml

Note that the manifest must follow the format specified in service_bundle(5).

Example 2 Exporting a Service Description

To export a service description on the local system:

# svccfg export dumpadm >/tmp/dump.xml
Example 3 Deleting a Service Instance

To delete a service instance:

# svccfg delete network/inetd-upgrade:default
Example 4 Checking Properties in an Alternate Repository

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.

# svccfg
svc:> repository /etc/svc/repository-boot
svc:> select telnet:default
svc:/network/telnet:default> listprop general/enabled
general/enabled  boolean  false
svc:/network/telnet:default> exit
Example 5 Enabling Debugging

To modify LD_PRELOAD for a start method and enable the use of libumem(3LIB) with debugging features active:

$ svccfg -s system/service setenv LD_PRELOAD libumem.so
$ svccfg -s system/service setenv UMEM_DEBUG default

Example 6 Using describe Subcommand

The following command illustrates the use of the describe subcommand.

# svccfg -s console-login describe ttymon
ttymon                      application
ttymon/device               astring  /dev/console
   terminal device to be used for the console login prompt
ttymon/label                astring  console
   appropriate entry from /etc/ttydefs
   ...

Example 7 Configuring Notification Preferences

The following command configures notification preferences for SMF service state transition events.

# svccfg setnotify -g from-online,to-maintenance \
mailto:admin@somehost.com
Example 8 Enabling SNMP Notifications

The following command enables SNMP notifications for Fault Management events.

# svccfg setnotify problem-diagnosed,problem-updated \
mailto:admin@somehost.com snmp:
Example 9 Listing Notification Settings

The following command lists notification settings for Fault Management events.

# svccfg listnotify problem-diagnosed,problem-updated
Event: problem-diagnosed
  Notification Type: smtp
    active: true
   to: admin@somehost.com
  Notification Type: snmp
    active: true

Event: problem-updated
  Notification Type: smtp
    active: true
   to: admin@somehost.com
  Notification Type: snmp
    active: true
Example 10 Unmasking a Service

The following sequence of commands shows the existence of the service mysvc, that mysvc is masked, and finally unmasks the service.

$ svcs -l mysvc
fmri         svc:/system/mysvc:default
name         Manifest to test snapshots
enabled      true
state        online
next_state   none
state_time   January 13, 2012 09:42:55 AM MST
logfile      /var/svc/log/system-mysvc:default.log
restarter    svc:/system/svc/restarter:default
manifest     /lib/svc/manifest/test/mysvc.xml
dependency   require_all/none svc:/system/filesystem/local (online)

[ Note manifest file in standard location. ]

# svccfg delete -f mysvc
$ svcs mysvc
svcs: Pattern 'mysvc' doesn't match any instances
STATE          STIME    FMRI

[ Not listed because service is masked. ]

$ svccfg listcust -M | grep mysvc
svc:/system/mysvc manifest MASKED
  manifestfiles/lib_svc_manifest_test_mysvc_xml astring     admin \
         MASKED /lib/svc/manifest/test/mysvc.xml
svc:/system/mysvc:default manifest MASKED

[ First line, above, shows that service is masked.  Masking is
  propagated down, so the instance is also masked as shown in 
  the last line. ]

# svccfg -s svc:/system/mysvc delcust
 Deleting customizations for service: system/mysvc
$ svcs mysvc
STATE          STIME    FMRI
online          9:48:25 svc:/system/mysvc:default

[ Masking has been removed. ]
Example 11 Setting a Multi-Value Property

The following command sets a multi-value property.

# svccfg -s svc:/stooges setprop foo/bar = astring: \
\(moe Curly Larry \)
Example 12 Clearing All Values from a Property Using setprop

The following command uses setprop to clear all values from a property.

# svccfg -s svc:/stooges setprop foo/bar =
Example 13 Clearing All Values from a Property Using delpropvalue

The following command uses delpropvalue to clear all values from a property.

# svccfg -s svc:/stooges delpropvalue foo/bar \*
Example 14 Setting Property with Embedded Whitespace

The following command sets a property whose value is a string with embedded whitespace.

# svccfg -s svc:inst setprop pg/prop = \
astring: "In spite of the spaces, this is one string."

If specifying the property group name and property name unambiguously is preferred, then the same command may be written:

# svccfg -s svc:inst setprop -G pg -P prop \
-T astring "In spite of the spaces, this is one string."
Example 15 Setting a Property Group with Reserved Characters

The following command sets a property group whose name is a string containing a reserved character.

# svccfg -s svc:inst setprop pg%20a/prop = astring: "foo"

If specifying the property group name unambiguously, then the same command may be written without the encoding by using the –G option:

# svccfg -s svc:inst setprop -G "pg a" -P prop -T astring "foo"
Example 16 Setting a Nested Property Group with Reserved Characters

The following command sets a property group whose name is a string containing a reserved character that is nested within another property group.

# svccfg -s svc:inst setprop pg%20a/pg%20b/prop = astring: "foo"

If specifying the property group name unambiguously then the same command may be written without the encoding by using the –G option:

# svccfg -s svc:inst setprop -G "pg a" -G "pg b" -P prop -T astring "foo"

ENVIRONMENTAL VARIABLES

EDITOR

The command to run when the editprop subcommand is used. The default editor is vi(1).

Exit Status

The following exit values are returned:

0

Successful execution.

1

One or more subcommands resulted in failure. Error messages are written to the standard error stream.

2

Invalid command line options were specified. This exit status does not apply to subcommands.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/core-os
Interface Stability
See below.

The interactive output is Uncommitted. The invocation and non-interactive output are Committed.

See Also

svcprop(1), svcs(1), libscf(3LIB), libumem(3LIB), scf_service_add_pg(3SCF), scf_value_create(3SCF), contract(5), service_bundle(5), attributes(7), fnmatch(7), smf(7), smf_method(7), smf_security(7), smf_template(7), smtp-notify(8), svc.configd(8), svcadm(8)