update.run
==========

Downloads (if not already in cache) and apply an update.

This method is a job.

.. 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> <div class="json-default-value">Default:<div class="value">{
      "dataset_name": null,
      "resume": false,
      "train": null,
      "version": null,
      "reboot": false
    }</div></div><br/>
    <span class="description"><p>Attributes controlling the system update execution process.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_dataset_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_dataset_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_dataset_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_dataset_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_dataset_name')" type="button"><span class="property-name">dataset_name</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_dataset_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_dataset_name" id="Call_parameters_items_i0_dataset_name">
    <div class="card-body pl-5">
    <h4>Dataset Name</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Name of the ZFS dataset to use for the new boot environment. <code>null</code> for automatic naming.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_dataset_name_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_dataset_name_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_dataset_name_anyOf_i0" id="Call_parameters_items_i0_dataset_name_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_dataset_name_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_dataset_name_anyOf_i1" id="Call_parameters_items_i0_dataset_name_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_dataset_name_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_dataset_name_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_dataset_name_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="accordionCall_parameters_items_i0_resume">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_resume">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_resume" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_resume" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_resume')" type="button"><span class="property-name">resume</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_resume" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_resume" id="Call_parameters_items_i0_resume">
    <div class="card-body pl-5">
    <h4>Resume</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Should be set to <code>true</code> if a previous call to this method returned a <code>CallError</code> with <code>errno=EAGAIN</code> meaning that an upgrade can be performed with a warning and that warning is accepted. In that case, update process will be continued using an already downloaded file without performing any extra checks.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <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/>
    <span class="description"><p>Specifies the train from which to download the update. If both <code>train</code> and <code>version</code> are `null``, the most recent version that matches the currently selected update profile is used.</p>
    </span><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 class="accordion" id="accordionCall_parameters_items_i0_version">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_version">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_version" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_version" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_version')" type="button"><span class="property-name">version</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_version" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_version" id="Call_parameters_items_i0_version">
    <div class="card-body pl-5">
    <h4>Version</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Specific version to update to. <code>null</code> to use the latest version from the specified train.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_version_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_version_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_version_anyOf_i0" id="Call_parameters_items_i0_version_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_version_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_version_anyOf_i1" id="Call_parameters_items_i0_version_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_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_Call_parameters_items_i0_version_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_version_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="accordionCall_parameters_items_i0_reboot">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_reboot">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_reboot" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_reboot" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_reboot')" type="button"><span class="property-name">reboot</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_reboot" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_reboot" id="Call_parameters_items_i0_reboot">
    <div class="card-body pl-5">
    <h4>Reboot</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Whether to automatically reboot the system after applying the update.</p>
    </span>
    </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><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="description"><p>Always returns true on successful update process initiation.</p>
    </span><span class="const-value" id="Return_value_const">Specific value: <code>true</code></span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SYSTEM_UPDATE_WRITE

