system.reboot.info
==================

Return information about whether the system requires a reboot, including the current boot session identifier and the list of pending reasons a reboot is required (for example, a FIPS or STIG configuration change or a pending system upgrade). An empty list of reasons indicates no reboot is currently required.

The :doc:`system.reboot.info <api_methods_system.reboot.info>` event is emitted whenever this information changes.

.. 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>RebootInfo</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Information about the current boot session and reboot requirements.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_boot_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_boot_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_boot_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_boot_id" data-toggle="collapse" onclick="setAnchor('#Return_value_boot_id')" type="button"><span class="property-name">boot_id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_boot_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_boot_id" id="Return_value_boot_id">
    <div class="card-body pl-5">
    <h4>Boot Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Unique identifier for the current boot session.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_reboot_required_reasons">
    <div class="card">
    <div class="card-header" id="headingReturn_value_reboot_required_reasons">
    <h2 class="mb-0">
    <button aria-controls="Return_value_reboot_required_reasons" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_reboot_required_reasons" data-toggle="collapse" onclick="setAnchor('#Return_value_reboot_required_reasons')" type="button"><span class="property-name">reboot_required_reasons</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_reboot_required_reasons" class="collapse property-definition-div" data-parent="#accordionReturn_value_reboot_required_reasons" id="Return_value_reboot_required_reasons">
    <div class="card-body pl-5">
    <h4>Reboot Required Reasons</h4><span class="badge badge-dark value-type">Type: array of object</span><br/>
    <span class="description"><p>Array of reasons why a system reboot is required.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_reboot_required_reasons_items">
    <h4>RebootRequiredReason</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_reboot_required_reasons_items_code">
    <div class="card">
    <div class="card-header" id="headingReturn_value_reboot_required_reasons_items_code">
    <h2 class="mb-0">
    <button aria-controls="Return_value_reboot_required_reasons_items_code" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_reboot_required_reasons_items_code" data-toggle="collapse" onclick="setAnchor('#Return_value_reboot_required_reasons_items_code')" type="button"><span class="property-name">code</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_reboot_required_reasons_items_code" class="collapse property-definition-div" data-parent="#accordionReturn_value_reboot_required_reasons_items_code" id="Return_value_reboot_required_reasons_items_code">
    <div class="card-body pl-5">
    <h4>Code</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Code identifying the reason for required reboot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_reboot_required_reasons_items_reason">
    <div class="card">
    <div class="card-header" id="headingReturn_value_reboot_required_reasons_items_reason">
    <h2 class="mb-0">
    <button aria-controls="Return_value_reboot_required_reasons_items_reason" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_reboot_required_reasons_items_reason" data-toggle="collapse" onclick="setAnchor('#Return_value_reboot_required_reasons_items_reason')" type="button"><span class="property-name">reason</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_reboot_required_reasons_items_reason" class="collapse property-definition-div" data-parent="#accordionReturn_value_reboot_required_reasons_items_reason" id="Return_value_reboot_required_reasons_items_reason">
    <div class="card-body pl-5">
    <h4>Reason</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Human-readable description of why a reboot is required.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SYSTEM_GENERAL_READ

