system.ntpserver.get_instance ============================= Returns instance matching `id`. If `id` is not found, Validation error is raised. Please see `query` method documentation for `options`. .. raw:: html
Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
Value must be greater or equal to 0
This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
Value must be greater or equal to 0 and lesser or equal to 10000
Force use of SQL for result filtering to reduce response time. May not work for all methods.
Unique identifier for the NTP server configuration.
Hostname or IP address of the NTP server.
Send a burst of packets when the server is reachable.
Send a burst of packets when the server is unreachable.
Mark this server as preferred for time synchronization.
Minimum polling interval (log2 seconds).
Maximum polling interval (log2 seconds).
Use Network Time Security (NTS) to authenticate this server.
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 address. If address is an IP address, the certificate must include that IP address. The system clock must be approximately correct for the certificate check.
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.