Can I back up and restore the configuration?

Short answer

Yes. On the Settings → Backup & Restore screen, an instant backup is taken with Add by selecting System (current) as the Backup Source; with Apply Backup File in the list, the device is reverted to that backup. The backup contains the network configuration, all Load Balancer objects, the certificates, the WAF, AGS and GTM settings, the general settings and the device users; a restore overwrites the entire configuration, and a restore cannot be done by selecting a single vService. The automatic backup plan is selected from the Backup Settings tab (default Classic (daily), every day at 00:00), and the backups can be sent to an e-mail, FTP or SCP destination with File Forwarding. By default, a Safety Snapshot is taken right before the restore; in a cluster setup, the restore is not transferred to the peer device.

Problem: A Rollback Is Needed After a Configuration Error or a Failure

In case of a wrong change, a device failure or a migration, the configuration needs to be returned to a known point in time. For this, backups need to be taken regularly and also kept outside the device.

Solution: Five Methods

The methods complement each other: the automatic plan is used for regular backups, the manual backup before a critical change, and the off-device copy for a disaster scenario; the rollback is done with Method 2.

Your situation	Suitable method
Taking an instant backup before a change	Method 1: Manual Backup
Returning to a backup	Method 2: Restore
Taking regular backups	Method 3: Automatic Plan
Keeping the backups outside the device	Method 4: Download and File Forwarding
Taking and applying a backup from the command line	Method 5: WEB-CLI

Method 1: Manual Backup Recommended

• How it works The current configuration of the device is saved as a backup file (What Is Backup & Restore?).
• Where it is openedSettings → Backup & Restore → Add
• Requirement Modify permission in the Settings area; among the built-in roles, only Admin has it.
• Scope The entire configuration of the device

Step-by-Step Configuration

1

Adım 1 Open the screen

Configuration Menu → Settings → Backup & Restore is opened; the File List tab appears.

2

Adım 2 Click the Add button

The Add button on the toolbar is clicked; the Add Backup File tab opens.

3

Adım 3 Select the source and the name

In the Backup Source field, System (current) (default) is left selected. Backup Name is optional; if it is left empty, TR7 gives the name.

4

Adım 4 Submit

The Submit button is clicked; the backup is added to the File List.

Verification

1ListTR7 side

The new row in the File list is clicked and the Details section of the preview is checked.

ExpectedBackup trigger: User

Method 2: Restore

• How it works The selected backup is applied in place of the entire configuration; the settings not found in the backup return to default, and the device users and their passwords also return to their state in the backup. Before that, a Safety snapshot is taken by default (Restore).
• Where it is openedFile List → the Apply Backup File icon in the row or Apply Backup File in the preview
• Requirement Modify permission in the Settings area; among the built-in roles, only Admin has it.
• Scope The entire configuration of the device; in a cluster setup, only the device on which the operation is performed

Step-by-Step Configuration

1

Adım 1 Upload the external file (if needed)

If the backup is outside the device, first the Add button is clicked, Backup Source = From File is selected, the .zip file is selected in the Backup File field and it is uploaded with Submit.

2

Adım 2 Click the Apply backup file icon

In the File List, the Apply Backup File icon in the row of the backup (or the Apply Backup File button in the preview) is clicked.

3

Adım 3 Confirm

The Are you sure you want to apply the backup file "<name>"? question is confirmed. The configuration returns to its state in the backup; the device is not restarted.

4

Adım 4 Synchronize the peer device in a cluster

In a cluster setup, the restore is not transferred to the peer device. For the peer device to also switch to the same configuration, the configuration is sent from this device to the peer device with Synchronize on the Settings → Device Management → HA Clustering & Sync screen (Is the configuration automatically synchronized between cluster members?).

Verification

1RecordTR7 side

The File list and the User Logs screen are checked.

ExpectedA new row with Backup trigger: Safety snapshot and an "applied" user record

Method 3: Automatic Plan

• How it worksBackup Plan determines when the backups are taken and how long they are kept.
• Where it is openedBackup & Restore → Backup Settings → Edit
• Requirement Modify permission in the Settings area; among the built-in roles, only Admin has it.
• Scope Automatic backups; Backup Settings are synchronized to the peer device in a cluster

