Fortinet black logo

CLI Reference

backup-restore

backup-restore

Use this command to back up or restore email users’ mailboxes. Before using this command, you must specify the backup destination or the restore location first. For details, see system backup-restore-mail.

Syntax

execute backup-restore all-restore

execute backup-restore check-device

execute backup-restore format-device

execute backup-restore old-restore <full_int> <increments_int> domain <domain_str> user <user_str>

execute backup-restore restore {domain <domain> user <user> | host <host>}

execute backup-restore start

execute backup-restore stop

Variable

Description

Default

all-restore

Use this command to restore mail data without deleting previous full restore while restoring incremental backup.

check-device

Performs file system check on the backup device.

format-device

Format the backup device as a preparation step before backup.

old-restore <full_int> <increments_int> domain <domain_str> user <user_str>

<full_int> is the full backup version you specify when you configure the backup settings.

<increments_int> is the number of incremental backups to make between each full backup.

<domain_str>: optionally specify which domain’s mailbox will be restored.

<user_str>: optionally specify which user’s mailbox will be restored.

For details, see system backup-restore-mail.

restore {domain <domain> user <user> | host <host>}

Restores mailboxes, or optionally, for the specified domain or user.

If you want to restore mailboxes from backups identified by another FQDN, such as a previous FQDN or the FQDN of another FortiMail unit, specify the <host>, which is the FQDN.

Usually, you should enter an FQDN of this FortiMail unit, but you may enter only the host name if the local domain name is not configured, or enter the FQDN of another FortiMail unit if you want to import that FortiMail unit’s mailbox backup.

For example, you may be upgrading to a FortiMail-2000 from a FortiMail-400. Previously, you have used a USB disk to store a backup of the mailboxes of the FortiMail‑400, whose fully qualified domain name (FQDN) was fortimail.example.com. You have then configured the FortiMail-2000 to also use the USB disk as its backup media. You could then import the FortiMail-400’s mailbox backup to the FortiMail-2000 by entering fortimail.example.com in this field on the FortiMail-2000’s web UI.

start

Initiate an immediate backup. Note that all data on the backup device will be erased.

stop

Stops any currently running backups.

Related topics

restore config

backup

backup-restore

Use this command to back up or restore email users’ mailboxes. Before using this command, you must specify the backup destination or the restore location first. For details, see system backup-restore-mail.

Syntax

execute backup-restore all-restore

execute backup-restore check-device

execute backup-restore format-device

execute backup-restore old-restore <full_int> <increments_int> domain <domain_str> user <user_str>

execute backup-restore restore {domain <domain> user <user> | host <host>}

execute backup-restore start

execute backup-restore stop

Variable

Description

Default

all-restore

Use this command to restore mail data without deleting previous full restore while restoring incremental backup.

check-device

Performs file system check on the backup device.

format-device

Format the backup device as a preparation step before backup.

old-restore <full_int> <increments_int> domain <domain_str> user <user_str>

<full_int> is the full backup version you specify when you configure the backup settings.

<increments_int> is the number of incremental backups to make between each full backup.

<domain_str>: optionally specify which domain’s mailbox will be restored.

<user_str>: optionally specify which user’s mailbox will be restored.

For details, see system backup-restore-mail.

restore {domain <domain> user <user> | host <host>}

Restores mailboxes, or optionally, for the specified domain or user.

If you want to restore mailboxes from backups identified by another FQDN, such as a previous FQDN or the FQDN of another FortiMail unit, specify the <host>, which is the FQDN.

Usually, you should enter an FQDN of this FortiMail unit, but you may enter only the host name if the local domain name is not configured, or enter the FQDN of another FortiMail unit if you want to import that FortiMail unit’s mailbox backup.

For example, you may be upgrading to a FortiMail-2000 from a FortiMail-400. Previously, you have used a USB disk to store a backup of the mailboxes of the FortiMail‑400, whose fully qualified domain name (FQDN) was fortimail.example.com. You have then configured the FortiMail-2000 to also use the USB disk as its backup media. You could then import the FortiMail-400’s mailbox backup to the FortiMail-2000 by entering fortimail.example.com in this field on the FortiMail-2000’s web UI.

start

Initiate an immediate backup. Note that all data on the backup device will be erased.

stop

Stops any currently running backups.

Related topics

restore config

backup