systemdataset.update
====================

Update System Dataset Service Configuration.

This method is a job.

.. 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 configuration for the system dataset.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_pool"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_pool"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_pool" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_pool" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_pool')" type="button"><span class="property-name">pool</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_pool" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_pool" id="Call_parameters_items_i0_pool"> <div class="card-body pl-5"> <h4>Pool</h4><br/> <span class="description"><p>The name of a valid pool configured in the system to host the system dataset.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_pool_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_pool_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_pool_anyOf_i0" id="Call_parameters_items_i0_pool_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_pool_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_i0_pool_anyOf_i1" id="Call_parameters_items_i0_pool_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_pool_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_i0_pool_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_i0_pool_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_i0_pool_exclude"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_pool_exclude"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_pool_exclude" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_pool_exclude" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_pool_exclude')" type="button"><span class="property-name">pool_exclude</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_pool_exclude" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_pool_exclude" id="Call_parameters_items_i0_pool_exclude"> <div class="card-body pl-5"> <h4>Pool Exclude</h4><br/> <span class="description"><p>The name of a pool to not place the system dataset on if <code>pool</code> is not provided.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_pool_exclude_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_pool_exclude_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_pool_exclude_anyOf_i0" id="Call_parameters_items_i0_pool_exclude_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_pool_exclude_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_i0_pool_exclude_anyOf_i1" id="Call_parameters_items_i0_pool_exclude_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_pool_exclude_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_i0_pool_exclude_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_i0_pool_exclude_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> </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>SystemDatasetEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>The updated system dataset 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 system dataset configuration.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_pool"> <div class="card"> <div class="card-header" id="headingReturn_value_pool"> <h2 class="mb-0"> <button aria-controls="Return_value_pool" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_pool" data-toggle="collapse" onclick="setAnchor('#Return_value_pool')" type="button"><span class="property-name">pool</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_pool" class="collapse property-definition-div" data-parent="#accordionReturn_value_pool" id="Return_value_pool"> <div class="card-body pl-5"> <h4>Pool</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Name of the pool hosting the system dataset.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_pool_set"> <div class="card"> <div class="card-header" id="headingReturn_value_pool_set"> <h2 class="mb-0"> <button aria-controls="Return_value_pool_set" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_pool_set" data-toggle="collapse" onclick="setAnchor('#Return_value_pool_set')" type="button"><span class="property-name">pool_set</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_pool_set" class="collapse property-definition-div" data-parent="#accordionReturn_value_pool_set" id="Return_value_pool_set"> <div class="card-body pl-5"> <h4>Pool Set</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Whether a pool has been explicitly set for the system dataset.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_uuid"> <div class="card"> <div class="card-header" id="headingReturn_value_uuid"> <h2 class="mb-0"> <button aria-controls="Return_value_uuid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_uuid" data-toggle="collapse" onclick="setAnchor('#Return_value_uuid')" type="button"><span class="property-name">uuid</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_uuid" class="collapse property-definition-div" data-parent="#accordionReturn_value_uuid" id="Return_value_uuid"> <div class="card-body pl-5"> <h4>Uuid</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>UUID of the system dataset.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_basename"> <div class="card"> <div class="card-header" id="headingReturn_value_basename"> <h2 class="mb-0"> <button aria-controls="Return_value_basename" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_basename" data-toggle="collapse" onclick="setAnchor('#Return_value_basename')" type="button"><span class="property-name">basename</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_basename" class="collapse property-definition-div" data-parent="#accordionReturn_value_basename" id="Return_value_basename"> <div class="card-body pl-5"> <h4>Basename</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Base name of the system dataset.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_path"> <div class="card"> <div class="card-header" id="headingReturn_value_path"> <h2 class="mb-0"> <button aria-controls="Return_value_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_path" data-toggle="collapse" onclick="setAnchor('#Return_value_path')" type="button"><span class="property-name">path</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_path" class="collapse property-definition-div" data-parent="#accordionReturn_value_path" id="Return_value_path"> <div class="card-body pl-5"> <h4>Path</h4><br/> <span class="description"><p>Filesystem path to the system dataset. <code>null</code> if not mounted.</p> </span><div class="any-of-value" id="Return_value_path_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_path_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_path_anyOf_i0" id="Return_value_path_anyOf_i0" onclick="setAnchor('#Return_value_path_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_path_anyOf_i1" id="Return_value_path_anyOf_i1" onclick="setAnchor('#Return_value_path_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_Return_value_path_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_Return_value_path_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> </div> </div><br><br>

*Required roles:* DATASET_WRITE

