docker.status
=============

Returns the status of the docker service.

.. 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> </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>StatusResult</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_description"> <div class="card"> <div class="card-header" id="headingReturn_value_description"> <h2 class="mb-0"> <button aria-controls="Return_value_description" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_description" data-toggle="collapse" onclick="setAnchor('#Return_value_description')" type="button"><span class="property-name">description</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_description" class="collapse property-definition-div" data-parent="#accordionReturn_value_description" id="Return_value_description"> <div class="card-body pl-5"> <h4>Description</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_status"> <div class="card"> <div class="card-header" id="headingReturn_value_status"> <h2 class="mb-0"> <button aria-controls="Return_value_status" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status" data-toggle="collapse" onclick="setAnchor('#Return_value_status')" type="button"><span class="property-name">status</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status" class="collapse property-definition-div" data-parent="#accordionReturn_value_status" id="Return_value_status"> <div class="card-body pl-5"> <h4>Status</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <div class="enum-value" id="Return_value_status_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"PENDING"</li><li class="list-group-item enum-item">"RUNNING"</li><li class="list-group-item enum-item">"STOPPED"</li><li class="list-group-item enum-item">"INITIALIZING"</li><li class="list-group-item enum-item">"STOPPING"</li><li class="list-group-item enum-item">"UNCONFIGURED"</li><li class="list-group-item enum-item">"FAILED"</li></ul> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* DOCKER_READ