system.general.config
=====================

.. 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>
    </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>SystemGeneralEntry</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="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 general configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_certificate">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_certificate">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_certificate" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_certificate" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_certificate')" type="button"><span class="property-name">ui_certificate</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_certificate" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_certificate" id="Return_value_ui_certificate">
    <div class="card-body pl-5">
    <h4>Ui Certificate</h4><br/>
    <span class="description"><p>Used to enable HTTPS access to the system. If <code>ui_certificate</code> is not configured on boot, it is automatically     created by the system.</p>
    </span><div class="any-of-value" id="Return_value_ui_certificate_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_ui_certificate_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ui_certificate_anyOf_i0" id="Return_value_ui_certificate_anyOf_i0" onclick="setAnchor('#Return_value_ui_certificate_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_ui_certificate_anyOf_i1" id="Return_value_ui_certificate_anyOf_i1" onclick="setAnchor('#Return_value_ui_certificate_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_ui_certificate_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_ui_certificate_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="accordionReturn_value_ui_httpsport">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_httpsport">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_httpsport" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_httpsport" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_httpsport')" type="button"><span class="property-name">ui_httpsport</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_httpsport" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_httpsport" id="Return_value_ui_httpsport">
    <div class="card-body pl-5">
    <h4>Ui Httpsport</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>HTTPS port for the web UI.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_ui_httpsport_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>65535</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_httpsredirect">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_httpsredirect">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_httpsredirect" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_httpsredirect" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_httpsredirect')" type="button"><span class="property-name">ui_httpsredirect</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_httpsredirect" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_httpsredirect" id="Return_value_ui_httpsredirect">
    <div class="card-body pl-5">
    <h4>Ui Httpsredirect</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>When set, makes sure that all HTTP requests are converted to HTTPS requests to better enhance security.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_httpsprotocols">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_httpsprotocols">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_httpsprotocols" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_httpsprotocols" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_httpsprotocols')" type="button"><span class="property-name">ui_httpsprotocols</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_httpsprotocols" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_httpsprotocols" id="Return_value_ui_httpsprotocols">
    <div class="card-body pl-5">
    <h4>Ui Httpsprotocols</h4><span class="badge badge-dark value-type">Type: array of enum (of string)</span><br/>
    <span class="description"><p>Array of TLS protocol versions enabled for HTTPS connections.</p>
    </span>
    <p><span class="badge badge-light restriction unique-items-restriction" id="Return_value_ui_httpsprotocols_uniqueItems">All items must be unique</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="Return_value_ui_httpsprotocols_items">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Return_value_ui_httpsprotocols_items_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"TLSv1"</li><li class="list-group-item enum-item">"TLSv1.1"</li><li class="list-group-item enum-item">"TLSv1.2"</li><li class="list-group-item enum-item">"TLSv1.3"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_port">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_port">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_port" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_port')" type="button"><span class="property-name">ui_port</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_port" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_port" id="Return_value_ui_port">
    <div class="card-body pl-5">
    <h4>Ui Port</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>HTTP port for the web UI.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_ui_port_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>65535</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_address">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_address">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_address" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_address" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_address')" type="button"><span class="property-name">ui_address</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_address" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_address" id="Return_value_ui_address">
    <div class="card-body pl-5">
    <h4>Ui Address</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>A list of valid IPv4 addresses which the system will listen on.</p>
    </span>
    <p><span class="badge badge-light restriction min-items-restriction" id="Return_value_ui_address_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="Return_value_ui_address_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_v6address">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_v6address">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_v6address" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_v6address" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_v6address')" type="button"><span class="property-name">ui_v6address</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_v6address" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_v6address" id="Return_value_ui_v6address">
    <div class="card-body pl-5">
    <h4>Ui V6Address</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>A list of valid IPv6 addresses which the system will listen on.</p>
    </span>
    <p><span class="badge badge-light restriction min-items-restriction" id="Return_value_ui_v6address_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="Return_value_ui_v6address_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_allowlist">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_allowlist">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_allowlist" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_allowlist" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_allowlist')" type="button"><span class="property-name">ui_allowlist</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_allowlist" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_allowlist" id="Return_value_ui_allowlist">
    <div class="card-body pl-5">
    <h4>Ui Allowlist</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>A list of IP addresses and networks that are allow to use API and UI. If this list is empty, then all IP     addresses are allowed to use API and UI.</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_ui_allowlist_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_consolemsg">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_consolemsg">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_consolemsg" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_consolemsg" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_consolemsg')" type="button"><span class="property-name">ui_consolemsg</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_consolemsg" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_consolemsg" id="Return_value_ui_consolemsg">
    <div class="card-body pl-5">
    <h4>Ui Consolemsg</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether to show console messages on the web UI.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ui_x_frame_options">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ui_x_frame_options">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ui_x_frame_options" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ui_x_frame_options" data-toggle="collapse" onclick="setAnchor('#Return_value_ui_x_frame_options')" type="button"><span class="property-name">ui_x_frame_options</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ui_x_frame_options" class="collapse property-definition-div" data-parent="#accordionReturn_value_ui_x_frame_options" id="Return_value_ui_x_frame_options">
    <div class="card-body pl-5">
    <h4>Ui X Frame Options</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>X-Frame-Options header policy for web UI security.</p>
    </span><div class="enum-value" id="Return_value_ui_x_frame_options_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"SAMEORIGIN"</li><li class="list-group-item enum-item">"DENY"</li><li class="list-group-item enum-item">"ALLOW_ALL"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_kbdmap">
    <div class="card">
    <div class="card-header" id="headingReturn_value_kbdmap">
    <h2 class="mb-0">
    <button aria-controls="Return_value_kbdmap" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_kbdmap" data-toggle="collapse" onclick="setAnchor('#Return_value_kbdmap')" type="button"><span class="property-name">kbdmap</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_kbdmap" class="collapse property-definition-div" data-parent="#accordionReturn_value_kbdmap" id="Return_value_kbdmap">
    <div class="card-body pl-5">
    <h4>Kbdmap</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>System keyboard layout mapping.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_timezone">
    <div class="card">
    <div class="card-header" id="headingReturn_value_timezone">
    <h2 class="mb-0">
    <button aria-controls="Return_value_timezone" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_timezone" data-toggle="collapse" onclick="setAnchor('#Return_value_timezone')" type="button"><span class="property-name">timezone</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_timezone" class="collapse property-definition-div" data-parent="#accordionReturn_value_timezone" id="Return_value_timezone">
    <div class="card-body pl-5">
    <h4>Timezone</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>System timezone identifier.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_timezone_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_usage_collection">
    <div class="card">
    <div class="card-header" id="headingReturn_value_usage_collection">
    <h2 class="mb-0">
    <button aria-controls="Return_value_usage_collection" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_usage_collection" data-toggle="collapse" onclick="setAnchor('#Return_value_usage_collection')" type="button"><span class="property-name">usage_collection</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_usage_collection" class="collapse property-definition-div" data-parent="#accordionReturn_value_usage_collection" id="Return_value_usage_collection">
    <div class="card-body pl-5">
    <h4>Usage Collection</h4><br/>
    <span class="description"><p>Whether usage data collection is enabled. <code>null</code> if not set.</p>
    </span><div class="any-of-value" id="Return_value_usage_collection_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_usage_collection_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_usage_collection_anyOf_i0" id="Return_value_usage_collection_anyOf_i0" onclick="setAnchor('#Return_value_usage_collection_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_usage_collection_anyOf_i1" id="Return_value_usage_collection_anyOf_i1" onclick="setAnchor('#Return_value_usage_collection_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_usage_collection_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: boolean</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_usage_collection_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="accordionReturn_value_wizardshown">
    <div class="card">
    <div class="card-header" id="headingReturn_value_wizardshown">
    <h2 class="mb-0">
    <button aria-controls="Return_value_wizardshown" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_wizardshown" data-toggle="collapse" onclick="setAnchor('#Return_value_wizardshown')" type="button"><span class="property-name">wizardshown</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_wizardshown" class="collapse property-definition-div" data-parent="#accordionReturn_value_wizardshown" id="Return_value_wizardshown">
    <div class="card-body pl-5">
    <h4>Wizardshown</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether the initial setup wizard has been shown.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_usage_collection_is_set">
    <div class="card">
    <div class="card-header" id="headingReturn_value_usage_collection_is_set">
    <h2 class="mb-0">
    <button aria-controls="Return_value_usage_collection_is_set" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_usage_collection_is_set" data-toggle="collapse" onclick="setAnchor('#Return_value_usage_collection_is_set')" type="button"><span class="property-name">usage_collection_is_set</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_usage_collection_is_set" class="collapse property-definition-div" data-parent="#accordionReturn_value_usage_collection_is_set" id="Return_value_usage_collection_is_set">
    <div class="card-body pl-5">
    <h4>Usage Collection Is Set</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether the usage collection preference has been explicitly set.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ds_auth">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ds_auth">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ds_auth" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ds_auth" data-toggle="collapse" onclick="setAnchor('#Return_value_ds_auth')" type="button"><span class="property-name">ds_auth</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ds_auth" class="collapse property-definition-div" data-parent="#accordionReturn_value_ds_auth" id="Return_value_ds_auth">
    <div class="card-body pl-5">
    <h4>Ds Auth</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Controls whether configured Directory Service users that are granted with Privileges are allowed to log in to     the Web UI or use TrueNAS API.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SYSTEM_GENERAL_READ