service.control
===============

Perform the control operation given by ``verb`` (``START``, ``STOP``, ``RESTART``, or ``RELOAD``) on the system service named ``service``. This is the general entry point for managing the running state of a service; the configured enable-on-boot setting is changed separately via :doc:`service.update <api_methods_service.update>`.

The result reflects whether the service is running after a ``START``, ``RESTART``, or ``RELOAD``, or whether it was successfully stopped for a ``STOP``. By default failures are reported by returning ``false`` rather than raising; set ``options.silent`` to ``false`` to receive an error instead.

This method is a job.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: verb</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>verb</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>The service operation to perform.</p>
    </span><div class="enum-value" id="Call_parameters_items_i0_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"START"</li><li class="list-group-item enum-item">"STOP"</li><li class="list-group-item enum-item">"RESTART"</li><li class="list-group-item enum-item">"RELOAD"</li></ul>
    </div>
    </div>
    </div>
    <h5>Parameter 2: service</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>service</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the service to control.</p>
    </span>
    </div>
    </div>
    <h5>Parameter 3: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i2">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Options for controlling the service operation behavior.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i2_ha_propagate">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i2_ha_propagate">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i2_ha_propagate" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i2_ha_propagate" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i2_ha_propagate')" type="button"><span class="property-name">ha_propagate</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i2_ha_propagate" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i2_ha_propagate" id="Call_parameters_items_i2_ha_propagate">
    <div class="card-body pl-5">
    <h4>Ha Propagate</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Whether to propagate the service operation to the HA peer in a high-availability setup.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i2_silent">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i2_silent">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i2_silent" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i2_silent" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i2_silent')" type="button"><span class="property-name">silent</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i2_silent" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i2_silent" id="Call_parameters_items_i2_silent">
    <div class="card-body pl-5">
    <h4>Silent</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Return <code>false</code> instead of an error if the operation fails.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i2_timeout">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i2_timeout">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i2_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i2_timeout" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i2_timeout')" type="button"><span class="property-name">timeout</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i2_timeout" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i2_timeout" id="Call_parameters_items_i2_timeout">
    <div class="card-body pl-5">
    <h4>Timeout</h4> <span class="badge badge-success default-value">Default: 120</span><br/>
    <span class="description"><p>Maximum time in seconds to wait for the service operation to complete. <code>null</code> for no timeout.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i2_timeout_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i2_timeout_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i2_timeout_anyOf_i0" id="Call_parameters_items_i2_timeout_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i2_timeout_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i2_timeout_anyOf_i1" id="Call_parameters_items_i2_timeout_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i2_timeout_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i2_timeout_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i2_timeout_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>Result</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>For "START", "RESTART", "RELOAD", indicate whether the service is running after performing the operation. For "STOP", indicate whether the service was successfully stopped.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SERVICE_WRITE | SHARING_FTP_WRITE | SHARING_ISCSI_WRITE | SHARING_NFS_WRITE | SHARING_NVME_TARGET_WRITE | SHARING_S3_WRITE | SHARING_SMB_WRITE