TrueNAS SCALETrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

UPS Services Screen

The Services > UPS screen settings specify connection, shutdown and other settings to configure UPS service for servers running TrueNAS SCALE.

TrueNAS uses NUT (Network UPS Tools) to provide UPS support. For supported device and driver information, see their hardware compatibility list.

Report UPS bugs and feature requests to the NUT project.

Click to open the Services > UPS configuration screen.

TrueNAS Enterprise
TrueNAS High Availability (HA) systems are not compatible with uninterruptible power supplies (UPS).

General Options and Monitor Settings

General Options setting specify required UPS mode and connection. These settings change based on the Master or Slave UPS mode setting.

UPS Options
Figure 1: UPS Options
IdentifierRequired. Type a description for the UPS device. You can use alphanumeric, period (.), comma (,), hyphen (-), and underscore (_) characters.
UPS ModeSelect the either Master or Slave mode from the dropdown list. Select Master if the UPS is plugged directly into the system serial port, or Slave to shut down this system before the master system. Slave displays the Remote Hostname and Remote Port fields, and removes the Driver field. The UPS remains the last item to shut down. See the Network UPS Tools Overview.
Remote HostRequired. Enter a valid IP address for the remote system with the UPS Mode set to Master. This field displays only when UPS Mode is set to Slave.
Remote PortRequired. Enter the open network port number of the UPS master system. The default port is 3493. This field displays only when UPS Mode is set to Slave.
DriverRequired. Enter or select the device driver from the dropdown list. See the Network UPS Tools compatibility list for a list of supported UPS devices. This field displays only when UPS Mode is set to Master.
Port or HostnameRequired. Enter or select the serial or USB port connected to the UPS from the dropdown list. Options include a list of port on your system and auto. Select auto to automatically detect and manage the USB port settings.
When selecting an SNMP driver, enter the IP address or host name of the SNMP UPS device.

Monitor Settings

Monitor settings specify the primary username and password, other users that have administrative access to the UPS service, and whether the default configuration listens on all interfaces.

Monitor UserEnter a user to associate with this service. Keeping the default is recommended.
Monitor PasswordChange the default password to improve system security. The new password cannot include a space or #.
Extra UsersEnter accounts that have administrative access. See upsd.users(5) for examples.
Remote MonitorSelect to have the default configuration to listen on all interfaces using the known values of user: upsmon and password: fixmepass.

Shutdown Settings

Shutdown settings specify the UPS shutdown mode, command, and timer for the UPS service.

UPS Service Shutdown Settings
Figure 2: UPS Service Shutdown Settings
Shutdown ModeSelect the battery option to used when the UPS initiates shutdown from the dropdown list. Options are UPS reaches low battery or UPS goes on battery.
Shutdown TimerEnter a value in seconds for the UPS to wait before initiating shutdown. Shutdown does not occur if power is restored while the timer is counting down. This value only applies when Shutdown Mode is set to UPS goes on battery.
Shutdown CommandEnter a command to shut down the system when either battery power is low or the shutdown timer ends.
Power off UPSSelect to power off the UPS after shutting down the system.

Other Options Settings

Other Options settings specify warning and host sync times, a description for the UPS, and any additional parameters you want to apply to the UPS service.

UPS Service Other Options
Figure 3: UPS Service Other Options
No Communication Warning TimeEnter the number of seconds to wait before alerting that the service cannot reach any UPS. Warnings continue until the situation is fixed.
Host SyncUpsmon waits up to this many seconds in master mode for the slaves to disconnect during a shutdown situation.
DescriptionEnter a description for this service.
Auxiliary Parameters (ups.conf)Enter any extra options from ups.conf.
Auxiliary Parameters (upsd.conf)Enter any extra options from upsd.conf.