update.status
=============

Update status.

.. 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>UpdateStatus</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_code"> <div class="card"> <div class="card-header" id="headingReturn_value_code"> <h2 class="mb-0"> <button aria-controls="Return_value_code" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_code" data-toggle="collapse" onclick="setAnchor('#Return_value_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_code" class="collapse property-definition-div" data-parent="#accordionReturn_value_code" id="Return_value_code"> <div class="card-body pl-5"> <h4>Code</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>Status code:<br/> * NORMAL - normal status, see <code>status</code> dictionary for details.<br/> * ERROR - an error occurred, see <code>error</code> for details.<br/> * REBOOT<em>REQUIRED - system update was already applied, system reboot is required.<br/> * HA</em>UNAVAILABLE - HA is configured but currently unavailable.</p> </span><div class="enum-value" id="Return_value_code_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"NORMAL"</li><li class="list-group-item enum-item">"ERROR"</li><li class="list-group-item enum-item">"REBOOT_REQUIRED"</li><li class="list-group-item enum-item">"HA_UNAVAILABLE"</li></ul> </div> </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"> <br/> <div class="any-of-value" id="Return_value_status_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_status_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_status_anyOf_i0" id="Return_value_status_anyOf_i0" onclick="setAnchor('#Return_value_status_anyOf_i0')" role="tab">UpdateStatusStatus</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_status_anyOf_i1" id="Return_value_status_anyOf_i1" onclick="setAnchor('#Return_value_status_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_status_anyOf_i0" role="tabpanel"> <h4>UpdateStatusStatus</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_status_anyOf_i0_current_version"> <div class="card"> <div class="card-header" id="headingReturn_value_status_anyOf_i0_current_version"> <h2 class="mb-0"> <button aria-controls="Return_value_status_anyOf_i0_current_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_anyOf_i0_current_version" data-toggle="collapse" onclick="setAnchor('#Return_value_status_anyOf_i0_current_version')" type="button"><span class="property-name">current_version</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_anyOf_i0_current_version" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_anyOf_i0_current_version" id="Return_value_status_anyOf_i0_current_version"> <div class="card-body pl-5"> <h4>UpdateStatusCurrentVersion</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>Currently running system version information.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_status_anyOf_i0_current_version_train"> <div class="card"> <div class="card-header" id="headingReturn_value_status_anyOf_i0_current_version_train"> <h2 class="mb-0"> <button aria-controls="Return_value_status_anyOf_i0_current_version_train" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_anyOf_i0_current_version_train" data-toggle="collapse" onclick="setAnchor('#Return_value_status_anyOf_i0_current_version_train')" type="button"><span class="property-name">train</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_anyOf_i0_current_version_train" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_anyOf_i0_current_version_train" id="Return_value_status_anyOf_i0_current_version_train"> <div class="card-body pl-5"> <h4>Train</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Train name.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_status_anyOf_i0_current_version_profile"> <div class="card"> <div class="card-header" id="headingReturn_value_status_anyOf_i0_current_version_profile"> <h2 class="mb-0"> <button aria-controls="Return_value_status_anyOf_i0_current_version_profile" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_anyOf_i0_current_version_profile" data-toggle="collapse" onclick="setAnchor('#Return_value_status_anyOf_i0_current_version_profile')" type="button"><span class="property-name">profile</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_anyOf_i0_current_version_profile" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_anyOf_i0_current_version_profile" id="Return_value_status_anyOf_i0_current_version_profile"> <div class="card-body pl-5"> <h4>Profile</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Update profile assigned for the version.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_status_anyOf_i0_current_version_matches_profile"> <div class="card"> <div class="card-header" id="headingReturn_value_status_anyOf_i0_current_version_matches_profile"> <h2 class="mb-0"> <button aria-controls="Return_value_status_anyOf_i0_current_version_matches_profile" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_anyOf_i0_current_version_matches_profile" data-toggle="collapse" onclick="setAnchor('#Return_value_status_anyOf_i0_current_version_matches_profile')" type="button"><span class="property-name">matches_profile</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_anyOf_i0_current_version_matches_profile" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_anyOf_i0_current_version_matches_profile" id="Return_value_status_anyOf_i0_current_version_matches_profile"> <div class="card-body pl-5"> <h4>Matches Profile</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Whether the system version running matches the configured update profile.</p> </span> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_status_anyOf_i0_new_version"> <div class="card"> <div class="card-header" id="headingReturn_value_status_anyOf_i0_new_version"> <h2 class="mb-0"> <button aria-controls="Return_value_status_anyOf_i0_new_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_anyOf_i0_new_version" data-toggle="collapse" onclick="setAnchor('#Return_value_status_anyOf_i0_new_version')" type="button"><span class="property-name">new_version</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_anyOf_i0_new_version" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_anyOf_i0_new_version" id="Return_value_status_anyOf_i0_new_version"> <div class="card-body pl-5"> <br/> <span class="description"><p>New system version information (or <code>null</code> if no new system version is available).</p> </span><div class="any-of-value" id="Return_value_status_anyOf_i0_new_version_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_status_anyOf_i0_new_version_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_status_anyOf_i0_new_version_anyOf_i0" id="Return_value_status_anyOf_i0_new_version_anyOf_i0" onclick="setAnchor('#Return_value_status_anyOf_i0_new_version_anyOf_i0')" role="tab">UpdateStatusNewVersion</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_status_anyOf_i0_new_version_anyOf_i1" id="Return_value_status_anyOf_i0_new_version_anyOf_i1" onclick="setAnchor('#Return_value_status_anyOf_i0_new_version_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_status_anyOf_i0_new_version_anyOf_i0" role="tabpanel"> <h4>UpdateStatusNewVersion</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_status_anyOf_i0_new_version_anyOf_i0_version"> <div class="card"> <div class="card-header" id="headingReturn_value_status_anyOf_i0_new_version_anyOf_i0_version"> <h2 class="mb-0"> <button aria-controls="Return_value_status_anyOf_i0_new_version_anyOf_i0_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_anyOf_i0_new_version_anyOf_i0_version" data-toggle="collapse" onclick="setAnchor('#Return_value_status_anyOf_i0_new_version_anyOf_i0_version')" type="button"><span class="property-name">version</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_anyOf_i0_new_version_anyOf_i0_version" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_anyOf_i0_new_version_anyOf_i0_version" id="Return_value_status_anyOf_i0_new_version_anyOf_i0_version"> <div class="card-body pl-5"> <h4>Version</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Newly available version number.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_status_anyOf_i0_new_version_anyOf_i0_manifest"> <div class="card"> <div class="card-header" id="headingReturn_value_status_anyOf_i0_new_version_anyOf_i0_manifest"> <h2 class="mb-0"> <button aria-controls="Return_value_status_anyOf_i0_new_version_anyOf_i0_manifest" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_anyOf_i0_new_version_anyOf_i0_manifest" data-toggle="collapse" onclick="setAnchor('#Return_value_status_anyOf_i0_new_version_anyOf_i0_manifest')" type="button"><span class="property-name">manifest</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_anyOf_i0_new_version_anyOf_i0_manifest" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_anyOf_i0_new_version_anyOf_i0_manifest" id="Return_value_status_anyOf_i0_new_version_anyOf_i0_manifest"> <div class="card-body pl-5"> <h4>Manifest</h4><span class="badge badge-dark value-type">Type: object</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_status_anyOf_i0_new_version_anyOf_i0_release_notes_url"> <div class="card"> <div class="card-header" id="headingReturn_value_status_anyOf_i0_new_version_anyOf_i0_release_notes_url"> <h2 class="mb-0"> <button aria-controls="Return_value_status_anyOf_i0_new_version_anyOf_i0_release_notes_url" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_anyOf_i0_new_version_anyOf_i0_release_notes_url" data-toggle="collapse" onclick="setAnchor('#Return_value_status_anyOf_i0_new_version_anyOf_i0_release_notes_url')" type="button"><span class="property-name">release_notes_url</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_anyOf_i0_new_version_anyOf_i0_release_notes_url" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_anyOf_i0_new_version_anyOf_i0_release_notes_url" id="Return_value_status_anyOf_i0_new_version_anyOf_i0_release_notes_url"> <div class="card-body pl-5"> <h4>Release Notes Url</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Release notes URL.</p> </span> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_status_anyOf_i0_new_version_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_status_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_error"> <div class="card"> <div class="card-header" id="headingReturn_value_error"> <h2 class="mb-0"> <button aria-controls="Return_value_error" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_error" data-toggle="collapse" onclick="setAnchor('#Return_value_error')" type="button"><span class="property-name">error</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_error" class="collapse property-definition-div" data-parent="#accordionReturn_value_error" id="Return_value_error"> <div class="card-body pl-5"> <h4>Error</h4><br/> <div class="any-of-value" id="Return_value_error_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_error_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_error_anyOf_i0" id="Return_value_error_anyOf_i0" onclick="setAnchor('#Return_value_error_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_error_anyOf_i1" id="Return_value_error_anyOf_i1" onclick="setAnchor('#Return_value_error_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_error_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_error_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_update_download_progress"> <div class="card"> <div class="card-header" id="headingReturn_value_update_download_progress"> <h2 class="mb-0"> <button aria-controls="Return_value_update_download_progress" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_update_download_progress" data-toggle="collapse" onclick="setAnchor('#Return_value_update_download_progress')" type="button"><span class="property-name">update_download_progress</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_update_download_progress" class="collapse property-definition-div" data-parent="#accordionReturn_value_update_download_progress" id="Return_value_update_download_progress"> <div class="card-body pl-5"> <br/> <span class="description"><p>Current update download progress.</p> </span><div class="any-of-value" id="Return_value_update_download_progress_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_update_download_progress_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_update_download_progress_anyOf_i0" id="Return_value_update_download_progress_anyOf_i0" onclick="setAnchor('#Return_value_update_download_progress_anyOf_i0')" role="tab">UpdateDownloadProgress</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_update_download_progress_anyOf_i1" id="Return_value_update_download_progress_anyOf_i1" onclick="setAnchor('#Return_value_update_download_progress_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_update_download_progress_anyOf_i0" role="tabpanel"> <h4>UpdateDownloadProgress</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_update_download_progress_anyOf_i0_percent"> <div class="card"> <div class="card-header" id="headingReturn_value_update_download_progress_anyOf_i0_percent"> <h2 class="mb-0"> <button aria-controls="Return_value_update_download_progress_anyOf_i0_percent" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_update_download_progress_anyOf_i0_percent" data-toggle="collapse" onclick="setAnchor('#Return_value_update_download_progress_anyOf_i0_percent')" type="button"><span class="property-name">percent</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_update_download_progress_anyOf_i0_percent" class="collapse property-definition-div" data-parent="#accordionReturn_value_update_download_progress_anyOf_i0_percent" id="Return_value_update_download_progress_anyOf_i0_percent"> <div class="card-body pl-5"> <h4>Percent</h4><span class="badge badge-dark value-type">Type: number</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_update_download_progress_anyOf_i0_description"> <div class="card"> <div class="card-header" id="headingReturn_value_update_download_progress_anyOf_i0_description"> <h2 class="mb-0"> <button aria-controls="Return_value_update_download_progress_anyOf_i0_description" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_update_download_progress_anyOf_i0_description" data-toggle="collapse" onclick="setAnchor('#Return_value_update_download_progress_anyOf_i0_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_update_download_progress_anyOf_i0_description" class="collapse property-definition-div" data-parent="#accordionReturn_value_update_download_progress_anyOf_i0_description" id="Return_value_update_download_progress_anyOf_i0_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><div class="tab-pane fade card-body" id="tab-pane_Return_value_update_download_progress_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><br><br>

*Required roles:* SYSTEM_UPDATE_READ