system.advanced.update¶
Update System Advanced Service Configuration.
No Additional Items
Tuple Validation
Parameter 1: data
data
Type: objectUpdated system advanced configuration data.
No Additional PropertiesAdvancedmode
Type: booleanEnable advanced mode to show additional configuration options in the web interface.
Autotune
Type: booleanExecute autotune script which attempts to optimize the system based on the installed hardware.
Kdump Enabled
Type: booleanEnable kernel crash dumps for debugging system crashes.
Boot Scrub
Type: integerNumber of days between automatic boot pool scrubs.
Value must be strictly greater than 0
Consolemsg
Type: booleanDeprecated: Please use consolemsg
attribute in the system.general
plugin instead.
Debugkernel
Type: booleanEnable debug kernel for additional logging and debugging capabilities.
Fqdn Syslog
Type: booleanInclude the full domain name in syslog messages.
Motd
Type: stringMessage of the day displayed after login.
Login Banner
Type: stringBanner message displayed before login prompt.
Must be at most 4096
characters long
Powerdaemon
Type: booleanEnable the power management daemon for automatic power management.
Serialconsole
Type: booleanEnable serial console access.
Serialport
Type: stringSerial port device for console access.
Serialspeed
Type: enum (of string)Baud rate for serial console communication.
Must be one of:
- "9600"
- "19200"
- "38400"
- "57600"
- "115200"
Overprovision
Percentage of SSD overprovisioning to reserve for wear leveling.
Value must be greater or equal to 0
Traceback
Type: booleanEnable generation and saving of tracebacks for debugging.
Uploadcrash
Type: booleanAutomatically upload crash reports to iXsystems for analysis.
Anonstats
Type: booleanEnable anonymous usage statistics reporting to help improve TrueNAS.
Sed User
Type: enum (of string)SED (Self-Encrypting Drive) user type for drive encryption.
Must be one of:
- "USER"
- "MASTER"
Sysloglevel
Type: enum (of string)Minimum log level for syslog messages. FEMERG is most critical, FDEBUG is least critical.
Must be one of:
- "F_EMERG"
- "F_ALERT"
- "F_CRIT"
- "F_ERR"
- "F_WARNING"
- "F_NOTICE"
- "F_INFO"
- "F_DEBUG"
Syslogserver
Type: stringRemote syslog server DNS hostname or IP address. Nonstandard port numbers can be used by adding a colon and the port number to the hostname, like mysyslogserver:1928. Setting this field enables the remote syslog function.
Syslog Transport
Type: enum (of string)Transport Protocol for the remote system log server connection. Choosing Transport Layer Security (TLS) also requires selecting a preconfigured system Certificate.
Must be one of:
- "UDP"
- "TCP"
- "TLS"
Syslog Tls Certificate
Certificate ID for TLS-encrypted syslog connections or null
for no certificate.
Syslog Audit
Type: booleanThe remote syslog server will also receive audit messages.
Kernel Extra Options
Type: stringAdditional kernel boot parameters to pass to the Linux kernel.
Sed Passwd
Type: stringPassword for SED (Self-Encrypting Drive) global unlock.
SystemAdvancedEntry
Type: objectThe updated system advanced configuration.
No Additional PropertiesId
Type: integerPlaceholder identifier. Not used as there is only one.
Advancedmode
Type: booleanEnable advanced mode to show additional configuration options in the web interface.
Autotune
Type: booleanExecute autotune script which attempts to optimize the system based on the installed hardware.
Kdump Enabled
Type: booleanEnable kernel crash dumps for debugging system crashes.
Boot Scrub
Type: integerNumber of days between automatic boot pool scrubs.
Value must be strictly greater than 0
Consolemsg
Type: booleanDeprecated: Please use consolemsg
attribute in the system.general
plugin instead.
Debugkernel
Type: booleanEnable debug kernel for additional logging and debugging capabilities.
Fqdn Syslog
Type: booleanInclude the full domain name in syslog messages.
Motd
Type: stringMessage of the day displayed after login.
Login Banner
Type: stringBanner message displayed before login prompt.
Must be at most 4096
characters long
Powerdaemon
Type: booleanEnable the power management daemon for automatic power management.
Serialconsole
Type: booleanEnable serial console access.
Serialport
Type: stringSerial port device for console access.
Anonstats Token
Type: stringToken used for anonymous statistics reporting.
Serialspeed
Type: enum (of string)Baud rate for serial console communication.
Must be one of:
- "9600"
- "19200"
- "38400"
- "57600"
- "115200"
Overprovision
Percentage of SSD overprovisioning to reserve for wear leveling.
Value must be greater or equal to 0
Traceback
Type: booleanEnable generation and saving of tracebacks for debugging.
Uploadcrash
Type: booleanAutomatically upload crash reports to iXsystems for analysis.
Anonstats
Type: booleanEnable anonymous usage statistics reporting to help improve TrueNAS.
Sed User
Type: enum (of string)SED (Self-Encrypting Drive) user type for drive encryption.
Must be one of:
- "USER"
- "MASTER"
Sysloglevel
Type: enum (of string)Minimum log level for syslog messages. FEMERG is most critical, FDEBUG is least critical.
Must be one of:
- "F_EMERG"
- "F_ALERT"
- "F_CRIT"
- "F_ERR"
- "F_WARNING"
- "F_NOTICE"
- "F_INFO"
- "F_DEBUG"
Syslogserver
Type: stringRemote syslog server DNS hostname or IP address. Nonstandard port numbers can be used by adding a colon and the port number to the hostname, like mysyslogserver:1928. Setting this field enables the remote syslog function.
Syslog Transport
Type: enum (of string)Transport Protocol for the remote system log server connection. Choosing Transport Layer Security (TLS) also requires selecting a preconfigured system Certificate.
Must be one of:
- "UDP"
- "TCP"
- "TLS"
Syslog Tls Certificate
Certificate ID for TLS-encrypted syslog connections or null
for no certificate.
Syslog Audit
Type: booleanThe remote syslog server will also receive audit messages.
Isolated Gpu Pci Ids
Type: array of stringList of GPU PCI IDs to isolate from the host system for VM passthrough.
No Additional ItemsEach item of this array must be:
Kernel Extra Options
Type: stringAdditional kernel boot parameters to pass to the Linux kernel.
Required roles: SYSTEM_ADVANCED_WRITE