tunable.create
==============

Create a tunable.

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>Configuration for creating a new system tunable.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_type">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_type">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_type" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_type')" type="button"><span class="property-name">type</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_type" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_type" id="Call_parameters_items_i0_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "SYSCTL"</span><br/>
    <span class="description"><ul>
    <li><code>SYSCTL</code>: <code>var</code> is a sysctl name (e.g. <code>kernel.watchdog</code>) and <code>value</code> is its corresponding value (e.g. <code>0</code>).</li>
    <li><code>UDEV</code>: <code>var</code> is a udev rules file name (e.g. <code>10-disable-usb</code>, <code>.rules</code> suffix will be appended automatically)     and <code>value</code> is its contents (e.g. <code>BUS=="usb", OPTIONS+="ignore_device"</code>).</li>
    <li><code>ZFS</code>: <code>var</code> is a ZFS kernel module parameter name (e.g. <code>zfs_dirty_data_max_max</code>) and <code>value</code> is its value     (e.g. <code>783091712</code>).</li>
    </ul>
    </span><div class="enum-value" id="Call_parameters_items_i0_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"SYSCTL"</li><li class="list-group-item enum-item">"UDEV"</li><li class="list-group-item enum-item">"ZFS"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_var">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_var">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_var" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_var" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_var')" type="button"><span class="property-name">var</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_var" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_var" id="Call_parameters_items_i0_var">
    <div class="card-body pl-5">
    <h4>Var</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name or identifier of the system parameter to tune.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_value">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_value">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_value" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_value')" type="button"><span class="property-name">value</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_value" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_value" id="Call_parameters_items_i0_value">
    <div class="card-body pl-5">
    <h4>Value</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Value to assign to the tunable parameter.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_comment">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_comment">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_comment" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_comment" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_comment')" type="button"><span class="property-name">comment</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_comment" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_comment" id="Call_parameters_items_i0_comment">
    <div class="card-body pl-5">
    <h4>Comment</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>Optional descriptive comment explaining the purpose of this tunable.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_enabled">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_enabled">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_enabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_enabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_enabled" id="Call_parameters_items_i0_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Whether this tunable is active and should be applied.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_update_initramfs">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_update_initramfs">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_update_initramfs" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_update_initramfs" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_update_initramfs')" type="button"><span class="property-name">update_initramfs</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_update_initramfs" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_update_initramfs" id="Call_parameters_items_i0_update_initramfs">
    <div class="card-body pl-5">
    <h4>Update Initramfs</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If <code>false</code>, then initramfs will not be updated after creating a ZFS tunable and you will need to run     <code>system boot update_initramfs</code> manually.</p>
    </span>
    </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>TunableEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The newly created tunable configuration.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_type" data-toggle="collapse" onclick="setAnchor('#Return_value_type')" type="button"><span class="property-name">type</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_type" id="Return_value_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "SYSCTL"</span><br/>
    <span class="description"><ul>
    <li><code>SYSCTL</code>: <code>var</code> is a sysctl name (e.g. <code>kernel.watchdog</code>) and <code>value</code> is its corresponding value (e.g. <code>0</code>).</li>
    <li><code>UDEV</code>: <code>var</code> is a udev rules file name (e.g. <code>10-disable-usb</code>, <code>.rules</code> suffix will be appended automatically)     and <code>value</code> is its contents (e.g. <code>BUS=="usb", OPTIONS+="ignore_device"</code>).</li>
    <li><code>ZFS</code>: <code>var</code> is a ZFS kernel module parameter name (e.g. <code>zfs_dirty_data_max_max</code>) and <code>value</code> is its value     (e.g. <code>783091712</code>).</li>
    </ul>
    </span><div class="enum-value" id="Return_value_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"SYSCTL"</li><li class="list-group-item enum-item">"UDEV"</li><li class="list-group-item enum-item">"ZFS"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_var">
    <div class="card">
    <div class="card-header" id="headingReturn_value_var">
    <h2 class="mb-0">
    <button aria-controls="Return_value_var" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_var" data-toggle="collapse" onclick="setAnchor('#Return_value_var')" type="button"><span class="property-name">var</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_var" class="collapse property-definition-div" data-parent="#accordionReturn_value_var" id="Return_value_var">
    <div class="card-body pl-5">
    <h4>Var</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name or identifier of the system parameter to tune.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_value" data-toggle="collapse" onclick="setAnchor('#Return_value_value')" type="button"><span class="property-name">value</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_value" class="collapse property-definition-div" data-parent="#accordionReturn_value_value" id="Return_value_value">
    <div class="card-body pl-5">
    <h4>Value</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Value to assign to the tunable parameter.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_comment">
    <div class="card">
    <div class="card-header" id="headingReturn_value_comment">
    <h2 class="mb-0">
    <button aria-controls="Return_value_comment" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_comment" data-toggle="collapse" onclick="setAnchor('#Return_value_comment')" type="button"><span class="property-name">comment</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_comment" class="collapse property-definition-div" data-parent="#accordionReturn_value_comment" id="Return_value_comment">
    <div class="card-body pl-5">
    <h4>Comment</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>Optional descriptive comment explaining the purpose of this tunable.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_enabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_enabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_enabled" id="Return_value_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Whether this tunable is active and should be applied.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_update_initramfs">
    <div class="card">
    <div class="card-header" id="headingReturn_value_update_initramfs">
    <h2 class="mb-0">
    <button aria-controls="Return_value_update_initramfs" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_update_initramfs" data-toggle="collapse" onclick="setAnchor('#Return_value_update_initramfs')" type="button"><span class="property-name">update_initramfs</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_update_initramfs" class="collapse property-definition-div" data-parent="#accordionReturn_value_update_initramfs" id="Return_value_update_initramfs">
    <div class="card-body pl-5">
    <h4>Update Initramfs</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If <code>false</code>, then initramfs will not be updated after creating a ZFS tunable and you will need to run     <code>system boot update_initramfs</code> manually.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <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 tunable configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_orig_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value_orig_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value_orig_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_orig_value" data-toggle="collapse" onclick="setAnchor('#Return_value_orig_value')" type="button"><span class="property-name">orig_value</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_orig_value" class="collapse property-definition-div" data-parent="#accordionReturn_value_orig_value" id="Return_value_orig_value">
    <div class="card-body pl-5">
    <h4>Orig Value</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Original system value of the parameter before this tunable was applied.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SYSTEM_TUNABLE_WRITE