pool.snapshottask.update_will_change_retention_for
==================================================

Returns a list of snapshots which will change the retention if periodic snapshot task `id` is updated with `data`.

.. 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: id</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>ID of the periodic snapshot task to analyze.</p>
    </span>
    </div>
    </div>
    <h5>Parameter 2: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Proposed configuration changes to analyze.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_dataset">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_dataset">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_dataset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_dataset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_dataset')" type="button"><span class="property-name">dataset</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_dataset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_dataset" id="Call_parameters_items_i1_dataset">
    <div class="card-body pl-5">
    <h4>Dataset</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>The dataset to take snapshots of.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_recursive">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_recursive">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_recursive" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_recursive" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_recursive')" type="button"><span class="property-name">recursive</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_recursive" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_recursive" id="Call_parameters_items_i1_recursive">
    <div class="card-body pl-5">
    <h4>Recursive</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether to recursively snapshot child datasets.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_lifetime_value">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_lifetime_value">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_lifetime_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_lifetime_value" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_lifetime_value')" type="button"><span class="property-name">lifetime_value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_lifetime_value" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_lifetime_value" id="Call_parameters_items_i1_lifetime_value">
    <div class="card-body pl-5">
    <h4>Lifetime Value</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Number of time units to retain snapshots. <code>lifetime_unit</code> gives the time unit.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_lifetime_unit">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_lifetime_unit">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_lifetime_unit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_lifetime_unit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_lifetime_unit')" type="button"><span class="property-name">lifetime_unit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_lifetime_unit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_lifetime_unit" id="Call_parameters_items_i1_lifetime_unit">
    <div class="card-body pl-5">
    <h4>Lifetime Unit</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Unit of time for snapshot retention.</p>
    </span><div class="enum-value" id="Call_parameters_items_i1_lifetime_unit_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"HOUR"</li><li class="list-group-item enum-item">"DAY"</li><li class="list-group-item enum-item">"WEEK"</li><li class="list-group-item enum-item">"MONTH"</li><li class="list-group-item enum-item">"YEAR"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_enabled">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_enabled">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_enabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_enabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_enabled" id="Call_parameters_items_i1_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether this periodic snapshot task is enabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_exclude">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_exclude">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_exclude" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_exclude" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_exclude')" type="button"><span class="property-name">exclude</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_exclude" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_exclude" id="Call_parameters_items_i1_exclude">
    <div class="card-body pl-5">
    <h4>Exclude</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Array of dataset patterns to exclude from recursive snapshots.</p>
    </span>
    <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_exclude_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_naming_schema">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_naming_schema">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_naming_schema" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_naming_schema" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_naming_schema')" type="button"><span class="property-name">naming_schema</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_naming_schema" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_naming_schema" id="Call_parameters_items_i1_naming_schema">
    <div class="card-body pl-5">
    <h4>Naming Schema</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Naming pattern for generated snapshots using strftime format.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_allow_empty">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_allow_empty">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_allow_empty" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_allow_empty" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_allow_empty')" type="button"><span class="property-name">allow_empty</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_allow_empty" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_allow_empty" id="Call_parameters_items_i1_allow_empty">
    <div class="card-body pl-5">
    <h4>Allow Empty</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether to take snapshots even if no data has changed.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_schedule">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_schedule">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_schedule" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_schedule" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_schedule')" type="button"><span class="property-name">schedule</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_schedule" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_schedule" id="Call_parameters_items_i1_schedule">
    <div class="card-body pl-5">
    <h4>PoolSnapshotTaskCron</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Cron schedule for when snapshots should be taken.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_schedule_minute">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_schedule_minute">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_schedule_minute" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_schedule_minute" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_schedule_minute')" type="button"><span class="property-name">minute</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_schedule_minute" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_schedule_minute" id="Call_parameters_items_i1_schedule_minute">
    <div class="card-body pl-5">
    <h4>Minute</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "00"</span><br/>
    <span class="description"><p>Minute when snapshots should be taken (cron format).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_schedule_hour">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_schedule_hour">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_schedule_hour" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_schedule_hour" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_schedule_hour')" type="button"><span class="property-name">hour</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_schedule_hour" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_schedule_hour" id="Call_parameters_items_i1_schedule_hour">
    <div class="card-body pl-5">
    <h4>Hour</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"00" - "23"</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_schedule_dom">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_schedule_dom">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_schedule_dom" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_schedule_dom" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_schedule_dom')" type="button"><span class="property-name">dom</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_schedule_dom" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_schedule_dom" id="Call_parameters_items_i1_schedule_dom">
    <div class="card-body pl-5">
    <h4>Dom</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" - "31"</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_schedule_month">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_schedule_month">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_schedule_month" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_schedule_month" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_schedule_month')" type="button"><span class="property-name">month</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_schedule_month" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_schedule_month" id="Call_parameters_items_i1_schedule_month">
    <div class="card-body pl-5">
    <h4>Month</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" (January) - "12" (December)</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_schedule_dow">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_schedule_dow">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_schedule_dow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_schedule_dow" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_schedule_dow')" type="button"><span class="property-name">dow</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_schedule_dow" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_schedule_dow" id="Call_parameters_items_i1_schedule_dow">
    <div class="card-body pl-5">
    <h4>Dow</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" (Monday) - "7" (Sunday)</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_schedule_begin">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_schedule_begin">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_schedule_begin" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_schedule_begin" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_schedule_begin')" type="button"><span class="property-name">begin</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_schedule_begin" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_schedule_begin" id="Call_parameters_items_i1_schedule_begin">
    <div class="card-body pl-5">
    <h4>Begin</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "00:00"</span><br/>
    <span class="description"><p>Start time of the window when snapshots can be taken.</p>
    </span>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_schedule_begin_ex1"><div class="highlight"><pre><span></span><span class="s2">"00:00"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_schedule_begin_ex2"><div class="highlight"><pre><span></span><span class="s2">"06:30"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_schedule_begin_ex3"><div class="highlight"><pre><span></span><span class="s2">"18:00"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_schedule_begin_ex4"><div class="highlight"><pre><span></span><span class="s2">"23:00"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_schedule_end">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_schedule_end">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_schedule_end" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_schedule_end" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_schedule_end')" type="button"><span class="property-name">end</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_schedule_end" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_schedule_end" id="Call_parameters_items_i1_schedule_end">
    <div class="card-body pl-5">
    <h4>End</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "23:59"</span><br/>
    <span class="description"><p>End time of the window when snapshots can be taken.</p>
    </span>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_schedule_end_ex1"><div class="highlight"><pre><span></span><span class="s2">"00:00"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_schedule_end_ex2"><div class="highlight"><pre><span></span><span class="s2">"06:30"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_schedule_end_ex3"><div class="highlight"><pre><span></span><span class="s2">"18:00"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_schedule_end_ex4"><div class="highlight"><pre><span></span><span class="s2">"23:00"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </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: object</span><br/>
    <span class="description"><p>Object mapping retention change types to arrays of affected snapshot names.</p>
    </span>
    <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: array of string</span><br/>
    <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="Return_value_additionalProperties_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SNAPSHOT_TASK_READ

