update.check_available
======================

Checks if there is an update available from update server.

.. examples(websocket)::

  Check available update using default train:

    :::javascript {
        "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "update.check_available" }

.. 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: attrs</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>attrs</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="accordionCall_parameters_items_i0_train"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_train"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_train" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_train" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_train')" type="button"><span class="property-name">train</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_train" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_train" id="Call_parameters_items_i0_train"> <div class="card-body pl-5"> <h4>Train</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i0_train_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_train_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_train_anyOf_i0" id="Call_parameters_items_i0_train_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_train_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_i0_train_anyOf_i1" id="Call_parameters_items_i0_train_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_train_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_i0_train_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_Call_parameters_items_i0_train_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><br/> <div class="one-of-value" id="Return_value_oneOf"><h2 class="handle"> <label>One of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_oneOf_oneOf" role="tablist"><li class="nav-item"> <a class="nav-link active oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_oneOf_i0" id="Return_value_oneOf_i0" onclick="setAnchor('#Return_value_oneOf_i0')" role="tab">UpdateStatusAvailable</a> </li><li class="nav-item"> <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_oneOf_i1" id="Return_value_oneOf_i1" onclick="setAnchor('#Return_value_oneOf_i1')" role="tab">UpdateStatusUnavailable</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_oneOf_i0" role="tabpanel"> <h4>UpdateStatusAvailable</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_oneOf_i0_status"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_status"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_status" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_status" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_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_oneOf_i0_status" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_status" id="Return_value_oneOf_i0_status"> <div class="card-body pl-5"> <h4>Status</h4><span class="badge badge-dark value-type">Type: const</span><br/> <span class="description"><p>An update is available.</p> </span><div class="enum-value" id="Return_value_oneOf_i0_status_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"AVAILABLE"</li></ul> </div><span class="const-value" id="Return_value_oneOf_i0_status_const">Specific value: <code>"AVAILABLE"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_changes"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changes"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changes" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changes')" type="button"><span class="property-name">changes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_changes" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changes" id="Return_value_oneOf_i0_changes"> <div class="card-body pl-5"> <h4>Changes</h4><span class="badge badge-dark value-type">Type: array of object</span><br/> <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_oneOf_i0_changes_items"> <h4>UpdateStatusAvailableChanges</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_oneOf_i0_changes_items_operation"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changes_items_operation"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changes_items_operation" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changes_items_operation" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changes_items_operation')" type="button"><span class="property-name">operation</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_changes_items_operation" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changes_items_operation" id="Return_value_oneOf_i0_changes_items_operation"> <div class="card-body pl-5"> <h4>Operation</h4><span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Return_value_oneOf_i0_changes_items_operation_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"upgrade"</li></ul> </div><span class="const-value" id="Return_value_oneOf_i0_changes_items_operation_const">Specific value: <code>"upgrade"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_changes_items_old"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changes_items_old"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changes_items_old" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changes_items_old" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changes_items_old')" type="button"><span class="property-name">old</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_changes_items_old" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changes_items_old" id="Return_value_oneOf_i0_changes_items_old"> <div class="card-body pl-5"> <h4>UpdateStatusAvailableChangesVersion</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_oneOf_i0_changes_items_old_name"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changes_items_old_name"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changes_items_old_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changes_items_old_name" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changes_items_old_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_changes_items_old_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changes_items_old_name" id="Return_value_oneOf_i0_changes_items_old_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Return_value_oneOf_i0_changes_items_old_name_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"TrueNAS"</li></ul> </div><span class="const-value" id="Return_value_oneOf_i0_changes_items_old_name_const">Specific value: <code>"TrueNAS"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_changes_items_old_version"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changes_items_old_version"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changes_items_old_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changes_items_old_version" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changes_items_old_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_oneOf_i0_changes_items_old_version" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changes_items_old_version" id="Return_value_oneOf_i0_changes_items_old_version"> <div class="card-body pl-5"> <h4>Version</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_changes_items_new"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changes_items_new"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changes_items_new" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changes_items_new" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changes_items_new')" type="button"><span class="property-name">new</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_changes_items_new" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changes_items_new" id="Return_value_oneOf_i0_changes_items_new"> <div class="card-body pl-5"> <h4>UpdateStatusAvailableChangesVersion</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_oneOf_i0_changes_items_new_name"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changes_items_new_name"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changes_items_new_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changes_items_new_name" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changes_items_new_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_changes_items_new_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changes_items_new_name" id="Return_value_oneOf_i0_changes_items_new_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Return_value_oneOf_i0_changes_items_new_name_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"TrueNAS"</li></ul> </div><span class="const-value" id="Return_value_oneOf_i0_changes_items_new_name_const">Specific value: <code>"TrueNAS"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_changes_items_new_version"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changes_items_new_version"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changes_items_new_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changes_items_new_version" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changes_items_new_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_oneOf_i0_changes_items_new_version" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changes_items_new_version" id="Return_value_oneOf_i0_changes_items_new_version"> <div class="card-body pl-5"> <h4>Version</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_notice"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_notice"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_notice" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_notice" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_notice')" type="button"><span class="property-name">notice</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_notice" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_notice" id="Return_value_oneOf_i0_notice"> <div class="card-body pl-5"> <h4>Notice</h4><span class="badge badge-dark value-type">Type: null</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_notes"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_notes"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_notes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_notes" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_notes')" type="button"><span class="property-name">notes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_notes" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_notes" id="Return_value_oneOf_i0_notes"> <div class="card-body pl-5"> <h4>Notes</h4><span class="badge badge-dark value-type">Type: null</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_release_notes_url"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_release_notes_url"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_release_notes_url" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_release_notes_url" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_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_oneOf_i0_release_notes_url" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_release_notes_url" id="Return_value_oneOf_i0_release_notes_url"> <div class="card-body pl-5"> <h4>Release Notes Url</h4><br/> <div class="any-of-value" id="Return_value_oneOf_i0_release_notes_url_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_oneOf_i0_release_notes_url_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_oneOf_i0_release_notes_url_anyOf_i0" id="Return_value_oneOf_i0_release_notes_url_anyOf_i0" onclick="setAnchor('#Return_value_oneOf_i0_release_notes_url_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_oneOf_i0_release_notes_url_anyOf_i1" id="Return_value_oneOf_i0_release_notes_url_anyOf_i1" onclick="setAnchor('#Return_value_oneOf_i0_release_notes_url_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_oneOf_i0_release_notes_url_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_oneOf_i0_release_notes_url_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_oneOf_i0_changelog"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_changelog"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_changelog" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_changelog" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_changelog')" type="button"><span class="property-name">changelog</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_changelog" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_changelog" id="Return_value_oneOf_i0_changelog"> <div class="card-body pl-5"> <h4>Changelog</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_version"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_version"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_version" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_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_oneOf_i0_version" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_version" id="Return_value_oneOf_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>Version string of the available update version.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_filename"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_filename"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_filename" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_filename" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_filename')" type="button"><span class="property-name">filename</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_filename" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_filename" id="Return_value_oneOf_i0_filename"> <div class="card-body pl-5"> <h4>Filename</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Name of the update file available for download.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_filesize"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_filesize"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_filesize" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_filesize" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_filesize')" type="button"><span class="property-name">filesize</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_filesize" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_filesize" id="Return_value_oneOf_i0_filesize"> <div class="card-body pl-5"> <h4>Filesize</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Size of the update file in bytes.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_oneOf_i0_checksum"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i0_checksum"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i0_checksum" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i0_checksum" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i0_checksum')" type="button"><span class="property-name">checksum</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_oneOf_i0_checksum" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i0_checksum" id="Return_value_oneOf_i0_checksum"> <div class="card-body pl-5"> <h4>Checksum</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_oneOf_i1" role="tabpanel"> <h4>UpdateStatusUnavailable</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_oneOf_i1_status"> <div class="card"> <div class="card-header" id="headingReturn_value_oneOf_i1_status"> <h2 class="mb-0"> <button aria-controls="Return_value_oneOf_i1_status" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_oneOf_i1_status" data-toggle="collapse" onclick="setAnchor('#Return_value_oneOf_i1_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_oneOf_i1_status" class="collapse property-definition-div" data-parent="#accordionReturn_value_oneOf_i1_status" id="Return_value_oneOf_i1_status"> <div class="card-body pl-5"> <h4>Status</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p><code>REBOOT_REQUIRED</code>: An update has already been applied.<br/> <code>UNAVAILABLE</code>: No update available.<br/> <code>HA_UNAVAILABLE</code>: HA is non-functional.</p> </span><div class="enum-value" id="Return_value_oneOf_i1_status_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"REBOOT_REQUIRED"</li><li class="list-group-item enum-item">"HA_UNAVAILABLE"</li><li class="list-group-item enum-item">"UNAVAILABLE"</li></ul> </div> </div> </div> </div> </div> </div></div></div> </div> </div> </div> </div> </div><br><br>

*Required roles:* SYSTEM_UPDATE_READ