Module Expr Str ImportFrom alias Import alias Import alias Import alias Import alias identifier ImportFrom alias Assign NameStore Dict Str Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Str FunctionDef arguments args defaults body Expr Str If CompareEq SubscriptLoad NameLoad Index Str Str body Return NameLoad Return TupleLoad NameLoad Str decorator_list FunctionDef arguments args defaults body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str If UnaryOpNot NameLoad body Raise NameLoad Return NameLoad decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad Str attr Call NameLoad For NameStore Call AttributeLoad Call SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad attr body If Call AttributeLoad NameLoad attr Call AttributeLoad Str attr AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Return NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If UnaryOpNot Call NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad Return NameLoad Assign NameStore Call AttributeLoad Str attr Call NameLoad NameLoad For NameStore Call AttributeLoad Call SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad attr body If CompareNotIn Str NameLoad body Continue Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr Str Num Return NameLoad Return NameLoad decorator_list FunctionDef arguments args defaults body Expr Str Assign NameStore ListLoad Assign NameStore Call NameLoad For NameStore Call AttributeLoad Call SubscriptLoad NameLoad Index Str Call AttributeLoad Str attr NameLoad attr body Expr Call AttributeLoad NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad For NameStore Call NameLoad body If CompareIn NameLoad NameLoad body Continue If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad Str attr NameLoad body Continue If Call NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Return Call NameLoad NameLoad decorator_list FunctionDef arguments args defaults body Expr Str Assign NameStore Call NameLoad Assign NameStore Call NameLoad Return Call NameLoad BinOpSub Call NameLoad NameLoad Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults kwarg body Expr Str If UnaryOpNot Call NameLoad NameLoad body Return NameLoad Assign NameStore Call NameLoad NameLoad If UnaryOpNot NameLoad body Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad Return NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str Call SubscriptLoad NameLoad Index Str Str keyword Str If UnaryOpNot NameLoad body Assign NameStore Str If BoolOpOr UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad Return NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Call AttributeLoad NameLoad attr Str Str Assign NameStore ListLoad Assign NameStore NameLoad If NameLoad body Assign NameStore Str orelse Assign NameStore Str If Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body With Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str NameStore body For NameStore NameLoad body If UnaryOpNot Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Continue Assign NameStore SubscriptLoad NameLoad Slice Call NameLoad SubscriptLoad Call AttributeLoad NameLoad attr Index Num Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad NameLoad NameLoad Assign NameStore NameLoad If UnaryOpNot NameLoad body If BoolOpAnd CompareGt Call NameLoad NameLoad Num CompareNotEq SubscriptLoad SubscriptLoad NameLoad Index Num Index Num Str body Assign SubscriptStore NameLoad Index Num Call AttributeLoad Str attr SubscriptLoad NameLoad Index Num Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad NameLoad With Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str NameStore body Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults kwarg body Expr Str Return Call NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults kwarg body Expr Str Return Call NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults kwarg body Expr Str If UnaryOpNot Call NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad Return NameLoad Assign NameStore Call AttributeLoad Str attr Call NameLoad NameLoad For NameStore Call AttributeLoad Call SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad attr body If CompareNotIn Str NameLoad body Continue Assign TupleStore NameStore NameStore NameStore Call AttributeLoad NameLoad attr Str Num Return CompareIn Call AttributeLoad NameLoad attr TupleLoad Str Str Str Str Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return UnaryOpNot Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return CompareIn NameLoad Call NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return CompareNotIn NameLoad Call NameLoad decorator_list FunctionDef arguments args defaults body Expr Str Assign NameStore ListLoad Assign NameStore Call NameLoad For NameStore Call AttributeLoad Call SubscriptLoad NameLoad Index Str Call AttributeLoad Str attr NameLoad attr body If UnaryOpNot Call AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad Return Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad Str attr Call NameLoad NameLoad Return UnaryOpNot Call SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad Str attr Call NameLoad NameLoad Return UnaryOpNot Call SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad Str attr Call NameLoad NameLoad Return UnaryOpNot Call SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad Str attr Call NameLoad NameLoad Return UnaryOpNot Call SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str If NameLoad body Return Call NameLoad Call SubscriptLoad NameLoad Index Str NameLoad Assign NameStore Call AttributeLoad Str attr Call NameLoad NameLoad Return UnaryOpNot Call SubscriptLoad NameLoad Index Str NameLoad keyword NameLoad decorator_list
N/A N/A 
The service module for FreeBSD

