pool.dataset.destroy_snapshots
==============================

Destroy specified snapshots of a given dataset.

This method is a job.

*DEPRECATED: this method is scheduled to be removed in v26.04.*

.. 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: name</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>The dataset name to destroy snapshots for.</p> </span> </div> </div> <h5>Parameter 2: snapshots</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>snapshots</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>Specification of which snapshots to destroy (all, specific ones, or ranges).</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i1_all"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_all"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_all" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_all" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_all')" type="button"><span class="property-name">all</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_all" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_all" id="Call_parameters_items_i1_all"> <div class="card-body pl-5"> <h4>All</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 destroy all snapshots for the dataset.</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> <span class="badge badge-success default-value">Default: false</span><br/> <span class="description"><p>Whether to recursively destroy snapshots of child datasets.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_snapshots"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_snapshots"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_snapshots" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_snapshots" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_snapshots')" type="button"><span class="property-name">snapshots</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_snapshots" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_snapshots" id="Call_parameters_items_i1_snapshots"> <div class="card-body pl-5"> <h4>Snapshots</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>Array of specific snapshot names or snapshot range specifications to destroy.</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_snapshots_items"> <br/> <div class="any-of-value" id="Call_parameters_items_i1_snapshots_items_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_snapshots_items_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_snapshots_items_anyOf_i0" id="Call_parameters_items_i1_snapshots_items_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_snapshots_items_anyOf_i0')" role="tab">PoolDatasetDestroySnapshotsArgsSnapshotSpec</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_snapshots_items_anyOf_i1" id="Call_parameters_items_i1_snapshots_items_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_snapshots_items_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_i1_snapshots_items_anyOf_i0" role="tabpanel"> <h4>PoolDatasetDestroySnapshotsArgsSnapshotSpec</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i1_snapshots_items_anyOf_i0_start"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_snapshots_items_anyOf_i0_start"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_snapshots_items_anyOf_i0_start" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_snapshots_items_anyOf_i0_start" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_snapshots_items_anyOf_i0_start')" type="button"><span class="property-name">start</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_snapshots_items_anyOf_i0_start" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_snapshots_items_anyOf_i0_start" id="Call_parameters_items_i1_snapshots_items_anyOf_i0_start"> <div class="card-body pl-5"> <h4>Start</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Starting snapshot name for the range. Null to start from the beginning.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_snapshots_items_anyOf_i0_start_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_snapshots_items_anyOf_i0_start_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_snapshots_items_anyOf_i0_start_anyOf_i0" id="Call_parameters_items_i1_snapshots_items_anyOf_i0_start_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_snapshots_items_anyOf_i0_start_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_i1_snapshots_items_anyOf_i0_start_anyOf_i1" id="Call_parameters_items_i1_snapshots_items_anyOf_i0_start_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_snapshots_items_anyOf_i0_start_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_i1_snapshots_items_anyOf_i0_start_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_i1_snapshots_items_anyOf_i0_start_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_i1_snapshots_items_anyOf_i0_end"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_snapshots_items_anyOf_i0_end"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_snapshots_items_anyOf_i0_end" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_snapshots_items_anyOf_i0_end" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_snapshots_items_anyOf_i0_end')" type="button"><span class="property-name">end</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_snapshots_items_anyOf_i0_end" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_snapshots_items_anyOf_i0_end" id="Call_parameters_items_i1_snapshots_items_anyOf_i0_end"> <div class="card-body pl-5"> <h4>End</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Ending snapshot name for the range. Null to continue to the end.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_snapshots_items_anyOf_i0_end_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_snapshots_items_anyOf_i0_end_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_snapshots_items_anyOf_i0_end_anyOf_i0" id="Call_parameters_items_i1_snapshots_items_anyOf_i0_end_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_snapshots_items_anyOf_i0_end_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_i1_snapshots_items_anyOf_i0_end_anyOf_i1" id="Call_parameters_items_i1_snapshots_items_anyOf_i0_end_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_snapshots_items_anyOf_i0_end_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_i1_snapshots_items_anyOf_i0_end_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_i1_snapshots_items_anyOf_i0_end_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_snapshots_items_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </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: array of string</span><br/> <span class="description"><p>Array of snapshot names that were successfully destroyed.</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="Return_value_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* SNAPSHOT_WRITE

