Current File : //lib/python2.7/site-packages/salt/states/service.pyo
�
���^c @@ s4 d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l m
Z d d l m
Z
d d l m Z d Z d
Z d � Z d � Z d
� Z e d � Z e d � Z d � Z d d d e e e d � Z d d d d � Z d � Z d � Z e d � Z e d � Z d d e e d e d � Z! d S( u�
Starting or restarting of services and daemons
==============================================
Services are defined as system daemons and are typically launched using system
init or rc scripts. This service state uses whichever service module is loaded
on the minion with the virtualname of ``service``. Services can be defined as
either running or dead.
If you need to know if your init system is supported, see the list of supported
:mod:`service modules <salt.modules.service.py>` for your desired init system
(systemd, sysvinit, launchctl, etc.).
Note that Salt's service execution module, and therefore this service state,
uses OS grains to ascertain which service module should be loaded and used to
execute service functions. As existing distributions change init systems or
new distributions are created, OS detection can sometimes be incomplete.
If your service states are running into trouble with init system detection,
please see the :ref:`Overriding Virtual Module Providers <module-provider-override>`
section of Salt's module documentation to work around possible errors.
.. note::
The current status of a service is determined by the return code of the init/rc
script status command. A status return code of 0 it is considered running. Any
other return code is considered dead.
.. code-block:: yaml
httpd:
service.running: []
The service can also be set to start at runtime via the enable option:
.. code-block:: yaml
openvpn:
service.running:
- enable: True
By default if a service is triggered to refresh due to a watch statement the
service is restarted. If the desired behavior is to reload the service, then
set the reload value to True:
.. code-block:: yaml
redis:
service.running:
- enable: True
- reload: True
- watch:
- pkg: redis
.. note::
More details regarding ``watch`` can be found in the
:ref:`Requisites <requisites>` documentation.
i ( t absolute_importt print_functiont unicode_literalsN( t get_function_argspec( t CommandExecutionError( t sixu no_blocku unmasku unmask_runtimeu servicec C@ s7 d t k r t St d j t j d t d � � f Sd S( ur
Only make these states available if a service provider has been detected or
assigned for this minion
u
service.startuP No service execution module loaded: check support for service management on {0} u osfingeru osN( t __salt__t __virtualname__t Falset formatt
__grains__t get( ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt __virtual__N s c C@ s� i } g } t | � j } xX t D]P } | j | t � } | r" | | k rY | | | <qr | j d j | � � q" q" W| | f S( Nu; The '{0}' argument is not supported by this platform/action( t _argspect argst SYSTEMD_ONLYR R t appendR ( t funct kwargst rett warningst
valid_argst systemd_argt arg_val( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt _get_systemd_only] s
c C@ s) t | d <d d j | d � | d <| S( u!
Warn of potential typo.
u resultu1 Service {0} uses non-existent option "enabled". u% Perhaps "enable" option was intended?u nameu comment( R R ( R ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt _enabled_used_errorn s
c K@ s� i } y t | | � s | SWn+ t k
rJ } t | d <| j | d <| SX| | d <d t k sm d t k r� | t k r� d j | � | d <n5 | d k r� d j | � | d <n d j | � | d <| St d | | � } | rF| t k rd j | � | d <n? | d k r/i | d <d
j | � | d <n d j | � | d <| St d rqd | d <d
j | � | d <| Sy� t d | | � r i | d <t d | | � } | | k r�t | d | <n | t k r�d j | � | d <n5 | d k rd j | � | d <n d j | � | d <| SWn t k
r;} | j } n Xt } t | d <| t k rnd j | � | d <n5 | d k r�d j | � | d <n d j | � | d <| r�| d c d j | � 7<n | S( u
Enable the service
u resultu commentu service.enableu service.enabledu; Enable is not available on this minion, service {0} starteduK Enable is not available on this minion, service {0} is in the desired stateu; Enable is not available on this minion, service {0} is deadu. Service {0} is already enabled, and is runningu changesu; Service {0} is already enabled, and is in the desired stateu+ Service {0} is already enabled, and is deadu testu Service {0} set to be enabledu, Service {0} has been enabled, and is runningu9 Service {0} has been enabled, and is in the desired stateu) Service {0} has been enabled, and is deaduL Failed when setting service {0} to start at boot, but the service is runninguU Failed when setting service {0} to start at boot, but the service was already runninguI Failed when setting service {0} to start at boot, and the service is deadu& . Additional information follows:
{0}N( t
_availableR R t strerrorR t TrueR t Nonet __opts__( t namet startedt resultR R t exct before_toggle_enable_statust after_toggle_enable_statust enable_error( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt _enablez s�
c K@ s� i } y! t | | � s& t | d <| SWn+ t k
rT } t | d <| j | d <| SX| | d <d t k sw d t k r� | t k r� d j | � | d <n5 | d k r� d j | � | d <n d j | � | d <| St j j
j � rt d | � d d k } n t d | � } | r|| t k r9d j | � | d <n? | d k rei | d <d
j | � | d <n d j | � | d <| St d r�d | d <d j | � | d <| St d | | � rLi | d <t d | � } | | k r�t | d | <n | t k rd j | � | d <n5 | d k r5d j | � | d <n d j | � | d <| St | d <| t k rxd j | � | d <n5 | d k r�d j | � | d <n d j | � | d <| S( u
Disable the service
u resultu commentu service.disableu service.disabledu< Disable is not available on this minion, service {0} starteduL Disable is not available on this minion, service {0} is in the desired stateu< Disable is not available on this minion, service {0} is deadu service.infou StartTypeu Disabledu/ Service {0} is already disabled, and is runningu changesu< Service {0} is already disabled, and is in the desired stateu, Service {0} is already disabled, and is deadu testu Service {0} set to be disabledu- Service {0} has been disabled, and is runningu: Service {0} has been disabled, and is in the desired stateu* Service {0} has been disabled, and is deaduD Failed when setting service {0} to not start at boot, and is runninguY Failed when setting service {0} to not start at boot, but the service was already runninguM Failed when setting service {0} to not start at boot, and the service is deadN( u Disabled(
R R R R R R R R t saltt utilst platformt
is_windowsR ( R R R! R R R" t before_toggle_disable_statust after_toggle_disable_status( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt _disable� s|
c C@ sq t } d t k r% t d | � } n" d t k rG | t d � k } n | sm t | d <d j | � | d <n | S( u+
Check if the service is available
u service.availableu service.get_allu resultu& The named service {0} is not availableu comment( R R R ( R R t avail( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyR @ s
c K@ s� i | d 6i d 6t d 6d d 6} d | k r8 t | � St | t j � rb t j j j | � } n yF t | | � s� t
j d � r� d | d <d j
| � | d <n | SWn+ t k
r� } t | d <| j | d <| SXt d | | � }
d
t k rt d
| � } n t } i d d 6} | r3t | | � } n |
r�d j g d j
| � | d g D] }
|
rY|
^ qY� | d <| t k r�| r�| j t | d | � � n. | t k r�| r�| j t | d | � � n | St
d r0d | d <d j g d
j
| � | d g D] }
|
r
|
^ q
� | d <| St t d t � � \ } } | rn| j d g � j | � n t j j j � r�| j d t � r�| j i | j d � d 6� n y t d | | � } Wn+ t k
r�} t | d <| j | d <| SX| szt | d <d j
| � | d <| t k rH| j t | t d t | �� n. | t k rv| j t | t d t | �� n | S| r�t j | � n t d | | � } d
t k r�t d
| � } n t } | | k s�|
| k r| j d i � r| | d | <n | r d j
| � | d <n d j
| � | d <t | d <| t k rk| j t | | d | | �� n. | t k r�| j t | | d | | �� n | r�d j
| d | � | d <n | r�d j | d | d g � | d <n | S( u�
Ensure that the service is running
name
The name of the init or rc script used to manage the service
enable
Set the service to be enabled at boot time, ``True`` sets the service
to be enabled, ``False`` sets the named service to be disabled. The
default is ``None``, which does not enable or disable anything.
sig
The string to search for when looking for the service process with ps
init_delay
Some services may not be truly available for a short period after their
startup script indicates to the system that they are. Provide an
'init_delay' to specify that this state should wait an additional given
number of seconds after a service has started before returning. Useful
for requisite states wherein a dependent state might assume a service
has started but is not yet fully initialized.
no_block : False
**For systemd minions only.** Starts the service using ``--no-block``.
.. versionadded:: 2017.7.0
unmask : False
**For systemd minions only.** Set to ``True`` to remove an indefinite
mask before attempting to start the service.
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
making any changes. This behavior is no longer the default.
unmask_runtime : False
**For systemd minions only.** Set to ``True`` to remove a runtime mask
before attempting to start the service.
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
making any changes. This behavior is no longer the default.
.. note::
``watch`` can be used with service.running to restart a service when
another state changes ( example: a file.managed state that creates the
service's config file ). More details regarding ``watch`` can be found
in the :ref:`Requisites <requisites>` documentation.
u nameu changesu resultu u commentu enabledu testuQ Service {0} not present; if created in this state run, it would have been startedu service.statusu service.enabledu
u" The service {0} is already runningu Service {0} is set to startu
service.startu warningsu timeoutu Service {0} failed to startR! u Started Service {0}u" {0}
Delayed return for {1} secondsN( R R t
isinstanceR t string_typesR' R( t datat is_trueR R R R R R R R R t unmaskedt joint updateR& R- R t localst
setdefaultt extendR) R* t timet sleep( R t enablet sigt
init_delayt no_blockt unmaskt unmask_runtimeR R R" t before_toggle_statusR# t
unmask_rett _ft start_kwargsR t func_rett after_toggle_statusR$ ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt runningO s� 9
*
* $
" "
" "$c K@ s# i | d 6i d 6t d 6d d 6} d | k r8 t | � St | t j � rb t j j j | � } n yP t | | � s� t
j d � r� d | d <d j
| � | d <n
t | d <| SWn+ t k
r� } t | d <| j | d <| SXt d | | � } d
t k rAt j j j � r.t d | � d d k } qGt d
| � } n t } | s�d j
| � | d <| t k r�| r�| j t | d | � � n. | t k r�| r�| j t | d | � � n | St
d r�d | d <d j
| � | d <| St t d | � \ } }
|
r'| j d g � j |
� n t j j j � rk| j d t � rk| j i | j d � d 6� n t d | | � } | st | d <d j
| � | d <| t k r�| j t | t d t | �� n. | t k r�| j t | t d t | �� n | S| rt j | � n t d | � } d
t k rFt d
| � }
n t }
| |
k sd| | k r�| j d i � r�| | d | <n | r�t | d <d j
| � | d <n d j
| � | d <| t k r�| j t | | d | | �� n/ | t k r | j t | | d | | �� n | S( u
Ensure that the named service is dead by stopping the service if it is running
name
The name of the init or rc script used to manage the service
enable
Set the service to be enabled at boot time, ``True`` sets the service
to be enabled, ``False`` sets the named service to be disabled. The
default is ``None``, which does not enable or disable anything.
sig
The string to search for when looking for the service process with ps
init_delay
Add a sleep command (in seconds) before the check to make sure service
is killed.
.. versionadded:: 2017.7.0
no_block : False
**For systemd minions only.** Stops the service using ``--no-block``.
.. versionadded:: 2017.7.0
u nameu changesu resultu u commentu enabledu testuQ Service {0} not present; if created in this state run, it would have been stoppedu service.statusu service.enabledu service.infou StartTypeu Autou Manualu The service {0} is already deadu Service {0} is set to be killedu service.stopu warningsu timeoutu Service {0} failed to dieR! u Service {0} was killedN( u Autou Manual( R R R/ R R0 R' R( R1 R2 R R R R R R R R R R) R* R5 R& R- R R7 R8 R9 R: ( R R; R< R= R R R" RA R# t stop_kwargsR RE RF R$ ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt dead s�
$
" "
# #c K@ s? i | d 6i d 6t d 6d d 6} | j t | d | � � | S( uL
Ensure that the service is enabled on boot, only use this state if you
don't want to manage the running process, remember that if you want to
enable a running service to use the enable: True option for the running
or dead function.
name
The name of the init or rc script used to manage the service
u nameu changesu resultu u commentN( R R5 R& R ( R R R ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt enabled� s
c K@ s? i | d 6i d 6t d 6d d 6} | j t | d | � � | S( uG
Ensure that the service is disabled on boot, only use this state if you
don't want to manage the running process, remember that if you want to
disable a service to use the enable: False option for the running or dead
function.
name
The name of the init or rc script used to manage the service
u nameu changesu resultu u commentN( R R5 R- R ( R R R ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt disabled� s
c C@ sl i | d 6i d 6t d 6d d 6} d t k rF d | d <t | d <| S| rR d n d } i i t d
6t d 6| 6} y� t d | | � r� d j | | � | d <| St d
r� d | d <| | d <d j | | � | d <| St d | | � t d | | � r"| | d <d j | | � | d <n d j | � | d <| SWn+ t k
rg} t | d <| j | d <| SXd S( u�
.. versionadded:: 2017.7.0
.. note::
This state is only available on minions which use systemd_.
Ensures that the named service is masked (i.e. prevented from being
started).
name
Name of the service to mask
runtime : False
By default, this state will manage an indefinite mask for the named
service. Set this argument to ``True`` to runtime mask the service.
.. note::
It is possible for a service to have both indefinite and runtime masks
set for it. Therefore, this state will manage a runtime or indefinite
mask independently of each other. This means that if the service is
already indefinitely masked, running this state with ``runtime`` set to
``True`` will _not_ remove the indefinite mask before setting a runtime
mask. In these cases, if it is desirable to ensure that the service is
runtime masked and not indefinitely masked, pair this state with a
:py:func:`service.unmasked <salt.states.service.unmasked>` state, like
so:
.. code-block:: yaml
mask_runtime_foo:
service.masked:
- name: foo
- runtime: True
unmask_indefinite_foo:
service.unmasked:
- name: foo
- runtime: False
.. _systemd: https://freedesktop.org/wiki/Software/systemd/
u nameu changesu resultu u commentu service.maskedu, Service masking not available on this minionu runtime maskedu maskedu oldu newu Service {0} is already {1}u testu Service {0} would be {1}u service.masku Service {0} was {1}u Failed to mask service {0}N( R R R R R R R R ( R t runtimeR t mask_typet expected_changesR" ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt masked� s> +
c C@ s~ i | d 6i d 6t d 6d d 6} d t k rF d | d <t | d <| S| rR d n d } | rd d
n d } i i t d 6t d
6| 6} y� t d | | � s� d j | | � | d <| St d r� d | d <| | d <d j | | � | d <| St d | | � t d | | � s4| | d <d j | | � | d <n d j | � | d <| SWn+ t k
ry} t | d <| j | d <| SXd S( uW
.. versionadded:: 2017.7.0
.. note::
This state is only available on minions which use systemd_.
Ensures that the named service is unmasked
name
Name of the service to unmask
runtime : False
By default, this state will manage an indefinite mask for the named
service. Set this argument to ``True`` to ensure that the service is
runtime masked.
.. note::
It is possible for a service to have both indefinite and runtime masks
set for it. Therefore, this state will manage a runtime or indefinite
mask independently of each other. This means that if the service is
indefinitely masked, running this state with ``runtime`` set to
``True`` will _not_ remove the indefinite mask.
.. _systemd: https://freedesktop.org/wiki/Software/systemd/
u nameu changesu resultu u commentu service.maskedu, Service masking not available on this minionu runtime maskedu maskedu runtime unmaskedu unmaskedu oldu newu Service {0} was already {1}u testu Service {0} would be {1}u service.unmasku Service {0} was {1}u Failed to unmask service {0}N( R R R R R R R R ( R RL R RM t actionRN R" ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyR3 s<
c K@ s� i | d 6i d 6t d 6d d 6} d } | d k r� d }
|
d } t d | | � rd t d
} qpt | d <d j | � | d <| Sn� | d k rOt d | | � r)d
t k r� | r� d t k r� | r� t d } d }
q&t d
} d }
q9d t k r| rt d } d }
q9t d } d }
n t d } d }
| sp|
d } qpn! d j | � | d <t | d <| St d r�d | d <d j | � | d <| S|
d k r�d
t k r�t d
| � n t | | � \ } }
|
r�| j d g � j |
� n y | | | � } Wn+ t k
r;} t | d <| j
| d <| SX| rRt j | � n i | | 6| d <| | d <| r�d j | � n d j |
� | d <| S( u�
The service watcher, called to invoke the watch command.
When called, it will restart or reload the named service.
.. note::
This state exists to support special handling of the ``watch``
:ref:`requisite <requisites>`. It should not be called directly.
Parameters for this function should be set by the watching service.
(i.e. ``service.running``)
name
The name of the init or rc script used to manage the service
sfun
The original function which triggered the mod_watch call
(`service.running`, for example).
sig
The string to search for when looking for the service process with ps
reload
When set, reload the service instead of restarting it.
(i.e. ``service nginx reload``)
full_restart
Perform a full stop/start of a service by passing ``--full-restart``.
This option is ignored if ``reload`` is set and is supported by only a few
:py:func:`service modules <salt.modules.service>`.
force
Use service.force_reload instead of reload (needs reload to be set to True)
init_delay
Add a sleep command (in seconds) before the service is restarted/reloaded
u nameu changesu resultu u commentu deadu stopu pedu service.statusu service.stopu Service is already {0}u runningu service.reloadu service.force_reloadu forcefully reloadu reloadu service.full_restartu
fully restartu service.restartu restartu
service.startu startu edu' Unable to trigger watch for service.{0}u testu Service is set to be {0}u warningsu Service {0}u Failed to {0} the serviceN(
R R R R R R R R7 R8 R R R9 R: ( R t sfunR< t reloadt full_restartR= t forceR R t past_participlet verbR t func_kwargsR R! R" ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt mod_watchE sn ,
( u no_blocku unmasku unmask_runtime(" t __doc__t
__future__R R R R9 t salt.utils.dataR' t salt.utils.platformt salt.utils.argsR R
t salt.exceptionsR t salt.extR R R R R R R R& R- R R R RG RI RJ RK RO R3 RX ( ( ( s7 /usr/lib/python2.7/site-packages/salt/states/service.pyt <module>; sD f ` � � U D
Mini Shell