failover.become_passive
=======================

This method is only called manually by the end-user so we fully expect that they know what they're doing. Furthermore, this method will only run if failover has NOT been administratively disabled. The reason why we only allow this in that scenario is because the failover logic (on the other node) will ignore any failover "event" that comes in if failover has been administratively disabled. This immediately causes the HA system to go into a "faulted" state because the other node will get the VIPs but it will not import the zpool and it will not start ``fenced``. Only way out of that situation is to manually fix things (import zpool, migrate VIPs, start ``fenced``, etc).

NOTE: The only "safe" way to "become passive" is to use the **STCNITH** method, or "Shoot The Current Node In The Head" (similar to **STONITH**).

This ensures that the current node gets out of the way *completely* so there is no chance of the zpool being imported at the same time on both nodes (which can ultimately end in data corruption).

.. 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>
    </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: null</span><br/>
    <span class="description"><p>Returns <code>null</code> when the node successfully becomes passive.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* FAILOVER_WRITE

