system.ntpserver.update
=======================

Update NTP server of ``id``.

.. 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 NTP server to update.</p>
    </span>
    </div>
    </div>
    <h5>Parameter 2: ntp_server_update</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>ntp_server_update</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Updated configuration for the NTP server.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_address">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_address">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_address" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_address" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_address')" type="button"><span class="property-name">address</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_address" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_address" id="Call_parameters_items_i1_address">
    <div class="card-body pl-5">
    <h4>Address</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Hostname or IP address of the NTP server.</p>
    </span><span class="pattern-value" id="Call_parameters_items_i1_address_pattern">Must match regular expression: <code>^\S+$</code></span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i1_address_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_burst">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_burst">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_burst" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_burst" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_burst')" type="button"><span class="property-name">burst</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_burst" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_burst" id="Call_parameters_items_i1_burst">
    <div class="card-body pl-5">
    <h4>Burst</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Send a burst of packets when the server is reachable.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_iburst">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_iburst">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_iburst" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_iburst" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_iburst')" type="button"><span class="property-name">iburst</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_iburst" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_iburst" id="Call_parameters_items_i1_iburst">
    <div class="card-body pl-5">
    <h4>Iburst</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Send a burst of packets when the server is unreachable.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_prefer">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_prefer">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_prefer" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_prefer" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_prefer')" type="button"><span class="property-name">prefer</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_prefer" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_prefer" id="Call_parameters_items_i1_prefer">
    <div class="card-body pl-5">
    <h4>Prefer</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Mark this server as preferred for time synchronization.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_minpoll">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_minpoll">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_minpoll" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_minpoll" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_minpoll')" type="button"><span class="property-name">minpoll</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_minpoll" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_minpoll" id="Call_parameters_items_i1_minpoll">
    <div class="card-body pl-5">
    <h4>Minpoll</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Minimum polling interval (log2 seconds).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_maxpoll">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_maxpoll">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_maxpoll" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_maxpoll" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_maxpoll')" type="button"><span class="property-name">maxpoll</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_maxpoll" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_maxpoll" id="Call_parameters_items_i1_maxpoll">
    <div class="card-body pl-5">
    <h4>Maxpoll</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Maximum polling interval (log2 seconds).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_nts">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_nts">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_nts" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_nts" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_nts')" type="button"><span class="property-name">nts</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_nts" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_nts" id="Call_parameters_items_i1_nts">
    <div class="card-body pl-5">
    <h4>Nts</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Use Network Time Security (NTS) to authenticate this server.</p>
    <p>The server must support NTS key establishment on TCP port 4460. This system must trust the TLS certificate of the server. The certificate must match <code>address</code>. If <code>address</code> is an IP address, the certificate must include that IP address. The system clock must be approximately correct for the certificate check.</p>
    <p>When at least one NTS server is configured, the system ignores servers without NTS. This includes servers from DHCP. If no NTS server is reachable, the system does not adjust the clock.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_force">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_force">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_force" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_force" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_force')" type="button"><span class="property-name">force</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_force" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_force" id="Call_parameters_items_i1_force">
    <div class="card-body pl-5">
    <h4>Force</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Skip the connection checks before saving. Without this option, the server must be reachable. If <code>nts</code> is set, NTS key establishment with the server must also succeed.</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>NTPServerEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The updated NTP server 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 NTP server configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_address">
    <div class="card">
    <div class="card-header" id="headingReturn_value_address">
    <h2 class="mb-0">
    <button aria-controls="Return_value_address" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_address" data-toggle="collapse" onclick="setAnchor('#Return_value_address')" type="button"><span class="property-name">address</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_address" class="collapse property-definition-div" data-parent="#accordionReturn_value_address" id="Return_value_address">
    <div class="card-body pl-5">
    <h4>Address</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Hostname or IP address of the NTP server.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_burst">
    <div class="card">
    <div class="card-header" id="headingReturn_value_burst">
    <h2 class="mb-0">
    <button aria-controls="Return_value_burst" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_burst" data-toggle="collapse" onclick="setAnchor('#Return_value_burst')" type="button"><span class="property-name">burst</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_burst" class="collapse property-definition-div" data-parent="#accordionReturn_value_burst" id="Return_value_burst">
    <div class="card-body pl-5">
    <h4>Burst</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>Send a burst of packets when the server is reachable.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_iburst">
    <div class="card">
    <div class="card-header" id="headingReturn_value_iburst">
    <h2 class="mb-0">
    <button aria-controls="Return_value_iburst" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_iburst" data-toggle="collapse" onclick="setAnchor('#Return_value_iburst')" type="button"><span class="property-name">iburst</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_iburst" class="collapse property-definition-div" data-parent="#accordionReturn_value_iburst" id="Return_value_iburst">
    <div class="card-body pl-5">
    <h4>Iburst</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>Send a burst of packets when the server is unreachable.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_prefer">
    <div class="card">
    <div class="card-header" id="headingReturn_value_prefer">
    <h2 class="mb-0">
    <button aria-controls="Return_value_prefer" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_prefer" data-toggle="collapse" onclick="setAnchor('#Return_value_prefer')" type="button"><span class="property-name">prefer</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_prefer" class="collapse property-definition-div" data-parent="#accordionReturn_value_prefer" id="Return_value_prefer">
    <div class="card-body pl-5">
    <h4>Prefer</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>Mark this server as preferred for time synchronization.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_minpoll">
    <div class="card">
    <div class="card-header" id="headingReturn_value_minpoll">
    <h2 class="mb-0">
    <button aria-controls="Return_value_minpoll" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_minpoll" data-toggle="collapse" onclick="setAnchor('#Return_value_minpoll')" type="button"><span class="property-name">minpoll</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_minpoll" class="collapse property-definition-div" data-parent="#accordionReturn_value_minpoll" id="Return_value_minpoll">
    <div class="card-body pl-5">
    <h4>Minpoll</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 6</span><br/>
    <span class="description"><p>Minimum polling interval (log2 seconds).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_maxpoll">
    <div class="card">
    <div class="card-header" id="headingReturn_value_maxpoll">
    <h2 class="mb-0">
    <button aria-controls="Return_value_maxpoll" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_maxpoll" data-toggle="collapse" onclick="setAnchor('#Return_value_maxpoll')" type="button"><span class="property-name">maxpoll</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_maxpoll" class="collapse property-definition-div" data-parent="#accordionReturn_value_maxpoll" id="Return_value_maxpoll">
    <div class="card-body pl-5">
    <h4>Maxpoll</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 10</span><br/>
    <span class="description"><p>Maximum polling interval (log2 seconds).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_nts">
    <div class="card">
    <div class="card-header" id="headingReturn_value_nts">
    <h2 class="mb-0">
    <button aria-controls="Return_value_nts" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_nts" data-toggle="collapse" onclick="setAnchor('#Return_value_nts')" type="button"><span class="property-name">nts</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_nts" class="collapse property-definition-div" data-parent="#accordionReturn_value_nts" id="Return_value_nts">
    <div class="card-body pl-5">
    <h4>Nts</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>Use Network Time Security (NTS) to authenticate this server.</p>
    <p>The server must support NTS key establishment on TCP port 4460. This system must trust the TLS certificate of the server. The certificate must match <code>address</code>. If <code>address</code> is an IP address, the certificate must include that IP address. The system clock must be approximately correct for the certificate check.</p>
    <p>When at least one NTS server is configured, the system ignores servers without NTS. This includes servers from DHCP. If no NTS server is reachable, the system does not adjust the clock.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* NETWORK_GENERAL_WRITE

