failover.upgrade
================

Upgrades both controllers. Files will be downloaded to the Active Controller and then transferred to the Standby Controller. Upgrade process will start concurrently on both nodes. Once both upgrades are applied, the Standby Controller will reboot. This job will wait for that job to complete before finalizing.

This method is a job.

*This job CAN be used with file upload.* See :ref:`uploading-files`.

.. 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: failover_upgrade</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>failover_upgrade</h4><span class="badge badge-dark value-type">Type: object</span> <div class="json-default-value">Default:<div class="value">{
      "train": null,
      "version": null,
      "resume": false,
      "resume_manual": false
    }</div></div><br/>
    <span class="description"><p>Failover upgrade configuration options.</p>
    </span> <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/>
    <span class="description"><p>Update train to use for the upgrade or <code>null</code> for default.</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/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_train_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </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 upgrade to or <code>null</code> for latest.</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_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 true 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, you also have     to set <code>resume_manual</code> to <code>true</code> if a previous call to this method was     performed using update file upload.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_resume_manual">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_resume_manual">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_resume_manual" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_resume_manual" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_resume_manual')" type="button"><span class="property-name">resume_manual</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_resume_manual" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_resume_manual" id="Call_parameters_items_i0_resume_manual">
    <div class="card-body pl-5">
    <h4>Resume Manual</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 resume a manual upgrade operation.</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: boolean</span><br/>
    <span class="description"><p>Returns <code>true</code> when the failover upgrade is successfully initiated.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* FAILOVER_WRITE