.. important::
    If you feel that Salt should be using this module to manage services on a
    minion, and it is using a different module (or gives an error similar to
    *'service.start' is not available*), see :ref:`here
    <module-provider-override>`.
 __future__ absolute_import N/A logging N/A os N/A salt.utils N/A salt.utils.decorators decorators salt.exceptions CommandNotFoundError N/A __func_alias__ N/A reload_ reload N/A log N/A N/A logging getLogger __name__ N/A __virtualname__ service __virtual__ N/A N/A N/A N/A N/A 
    Only work on FreeBSD
     N/A N/A N/A __grains__ N/A os FreeBSD N/A N/A __virtualname__ N/A N/A False The freebsdservice execution module cannot be loaded: only available on FreeBSD systems. N/A _cmd N/A N/A N/A N/A N/A 
    Return full path to service command
     N/A service N/A N/A N/A salt utils which service N/A N/A service N/A N/A CommandNotFoundError N/A service N/A N/A decorators memoize _get_rcscript N/A N/A name N/A N/A N/A 
    Return full path to service rc script
     N/A cmd N/A N/A {0} -r format N/A _cmd N/A line N/A N/A N/A N/A __salt__ N/A cmd.run_stdout cmd python_shell False splitlines N/A N/A N/A N/A line endswith N/A N/A {0}{1} format N/A N/A os path sep name N/A N/A line N/A None N/A _get_rcvar N/A N/A name N/A N/A N/A 
    Return rcvar
     N/A N/A N/A available name N/A N/A N/A N/A log error N/A N/A Service {0} not found format name N/A False N/A cmd N/A N/A {0} {1} rcvar format N/A _cmd name N/A line N/A N/A N/A N/A __salt__ N/A cmd.run_stdout cmd python_shell False splitlines N/A N/A N/A _enable=" line N/A N/A N/A N/A rcvar _ N/A N/A line split = 1 N/A rcvar N/A None N/A get_enabled N/A N/A N/A N/A N/A 
    Return what services are set to run on boot

    CLI Example:

    .. code-block:: bash

        salt '*' service.get_enabled
     N/A ret N/A N/A service N/A _cmd N/A svc N/A N/A N/A N/A __salt__ N/A cmd.run N/A N/A {0} -e format service splitlines N/A N/A N/A N/A ret append N/A N/A N/A os path basename svc N/A svc N/A get_all N/A N/A N/A svc ret N/A N/A N/A N/A N/A N/A N/A os path exists N/A N/A /etc/rc.conf.d/{0} format svc N/A N/A N/A N/A enabled svc N/A N/A N/A N/A ret append svc N/A N/A sorted ret N/A get_disabled N/A N/A N/A N/A N/A 
    Return what services are available but not enabled to start at boot

    CLI Example:

    .. code-block:: bash

        salt '*' service.get_disabled
     N/A en_ N/A get_enabled N/A all_ N/A get_all N/A N/A sorted N/A N/A set all_ N/A set en_ N/A _switch N/A N/A name on N/A kwargs N/A N/A 
    Switch on/off service start at boot.
     N/A N/A N/A available name N/A N/A False N/A rcvar N/A _get_rcvar name N/A N/A rcvar N/A N/A N/A N/A log error N/A N/A rcvar for service {0} not found format name N/A False N/A config N/A N/A kwargs get config N/A N/A __salt__ N/A config.option service.config default /etc/rc.conf N/A N/A config N/A N/A rcdir /etc/rc.conf.d N/A N/A N/A N/A N/A N/A os path exists rcdir N/A N/A N/A N/A os path isdir rcdir N/A N/A N/A N/A log error N/A N/A {0} not exists format rcdir N/A False N/A config N/A N/A N/A os path join rcdir N/A N/A rcvar replace _enable N/A nlines N/A N/A edited False N/A on N/A N/A val YES N/A N/A val NO N/A N/A N/A N/A os path exists config N/A N/A N/A N/A N/A salt utils fopen config r ifile N/A N/A line ifile N/A N/A N/A N/A N/A line startswith N/A N/A {0}= format rcvar N/A N/A N/A N/A nlines append line N/A N/A rest N/A line N/A N/A len N/A N/A N/A line split N/A 0 N/A N/A N/A nlines append N/A N/A {0}="{1}"{2} format rcvar val rest N/A edited True N/A N/A edited N/A N/A N/A N/A N/A len nlines 1 N/A N/A N/A nlines N/A -1 N/A -1 N/A N/A N/A nlines N/A -1 N/A N/A {0}
 format N/A nlines N/A -1 N/A N/A N/A nlines append N/A N/A {0}="{1}"
 format rcvar val N/A N/A N/A N/A salt utils fopen config w ofile N/A N/A N/A N/A ofile writelines nlines N/A True N/A enable N/A N/A name N/A kwargs N/A N/A 
    Enable the named service to start at boot

    name
        service name

    config : /etc/rc.conf
        Config file for managing service. If config value is
        empty string, then /etc/rc.conf.d/<service> used.
        See man rc.conf(5) for details.

        Also service.config variable can be used to change default.

    CLI Example:

    .. code-block:: bash

        salt '*' service.enable <service name>
     N/A N/A _switch name True kwargs N/A disable N/A N/A name N/A kwargs N/A N/A 
    Disable the named service to start at boot

    Arguments the same as for enable()

    CLI Example:

    .. code-block:: bash

        salt '*' service.disable <service name>
     N/A N/A _switch name False kwargs N/A enabled N/A N/A name N/A kwargs N/A N/A 
    Return True if the named service is enabled, false otherwise

    name
        Service name

    CLI Example:

    .. code-block:: bash

        salt '*' service.enabled <service name>
     N/A N/A N/A available name N/A N/A N/A N/A log error N/A N/A Service {0} not found format name N/A False N/A cmd N/A N/A {0} {1} rcvar format N/A _cmd name N/A line N/A N/A N/A N/A __salt__ N/A cmd.run_stdout cmd python_shell False splitlines N/A N/A N/A _enable=" line N/A N/A N/A N/A _ state _ N/A N/A line split " 2 N/A N/A N/A N/A state lower N/A yes true on 1 N/A False N/A disabled N/A N/A name N/A N/A N/A 
    Return True if the named service is enabled, false otherwise

    CLI Example:

    .. code-block:: bash

        salt '*' service.disabled <service name>
     N/A N/A N/A enabled name N/A available N/A N/A name N/A N/A N/A 
    Check that the given service is available.

    CLI Example:

    .. code-block:: bash

        salt '*' service.available sshd
     N/A N/A name N/A get_all N/A missing N/A N/A name N/A N/A N/A 
    The inverse of service.available.
    Returns ``True`` if the specified service is not available, otherwise returns
    ``False``.

    CLI Example:

    .. code-block:: bash

        salt '*' service.missing sshd
     N/A N/A name N/A get_all N/A get_all N/A N/A N/A N/A N/A 
    Return a list of all available services

    CLI Example:

    .. code-block:: bash

        salt '*' service.get_all
     N/A ret N/A N/A service N/A _cmd N/A srv N/A N/A N/A N/A __salt__ N/A cmd.run N/A N/A {0} -l format service splitlines N/A N/A N/A N/A N/A srv isupper N/A N/A N/A N/A ret append srv N/A N/A sorted ret N/A start N/A N/A name N/A N/A N/A 
    Start the specified service

    CLI Example:

    .. code-block:: bash

        salt '*' service.start <service name>
     N/A cmd N/A N/A {0} {1} onestart format N/A _cmd name N/A N/A N/A N/A __salt__ N/A cmd.retcode cmd python_shell False N/A stop N/A N/A name N/A N/A N/A 
    Stop the specified service

    CLI Example:

    .. code-block:: bash

        salt '*' service.stop <service name>
     N/A cmd N/A N/A {0} {1} onestop format N/A _cmd name N/A N/A N/A N/A __salt__ N/A cmd.retcode cmd python_shell False N/A restart N/A N/A name N/A N/A N/A 
    Restart the named service

    CLI Example:

    .. code-block:: bash

        salt '*' service.restart <service name>
     N/A cmd N/A N/A {0} {1} onerestart format N/A _cmd name N/A N/A N/A N/A __salt__ N/A cmd.retcode cmd python_shell False N/A reload_ N/A N/A name N/A N/A N/A 
    Restart the named service

    CLI Example:

    .. code-block:: bash

        salt '*' service.reload <service name>
     N/A cmd N/A N/A {0} {1} onereload format N/A _cmd name N/A N/A N/A N/A __salt__ N/A cmd.retcode cmd python_shell False N/A status N/A N/A name sig N/A None N/A N/A 
    Return the status for a service (True or False).

    name
        Name of service

    CLI Example:

    .. code-block:: bash

        salt '*' service.status <service name>
     N/A sig N/A N/A N/A bool N/A N/A __salt__ N/A status.pid sig N/A cmd N/A N/A {0} {1} onestatus format N/A _cmd name N/A N/A N/A N/A __salt__ N/A cmd.retcode cmd python_shell False N/A