Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (SunOS-5.10)
Apropos / Subsearch:
optional field

svcprop(1)                       User Commands                      svcprop(1)

       svcprop - retrieve service configuration properties

       svcprop  [-fqtv]  [-C  | -c | -s snapshot] [-p  [name/]name]... [FMRI |

       svcprop -w [-fqtv] [-p  [name/]name] {FMRI | pattern}

       The svcprop utility prints values of properties in the service configu-
       ration repository. Properties are selected by -p options and FMRI oper-

       By default, when a single property is selected, its values are  printed
       separated  by  spaces  on  a single line. Empty ASCII string values are
       represented by a pair of double quotes (""). Bourne  shell  metacharac-
       ters  (';',  '&&amp;',  '(',  ')',  '|', '^', '<&lt;', '>&gt;', newline, space, tab,
       backslash, '"', single-quote, '`') in ASCII string values are quoted by
       backslashes (\).

       When  multiple  properties  are  selected, a single line is printed for
       each. Each line comprises a property designator, a property  type,  and
       the  values (as described above), separated by spaces. By default, if a
       single FMRI operand has been supplied, the property designator consists
       of the property group name and the property name joined by a slash (/).
       If multiple FMRI operands are supplied, the designator is the canonical
       FMRI for the property.

       A  composed  property  may be selected directly from the entities which
       match a specified FMRI or from entities which may be used as  a  source
       of  properties  for  these  matching entities. An example of a composed
       property is a property which is set on a service, which may be selected
       when an instance matching an FMRI does not possess the property itself.

       An  un-composed  property  selection is made against the specified FMRI
       with no further searching of additional  sources  of  properties  other
       than the entities which match the designated FMRI.

       Properties  are  displayed either with or without composition depending
       on the options which are supplied at invocation.  Properties  are  com-
       posed by default.

       A  snapshot,  which is a point in time representation of the state of a
       matching entity's properties at a moment in time, always uses  composi-
       tion because snapshots are always composed.

       Error messages are printed to the standard error stream.

       Many properties have specific meanings to the Service Management Facil-
       ity or the service's restarter.

       The following options are supported:

       -C                      Retrieves the current property values,  without

       -c                      Retrieves  the  current  property  values, with

       -f                      Designates properties by their  FMRIs.  Implies
                               option -t.

       -p [name/]name          Prints values of the named property or property
                               group  for  each  of   the   property   groups,
                               instances,  or  services specified by the oper-

       -q                      Quiet. Produces no output.

       -s snapshot             Uses the named snapshot to retrieve the  speci-
                               fied  property or property group, with composi-
                               tion (since snapshots are always composed).  If
                               the  given property group is not present in the
                               snapshot, the current property values are exam-

       -t                      Uses the multi-property output format.

       -v                      Verbose.  Prints error messages for nonexistent
                               properties, even if option -q is also used.

       -w                      Waits for the selected property group or  prop-
                               erty to change before printing anything.

                               This  option is only valid when a single entity
                               is given. If more than one operand is given, or
                               an  operand  matches more than one instance, an
                               error message  is  printed  and  no  action  is
                               taken.  The  -w option always causes svcprop to
                               operate against current property values.

       The following operand is supported:

       FMRI            With no -p options, FMRI operands can name  a  service,
                       instance,  property  group,  or property. For services,
                       service instances, and property groups,  all  contained
                       properties are selected.

                       Instances and services can be abbreviated by specifying
                       the instance name, or the trailing portion of the  ser-
                       vice name. Properties and property groups must be spec-
                       ified by a full FMRI. For example, given the FMRI:


                       The following are valid abbreviations:


                       The following are invalid abbreviations:


                       Abbreviated forms of FMRIs are unstable and should  not
                       be used in scripts or other permanent tools.

                       Arguments  to the -p option can name property groups or
                       properties. In the former case, operands can name  ser-
                       vices  or  instances,  and  all properties in the named
                       property group of the named services or  instances  are
                       printed.  In  the  latter,  operands can name services,
                       instances, or property groups, and the named properties
                       belonging to the operands are printed.

                       By  default,  all properties are selected from the run-
                       ning snapshot, with composition. If there is no running
                       snapshot,  then current properties are selected. The -w
                       and -s options can be used  to  change  the  source  of

                       When  walking  properties, that is, no -p options, cur-
                       rent nonpersistent property groups are also selected.

                       With -p options, if the property group doesn't exist in
                       the  running  snapshot,  then  if the property group is
                       nonpersistent the current property or property group is

       Example 1: Displaying the Value of a Single Property

       The following example displays the value of the enabled property in the
       general property group of instance default of service inetd.

       example%  svcprop -p general/enabled network/inetd:default

       Example 2: Displaying All Properties in a Property Group

       This example displays all properties in the general property  group  of
       service ntp.

       example% svcprop -p general ntp
       general/entity_stability astring Unstable
       general/single_instance boolean true

       Example 3: Verifying the Existance of a Property

       This example verifies the existence of the general/enabled property for
       all instances of service identity.

       example%  svcprop -q -p general/enabled identity:
       example%  echo $?

       Example 4: Waiting for Property Change

       This example waits for the sendmail instance to change state.

       example%  svcprop -w -p restarter/state sendmail

       Example 5: Using svcprop in a Script

       example% cat getval

       svcprop -p $1 $2 | (
                read value v2
                if [ -n "$v2" ]; then echo "Multiple values!"; exit; fi
                echo $value

       The following exit values are returned:

       0        Successful completion.

       1        An error occurred.

       2        Invalid command line options were specified.

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

       tab()    allbox;    cw(2.750000i)|     cw(2.750000i)     lw(2.750000i)|
       lw(2.750000i).  ATTRIBUTE TYPEATTRIBUTE VALUE AvailabilitySUNWcsu

       svcs(1),  inetd(1M),  svc.startd(1M), service_bundle(4), attributes(5),
       smf(5), smf_method(5), smf_security(5)

SunOS 5.10                        8 Dec 2004                        svcprop(1)