TrueNAS SCALE Nightly Development DocumentationThis content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.
Failover
7 minute read.
Last Modified 2024-03-15 13:07 EDTThe SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!
TrueNAS EnterpriseOn licensed systems, use the Failover namespace to manage HA system controllers and failover operations for Enterprise customer. Systems without an Enterprise license do not use this namespace.
The failover namespace has 14 commands and is based on failover functions found in the SCALE API and web UI. It provides access to Enterprise HA customer management methods through the failover namespace commands.
The following failover namespace commands allow you to perform failover operations for Enterprise customer systems.
You can enter commands from the main CLI prompt or from the failover namespace prompt.
Enter the
--
flag following any CLI command to open the interactive arguments editor text-based user interface (TUI).
The config
command displays failover configuration setting (ID, disabled status, timeout, and master/slave) information.
The control
command provides enabled/disabled status of failover control.
The disabled
command returns a list of reasons if the system failover is disabled.
The force_master
command forces the current controller to become master if it is the standby.
The get_ips
command returns a list of IP addresses configured for the failover service but not details on what they are assigned to.
The hardware
command returns the failover configuration information.
The in_progress
command provides verification of an in-progress failover event.
The licensed
command checks whether this system is licensed as an HA system.
The node
command returns the controller (node) status.
The status
command returns the current HA status as either master or slave.
The sync_from_peer
command sync failover configuration settings from the other controller.
This command is the same as the Sync From Peer function on the Failover Screen.
The sync_to_peer
command initiates a sync operation that copies over the primary controller configuration to the standby controller.
This command is the same as the Sync To Peer function on the Failover Screen.
The upgrade_pending
command verifies if HA upgrade is pending.
Use upgrade_finish
to finish the HA upgrade process if this command returns true.
The upgrade_finish
command perform the last stage of an HA upgrade and activates the new boot environment on the standby controller after it reboots.