Step-by-Step Configuration

1

Adım 1 Open the Backup Settings tab

On the Backup & Restore screen, the Backup Settings tab is opened and the Edit button is clicked.

2

Adım 2 Select the plan

A selection is made in the Backup Plan field: Classic (daily) (default; every day at the Daily Backup Time, default 00:00, does not delete old backups), Smart (recommended) (daily and after changes; thins out old backups), Strict (hourly) or Custom (the durations and the retention are set manually).

3

Adım 3 Leave the Safety snapshot on

Safety Snapshot Before Critical Operations is on by default and is left on; an automatic backup is taken before critical operations such as a restore.

4

Adım 4 Save

It is saved by clicking the Edit button at the bottom of the form.

Verification

1BackupsTR7 side

The File list is checked after the scheduled time.

ExpectedBackup trigger: Scheduled

Method 4: Download and File Forwarding

• How it works The backup is downloaded manually, or it is sent to the destination automatically each time it is created with a File Forwarding profile.
• Where it is opened The preview of the backup → Download Backup File · Settings → General Settings → File Forwarding
• Requirement For an FTP or SCP destination, access from TR7 to the destination; for e-mail, the SMTP settings.
• Scope Backup files; in a cluster, each device sends its own backups

Step-by-Step Configuration

1

Adım 1 Download manually

The backup is clicked in the File list; the .zip file is downloaded with the Download Backup File button in the preview.

2

Adım 2 Add a File Forwarding profile

For automatic sending, the Add button is clicked on the Settings → General Settings → File Forwarding screen.

3

Adım 3 Select the destination and the backup types

Transport Type (E-Mail, FTP or SCP) and the destination information are entered; in the Backup Types field, the ones to be sent are selected from the Automatic and User types (both are selected by default).

4

Adım 4 Save

The profile is saved by clicking the Add button (Sending the backup to an external destination).

Verification

1DestinationExternal system

After a new backup is taken, the destination is checked.

ExpectedThe .zip file of the backup at the destination

Method 5: WEB-CLI

• How it works With the settings backup commands, the backups are listed, created and applied (settings backup · Command Summary). Deleting, downloading and uploading backups, and the Backup Settings, are done from the interface.
• Where it is openedWEB-CLI
• Requirement CLI access for the user and modify permission in the Settings area.
• Scope The entire configuration of the device

Step-by-Step Configuration

1

Adım 1 Take a backup

A backup is created by giving it a name (create):

settings backup create --name degisiklik-oncesi

2

Adım 2 List the backups

The backups of the last 7 days are listed; for older backups, the --days value is increased (list):

settings backup list
settings backup list --days 30

3

Adım 3 Apply the backup

The file name is listed and selected with Tab (apply); as in the interface, a Safety snapshot is taken before that:

settings backup apply <backup-file>

Verification

1OutputTR7 side

After the backup is created, the settings backup list output is checked.

ExpectedThe backup named degisiklik-oncesi in the list

Common Mistakes

• Using Apply backup file to roll back a single vService. The entire configuration and the device users return to the moment of that backup; a restore is not done by selecting a single object.
• Restoring without taking a backup first. If the Safety snapshot has been turned off, a manual backup is taken first.
• Assuming that the restore passes to the peer device in a cluster. The restore applies only on the device on which the operation is performed; the peer device is synchronized with Synchronize.
• Assuming a list export is a backup. An Excel, CSV or PDF file cannot be restored (Can I export lists as Excel, CSV or PDF?).
• Keeping the backup file where everyone can access it. The file contains the entire configuration and the device users; it is kept in a place with restricted access.
• Assuming the encrypted support bundle is a backup. The support bundle is for diagnosis and cannot be restored (How do I download the encrypted diagnostic bundle for the support team (Encrypted Support Bundle)?).

How it is done in the documentation

• Backup & Restore · What Is Backup & Restore?
• Backup & Restore · Restore
• Backup & Restore · Backup Plan
• File Forwarding · Backup Types

Related questions

• Is the configuration automatically synchronized between cluster members?
• Can I export lists as Excel, CSV or PDF?
• Can I see who made changes and when?