| Skip Navigation Links | |
| Exit Print View | |
![]() | man pages section 1M: System Administration Commands Oracle Solaris 11 Information Library |
- manipulate service instances
/usr/sbin/svcadm [-v] enable [-rst] {FMRI |pattern}.../usr/sbin/svcadm [-v] disable [-st] {FMRI |pattern}.../usr/sbin/svcadm [-v] restart {FMRI |pattern}.../usr/sbin/svcadm [-v] refresh {FMRI |pattern}.../usr/sbin/svcadm [-v] clear {FMRI |pattern}.../usr/sbin/svcadm [-v] mark [-It]instance_state {FMRI |pattern}.../usr/sbin/svcadm [-v] milestone [-d]milestone_FMRI
svcadm issues requests for actions on services executing within the service managementfacility (seesmf(5)). Actions for a service are carried out by its assignedservice restarter agent. The default service restarter issvc.startd (seesvc.startd(1M)).
The following options are supported:
Print actions verbosely to standard output.
The subcommands listed below are used during the typical administration of aservice instance.
For subcommands taking one or more operands, if the operand specifies aservice (instead of a service instance), and that service has only asingle instance,svcadm operates on that instance. If an abbreviatedFMRI (afault management resource identifier) or pattern matches more than one service, a warningmessage is displayed and that operand is ignored. Seesmf(5).
In the case that the service has more than one instance,svcadmreturn a non-zero exit status.
Enables the service instances specified by the operands. For each service instance, the assigned restarter will try to bring it to the online state. This action requires permission to modify the “general” property group of the service instance (seesmf_security(5)).
If the-r option is specified,svcadm enables each service instance and recursively enables its dependencies.
If the-s option is specified,svcadm enables each service instance and then waits for each service instance to enter theonline ordegraded state.svcadm will return early if it determines that the service cannot reach these states without administrator intervention.
If the-t option is specified,svcadm temporarily enables each service instance. Temporary enable only lasts until reboot. This action requires permission to modify the “restarter_actions” property group of the service instance (seesmf_security(5)). By default,enable is persistent across reboot.
Disables the service instance specified by the operands. For each service instance, the assigned restarter will try to bring it to the disabled state. This action requires permission to modify the “general” property group of the service instance (seesmf_security(5)).
If the-s option is specified,svcadm disables each service instance and then waits for each service instance to enter the disabled state.svcadm will return early if it determines that the service cannot reach this state without administrator intervention.
If the-t option is specified,svcadm temporarily disables each service instance. Temporary disable only lasts until reboot. This action requires permission to modify the “restarter_actions” property group of the service instance (seesmf_security(5)). By default,disable is persistent across reboot.
Requests that the service instances specified by the operands be restarted. This action requires permission to modify the “restarter_actions” property group of the service instance (seesmf_security(5)). Restarting a service is implemented by most restarters as a full service “stop” followed by a “start“.
This subcommand can restart only those services that are in the online or degraded states, as those states are defined insmf(5).
For each service instance specified by the operands, requests that the assigned restarter update the service's running configuration snapshot with the values from the current configuration. Some of these values take effect immediately (for example, dependency changes). Other values do not take effect until the next servicerestart. See the restarter and service documentation for more information.
If the service is managed bysvc.startd(1M), therefresh method will be invoked if it exists to request the service reread its own configuration. For other restarters, see the restarter documentation.
This action requires permission to modify the “restarter_actions” property group of the service instance (seesmf_security(5)).
For each service instance specified by the operands, if the instance is in themaintenance state, signal to the assigned restarter that the service has been repaired. If the instance is in thedegraded state, request that the assigned restarter take the service to theonline state. This action requires permission to modify the “restarter_actions” property group of the service instance (seesmf_security(5)).
The following subcommands are used for service development and temporary administrative manipulation.
Ifinstance_state is “maintenance”, then for each service specified by the operands,svcadm requests that the assigned restarter place the service in themaintenance state. Seesvc.startd(1M) andinetd(1M) for a detailed description of the actions taken for each restarter.
Ifinstance_state is “degraded”, then for services specified by the operands in the online state,svcadm requests that the restarters assigned to the services move them into thedegraded state.
If the-I option is specified, the request is flagged as immediate.
The-t option is only valid for maintenance requests. When this option is specified, the request is flagged as temporary, and its effect will only last until the next reboot.
Ifmilestone_FMRI is the keyword “none”, all services other than the master restarter,svc:/system/svc/restarter:default, will be temporarily disabled.
Ifmilestone_FMRI is the keyword “all”, temporary enable and disable requests for all services will be nullified.
Ifmilestone_FMRI is one of the following:
svc:/milestone/single-user:defaultsvc:/milestone/multi-user:defaultsvc:/milestone/multi-user-server:default
then temporary enable and disable requests for the indicated service and all services it depends on (directly or indirectly) will be nullified. All other services will be temporarily disabled.
Changing the system's current milestone with the “milestone” subcommand will not change the current run level of the system. To change the system's run level, invoke/usr/sbin/init directly.
This action requires permission to modify the “options_ovr” property group of thesvc:/system/svc/restarter:default service instance (seesmf_security(5)).
The-d option immediately changes the milestone to the requested milestone, as above. Additionally, it makes the specified milestone the default boot milestone, which persists across reboot. The default milestone is defined by theoptions/milestone property on the master restarter,svc:/system/svc/restarter:default. If this property is absent, “all” is the default. This action requires permission to modify the “options” property group of thesvc:/system/svc/restarter:default service instance (seesmf_security(5)).
The following operands are supported:
AnFMRI that specifies one or more instances.FMRIs can be abbreviated by specifying the instance name, or the trailing portion of the service name. For example, given theFMRI:
svc:/network/smtp:sendmail
All the following are valid abbreviations:
sendmail :sendmail smtp smtp:sendmail network/smtp
While the following are invalid:
mailnetworknetwork/smt
If theFMRI specifies a service, then the command applies to all instances of that service. Abbreviated forms ofFMRIs are unstable, and should not be used in scripts or other permanent tools.
A pattern that is matched against theFMRIs of service instances according to the “globbing” rules described byfnmatch(5). If the pattern does not begin with “svc:”, then “svc:/” is prepended.
If an abbreviatedFMRI or pattern matches more than one service, awarning message is displayed and that operand is ignored.
Example 1 Restarting a Service Instance
The following command restarts the NFS server. The fullFMRI for thedefault service instance is:svc:/network/nfs/server:default
However, you can abbreviate the fullFMRI as follows:
# svcadm restart nfs/server
Example 2 Disabling the Standard HTTP Server
The following command disables the standard HTTP server, using an abbreviatedFMRI:
$ svcadm disable http
Example 3 Enabling an Instance and Its Dependent Instances
The following command enables thefoo:bar instance, and all instances on whichit depends:
$ svcadm enable -r foo:bar
Example 4 Synchronously enabling an instance
The following command enables thefoo:bar instance. The command will not returnuntil the instance comes online orsvcadm determines it is not possiblefor the service to come online.
$ svcadm enable -s foo:bar
Example 5 Restricting and Restoring the Running Services
The following command restricts the running services to single user mode:
# svcadm milestone milestone/single-user
The following command restores the running services:
# svcadm milestone all
The following exit values are returned:
Successful completion.
A fatal error occurred. One or more error messages are displayed on standard error.
Invalid command line options were specified.
svcadm determined that a service instance that it was waiting for could not reach the desired state without administrator intervention due to a problem with the service instance itself.
svcadm determined that a service instance that it was waiting for could not reach the desired state without administrator intervention due to a problem with the service's dependencies.
Seeattributes(5) for descriptions of the following attributes:
|
The interactive output is Uncommitted. The invocation and non-interactive output are Committed.
svcprop(1),svcs(1),inetd(1M),init(1M),svccfg(1M),svc.startd(1M),libscf(3LIB),contract(4),attributes(5),smf(5),smf_security(5)
The amount of timesvcadm will spend waiting for services and theirdependencies to change state is implicitly limited by their method timeouts. Forexample, a service using the default restarter whose start method hangs willbe transitioned to the maintenance state when its timeout expires.svcadm will thenconsider it impossible for this service to come online without administrator intervention.
Attempts to synchronously enable a service which depends (directly or indirectly) ona file may fail with an exit status indicating that dependencies areunsatisfied if the caller does not have the privileges necessary to searchthe directory containing the file. This limitation may be removed in a futureSolaris release.
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.Legal Notices | ![]() ![]() |