update.get_pending
==================

Gets a list of packages already downloaded and ready to be applied.

.. 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: path</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>path</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i0_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_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_anyOf_i0" id="Call_parameters_items_i0_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_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_anyOf_i1" id="Call_parameters_items_i0_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_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_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_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 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><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_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_items_operation"> <div class="card"> <div class="card-header" id="headingReturn_value_items_operation"> <h2 class="mb-0"> <button aria-controls="Return_value_items_operation" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_operation" data-toggle="collapse" onclick="setAnchor('#Return_value_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_items_operation" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_operation" id="Return_value_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_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_items_operation_const">Specific value: <code>"upgrade"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_items_old"> <div class="card"> <div class="card-header" id="headingReturn_value_items_old"> <h2 class="mb-0"> <button aria-controls="Return_value_items_old" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_old" data-toggle="collapse" onclick="setAnchor('#Return_value_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_items_old" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_old" id="Return_value_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_items_old_name"> <div class="card"> <div class="card-header" id="headingReturn_value_items_old_name"> <h2 class="mb-0"> <button aria-controls="Return_value_items_old_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_old_name" data-toggle="collapse" onclick="setAnchor('#Return_value_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_items_old_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_old_name" id="Return_value_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_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_items_old_name_const">Specific value: <code>"TrueNAS"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_items_old_version"> <div class="card"> <div class="card-header" id="headingReturn_value_items_old_version"> <h2 class="mb-0"> <button aria-controls="Return_value_items_old_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_old_version" data-toggle="collapse" onclick="setAnchor('#Return_value_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_items_old_version" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_old_version" id="Return_value_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_items_new"> <div class="card"> <div class="card-header" id="headingReturn_value_items_new"> <h2 class="mb-0"> <button aria-controls="Return_value_items_new" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_new" data-toggle="collapse" onclick="setAnchor('#Return_value_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_items_new" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_new" id="Return_value_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_items_new_name"> <div class="card"> <div class="card-header" id="headingReturn_value_items_new_name"> <h2 class="mb-0"> <button aria-controls="Return_value_items_new_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_new_name" data-toggle="collapse" onclick="setAnchor('#Return_value_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_items_new_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_new_name" id="Return_value_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_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_items_new_name_const">Specific value: <code>"TrueNAS"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_items_new_version"> <div class="card"> <div class="card-header" id="headingReturn_value_items_new_version"> <h2 class="mb-0"> <button aria-controls="Return_value_items_new_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_new_version" data-toggle="collapse" onclick="setAnchor('#Return_value_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_items_new_version" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_new_version" id="Return_value_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><br><br>

*Required roles:* SYSTEM_UPDATE_READ