(408) 943-4100               V   Commercial Support Toggle between Light and Dark mode

Advanced Settings

  5 minute read.

Last Modified 2021-07-08 16:29 EDT

The TrueNAS SCALE Advanced Settings section provides configuration options for the Console, Syslog, Sysctl, Kernel, Cron Jobs, Init/Shutdown Scripts, System Dataset Pool, and Isolated GPU Device(s).

Advanced Settings have reasonable defaults in place. Changing advanced settings can be dangerous when done incorrectly. Please use caution before saving. Make sure you are comfortable with ZFS, Linux, and system configuration backup and restoration before making any changes.

AdvancedSettingsSCALE

Console

The Console window allows users to configure the Console Setup menu.

NameDescription
Show Text Console without Password PromptUnset to add a login prompt to the system before the console menu is shown.
Enable Serial ConsoleDo not set this if the Serial Port is disabled.
Serial PortThe serial console port address.
Serial SpeedThe speed (in bits per second) the serial port uses.
MOTD BannerThe message that displays when a user logs in with SSH.

Syslog

The Syslog window lets users configure how and when the system sends log messages to the Syslog server.

NameDescription
Use FQDN for LoggingSet to include the Fully-Qualified Domain Name (FQDN) in logs to precisely identify systems with similar hostnames.
Syslog LevelWhen Syslog Server is defined, only logs matching this level are sent.
Syslog ServerRemote 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. Log entries are written to local logs and sent to the remote syslog server.
Syslog TransportTransport Protocol for the remote system log server connection. Choosing Transport Layer Security (TLS) also requires selecting a preconfigured system Certificate.
Use System DatasetStore system logs on the system dataset. Unset to store system logs in /var/ on the operating system device.

Sysctl

The Sysctl window lets users set up tunables that configure kernel parameters at runtime.

NameDescription
VariableEnter the name of the loader, sysctl, or rc.conf variable to configure. loader tunables are used to specify parameters to pass to the kernel or load additional modules at boot time. rc.conf tunables are for enabling system services and daemons and only take effect after a reboot. sysctl tunables are used to configure kernel parameters while the system is running and generally take effect immediately.
ValueEnter a value to use for the loader, sysctl, or rc.conf variable.
DescriptionEnter a description of the tunable.
EnabledEnable this tunable. Unset to disable this tunable without deleting it.

Kernel

The Kernel window contains options for system optimization and kernel debugging.

NameDescription
Enable AutotuneActivates a tuning script that attempts to optimize the system depending on the installed hardware. Warning: Autotuning is only used as a temporary measure and is not a permanent fix for system hardware issues.
Enable Debug KernelSet to boot a debug kernel after the next system reboot.

Cron Jobs

The Cron Jobs window allows users to configure jobs that run specific commands or scripts on a regular schedule using cron(8). Cron Jobs help run repetitive tasks.

NameDescription
DescriptionEnter a description of the cron job.
CommandEnter the full path to the command or script to be run.
Run As UserSelect a user account to run the command. The user must have permissions allowing them to run the command or script.
ScheduleSelect a schedule preset or choose Custom to open the advanced scheduler. Note that an in-progress cron task postpones any later scheduled instance of the same task until the running task is complete.
Hide Standard OutputHide standard output (stdout) from the command. When unset, any standard output is mailed to the user account cron used to run the command.
Hide Standard ErrorHide error output (stderr) from the command. When unset, any error output is mailed to the user account cron used to run the command.
EnabledEnable this cron job. When unset, disable the cron job without deleting it.

Init/Shutdown Scripts

The Init/Shutdown Scripts window allows users to schedule commands or scripts to run at system startup or shutdown.

NameDescription
DescriptionComments about this script.
TypeSelect Command for an executable or Script for an executable script.
CommandEnter the command with any options.
ScriptSelect the script. The script will be run using dash(1).
WhenSelect when the command or script runs:
Pre Init is early in the boot process, after mounting filesystems and starting networking.
Post Init is at the end of the boot process, before FreeNAS services start.
Shutdown is during the system power-off process.
EnabledEnable this cron job. When unset, disable the cron job without deleting it.
TimeoutAutomatically stop the script or command after the specified seconds.

System Dataset Pool

The System Dataset Pool window allows users to select the storage pool to keep the system dataset in. The system dataset stores debugging core files, encryption keys for encrypted pools, and Samba4 metadata such as the user and group cache and share level permissions.

Users can move the system dataset to unencrypted pools or encrypted pools that do not have passphrases.

If you move the system dataset to an encrypted pool, that pool is no longer allowed to have a passphrase. If the encrypted pool already has a passphrase set, you cannot move the system dataset to the pool.

Isolated GPU Device(s)

The Isolated GPU Device(s) window gives users the option to isolate extra GPU devices for GPU passthrough.

GPU passthrough allows the TrueNAS SCALE kernel to directly present an internal PCI GPU to a virtual machine (VM).

The selected GPU device will act like it’s driven by the VM, and the VM detects the GPU as if it were physically connected.