vm.status
=========

Get the status of `id` VM.

Returns a dict: - state, RUNNING / STOPPED / SUSPENDED - pid, process id if RUNNING

.. 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: id</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>ID of the virtual machine to get status for.</p>
    </span>
    </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>VMStatus</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Current status and runtime information for the virtual machine.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_state">
    <div class="card">
    <div class="card-header" id="headingReturn_value_state">
    <h2 class="mb-0">
    <button aria-controls="Return_value_state" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_state" data-toggle="collapse" onclick="setAnchor('#Return_value_state')" type="button"><span class="property-name">state</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_state" class="collapse property-definition-div" data-parent="#accordionReturn_value_state" id="Return_value_state">
    <div class="card-body pl-5">
    <h4>State</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "127.0.0.1"</span><br/>
    <span class="description"><p>Current state of the virtual machine.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_state_minLength">Must be at least <code>1</code> characters long</span></p>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Return_value_state_ex1"><div class="highlight"><pre><span></span><span class="s2">"RUNNING"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_state_ex2"><div class="highlight"><pre><span></span><span class="s2">"STOPPED"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_state_ex3"><div class="highlight"><pre><span></span><span class="s2">"SUSPENDED"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_pid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_pid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_pid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_pid" data-toggle="collapse" onclick="setAnchor('#Return_value_pid')" type="button"><span class="property-name">pid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_pid" class="collapse property-definition-div" data-parent="#accordionReturn_value_pid" id="Return_value_pid">
    <div class="card-body pl-5">
    <h4>Pid</h4><br/>
    <span class="description"><p>Process ID of the running VM. <code>null</code> if not running.</p>
    </span><div class="any-of-value" id="Return_value_pid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_pid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_pid_anyOf_i0" id="Return_value_pid_anyOf_i0" onclick="setAnchor('#Return_value_pid_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_pid_anyOf_i1" id="Return_value_pid_anyOf_i1" onclick="setAnchor('#Return_value_pid_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_Return_value_pid_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_Return_value_pid_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_domain_state">
    <div class="card">
    <div class="card-header" id="headingReturn_value_domain_state">
    <h2 class="mb-0">
    <button aria-controls="Return_value_domain_state" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_domain_state" data-toggle="collapse" onclick="setAnchor('#Return_value_domain_state')" type="button"><span class="property-name">domain_state</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_domain_state" class="collapse property-definition-div" data-parent="#accordionReturn_value_domain_state" id="Return_value_domain_state">
    <div class="card-body pl-5">
    <h4>Domain State</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Hypervisor-specific domain state.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_domain_state_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* VM_READ

