Establish Failover for Planned Maintenance
These flows depend on using the backup settings described in the topic Establish Failover Settings for Primary and Backup Environments.
This is the preferred method of maintenance. This method provides a path for ensuring that all settings, recordings, and data will be migrated from original primary to new primary, then back to the original primary. This method is also sufficient for upgrading appliances as well.
- Go to the primary or backup failover page at /login > Management > Failover.
- Click Check this box to pull a data-sync from the site instance while becoming the backup. next to Become <role>.
- Click Become <role> and wait.
- The page will come back and a data-sync will be in progress.
- All clients will be disconnected from the appliance and will not be able to log back in during this time. This ensures no new session data is generated during the sync.
- When the sync is over, the roles will swap, assuming both sides are reachable.
- Do not panic if you refresh the page and the roles are both Backup momentarily. The role swap is handled serially, so it will only be a moment that this does occur. Wait a little longer and the old backup should become primary.
- If necessary, swing DNS or the NAT after you see that the roles swap. If configured for Shared IP, skip this step.
- The original backup appliance is now the primary appliance.
- Perform maintenance on the primary.
Note: During failover sync, /login settings on the currently active primary take precedence over those found on the backup appliance. This means that in case of conflicts, changes to the /login settings of the current primary will overwrite those of the backup site during failover sync. If you make changes to the backup site, consider noting the changes or downloading a Backup (without logged history) from the Management tab.
- During this time, track any changes made in /login of the new primary site.
- Sessions may be performed normally.
- The settings of the current primary may be modified in the /login interface just as if it were the normal primary. They will not be lost when the original primary takes over again.
- When the primary is ready to resume its normal duties, and is back on the network:
- Repeat steps 1-4, but change the original primary to back to primary.
Instead of going to the /login interface to change roles, you can use the BeyondTrust failover API. For details, see Establish Failover Settings for Primary and Backup Environments.