replication.target_unmatched_snapshots
======================================

Check if target has any snapshots that do not exist on source. Returns these snapshots grouped by dataset.

.. 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: direction</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>direction</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>Direction of replication to check for unmatched snapshots.</p> </span><div class="enum-value" id="Call_parameters_items_i0_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"PUSH"</li><li class="list-group-item enum-item">"PULL"</li></ul> </div> </div> </div> <h5>Parameter 2: source_datasets</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>source_datasets</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="description"><p>Array of source dataset names.</p> </span> <p><span class="badge badge-light restriction min-items-restriction" id="Call_parameters_items_i1_minItems">Must contain a minimum of <code>1</code> items</span></p> <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="Call_parameters_items_i1_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <h5>Parameter 3: target_dataset</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i2"> <h4>target_dataset</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Target dataset name to check for unmatched snapshots.</p> </span> </div> </div> <h5>Parameter 4: transport</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i3"> <h4>transport</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>Transport method to use for accessing snapshots.</p> </span><div class="enum-value" id="Call_parameters_items_i3_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"SSH"</li><li class="list-group-item enum-item">"SSH+NETCAT"</li><li class="list-group-item enum-item">"LOCAL"</li></ul> </div> </div> </div> <h5>Parameter 5: ssh_credentials</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i4"> <h4>ssh_credentials</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Keychain credential ID for SSH access. <code>null</code> for local transport.</p> </span><div class="any-of-value" id="Call_parameters_items_i4_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i4_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i4_anyOf_i0" id="Call_parameters_items_i4_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i4_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_i4_anyOf_i1" id="Call_parameters_items_i4_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i4_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_i4_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i4_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: object</span><br/> <span class="description"><p>Object mapping dataset names to arrays of unmatched snapshot names on the target side.</p> </span> <br/> <div class="badge badge-secondary">Example:</div> <br/><div class="jumbotron examples" id="Return_value_ex1"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"backup/games"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"auto-2019-10-15_13-00"</span>
    <span class="w">    </span><span class="p">],</span>
    <span class="w">    </span><span class="s2">"backup/work"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"auto-2019-10-15_13-00"</span><span class="p">,</span>
    <span class="w">        </span><span class="s2">"auto-2019-10-15_09-00"</span>
    <span class="w">    </span><span class="p">]</span>
    <span class="p">}</span>
    </pre></div> </div> <div class="accordion" id="accordionReturn_value_additionalProperties"> <div class="card"> <div class="card-header" id="headingReturn_value_additionalProperties"> <h2 class="mb-0"> <button aria-controls="Return_value_additionalProperties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties')" type="button"><em><span class="property-name">Additional Properties</span></em></button> </h2> </div> <div aria-labelledby="headingReturn_value_additionalProperties" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties" id="Return_value_additionalProperties"> <div class="card-body pl-5"><p class="additional-properties">Each additional property must conform to the following schema</p> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* REPLICATION_TASK_WRITE

