settings backup

The settings backup command manages the system backups of the device: it lists the existing backups, creates a new backup, shows the detail of a backup and restores the selected backup.

Restoring cannot be undone

When apply runs, the whole of the current configuration is replaced with the content of the backup. The operation restarts the system services and can lead to a temporary unavailability; after a successful application the system is reloaded. This command does not show a confirmation screen — it starts to run the moment it is written.

Command Summary

TR7 WEB-CLI · settings backup

# Tab after the command

admin@TR7LBWAF01> settings backup

apply create list show

 

admin@TR7LBWAF01> settings backup list # list the backups

admin@TR7LBWAF01> settings backup create # take a new backup

admin@TR7LBWAF01> settings backup show <file> # the detail

admin@TR7LBWAF01> settings backup apply <file> # restore

admin@TR7LBWAF01>  

On this resource there are no update and delete actions: the backups are not changed, they are only created and applied.

list — Listing the Backups

It lists the backup files on the device. On every row the file name, the display name, the creation date and the size in bytes take place.

Field	What it does	What is written after it
--days	Determines the backups created within how many days will be listed	1 or a larger integer (the default is 7)

create — Creating a New Backup

It creates a new backup file that contains the whole system configuration, its settings and its data.

Field	What it does	What is written after it
--name	Determines the name to be given to the backup	A backup name. When it is left empty, a name carrying a time stamp is produced

Taking a backup takes time

According to the endpoint explanation, the operation can take a few minutes depending on the size of the system. The command returns the file name, the name, the date and the size of the backup created.

show — The Backup Detail

It shows the file name, the display name, the creation date and the size of the stated backup file.

Order	Field	Status	Value
1	filename	Required	The backup whose detail will be displayed. The field name is not written, the file name is written directly; Tab lists the existing ones

apply — Restoring the Backup

It returns the system to the state the selected backup carries.

Order	Field	Status	Value
1	filename	Required	The backup that will be restored. The field name is not written, the file name is written directly; Tab lists the existing ones

Examples

TR7 WEB-CLI · the backup flow

# 1) take a named backup before a change

admin@TR7LBWAF01> settings backup create --name "before-the-vhost-change"

 

# 2) see the backups of the last 30 days

admin@TR7LBWAF01> settings backup list --days 30

 

# 3) look at whether it is the right file before applying

admin@TR7LBWAF01> settings backup show <file>

 

# 4) restore — it does not ask for confirmation, the system is reloaded

admin@TR7LBWAF01> settings backup apply <file>

admin@TR7LBWAF01>  

Things to Know

• Restoring changes everything. According to the endpoint explanation, the whole of the current configuration is replaced with the content of the backup, the services are restarted and the operation cannot be undone. A current backup must have been taken before applying.
• There is no confirmation screen. The apply command runs the moment it is written; it should not be applied without the file name being verified with show.
• The listing covers the last 7 days by default. For older backups the --days value is raised.
• Giving a name makes finding the backup easier. When --name is left empty, a name with a time stamp is produced; giving a speaking name to the backup taken before a planned change makes the rollback easier.
• The backups can be sent out. Transferring a copy of the backup files to another server is configured with settings file-transport.
• The backups on the disk can be cleaned up by themselves. The thresholds that manage the removal of the old data when the disk fills up are in the settings disk-management command.