failover.update
===============

Update failover configuration.

.. 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: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Updated failover configuration data.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_disabled">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_disabled">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_disabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_disabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_disabled')" type="button"><span class="property-name">disabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_disabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_disabled" id="Call_parameters_items_i0_disabled">
    <div class="card-body pl-5">
    <h4>Disabled</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>When true, HA will be administratively disabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_master">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_master">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_master" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_master" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_master')" type="button"><span class="property-name">master</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_master" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_master" id="Call_parameters_items_i0_master">
    <div class="card-body pl-5">
    <h4>Master</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Marks the particular node in the chassis as the master node. The standby node will have the opposite value.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_timeout">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_timeout">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_timeout" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_timeout')" type="button"><span class="property-name">timeout</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_timeout" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_timeout" id="Call_parameters_items_i0_timeout">
    <div class="card-body pl-5">
    <h4>Timeout</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>The time to WAIT (in seconds) until a failover occurs when a network event occurs on an interface that is marked critical for failover AND HA is enabled and working appropriately. The default time to wait is 2 seconds.</p>
    <p>Maximum is 120 seconds. This value is used to derive the VRRPv3 advertisement interval, which cannot exceed 40.95 seconds (RFC 5798 section 5.2.7).</p>
    <p><strong>NOTE: This setting does NOT effect the <code>disabled</code> or <code>master</code> parameters.</strong></p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_timeout_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>120</code></span></p>
    </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>FailoverEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The updated failover configuration.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Unique identifier for the failover configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_disabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_disabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_disabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_disabled" data-toggle="collapse" onclick="setAnchor('#Return_value_disabled')" type="button"><span class="property-name">disabled</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_disabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_disabled" id="Return_value_disabled">
    <div class="card-body pl-5">
    <h4>Disabled</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>When true, HA will be administratively disabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_master">
    <div class="card">
    <div class="card-header" id="headingReturn_value_master">
    <h2 class="mb-0">
    <button aria-controls="Return_value_master" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_master" data-toggle="collapse" onclick="setAnchor('#Return_value_master')" type="button"><span class="property-name">master</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_master" class="collapse property-definition-div" data-parent="#accordionReturn_value_master" id="Return_value_master">
    <div class="card-body pl-5">
    <h4>Master</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Marks the particular node in the chassis as the master node. The standby node will have the opposite value.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_timeout">
    <div class="card">
    <div class="card-header" id="headingReturn_value_timeout">
    <h2 class="mb-0">
    <button aria-controls="Return_value_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_timeout" data-toggle="collapse" onclick="setAnchor('#Return_value_timeout')" type="button"><span class="property-name">timeout</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_timeout" class="collapse property-definition-div" data-parent="#accordionReturn_value_timeout" id="Return_value_timeout">
    <div class="card-body pl-5">
    <h4>Timeout</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>The time to WAIT (in seconds) until a failover occurs when a network event occurs on an interface that is marked critical for failover AND HA is enabled and working appropriately. The default time to wait is 2 seconds.</p>
    <p><strong>NOTE: This setting does NOT effect the <code>disabled</code> or <code>master</code> parameters.</strong></p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* FAILOVER_WRITE