Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

system backup-restore-mail

Use this command to configure backup and restoration of email user’s mailboxes.

For the initial backup, whether manually or automatically initiated, the FortiMail unit will make a full backup. For subsequent backups, the FortiMail unit will make the number of incremental backups, then make another full backup, and repeat this until it reaches the maximum number of full backups to keep on the backup media, which you selected in full <full-backups_int>. At that point, it will overwrite the oldest full backup.

For example, if full <full-backups_int> is 3 and monthly-incremental-days is 4, the FortiMail unit would make a full backup, then 4 incremental backups. It would repeat this two more times for a total of 3 backup sets, and then overwrite the oldest full backup when creating the next backup.

Syntax

config system backup-restore-mail

set encryption-key <key>

set folder <path_str>

set full <full-backups_int>

set host <fortimail-fqdn_str>

set hour-of-day <hours_int>

set monthly-day-of-month

set monthly-incremental-days

set number-of-backups

set port <port_int>

set protocol {ext-usb | ext-usb-auto | iscsi_server | nfs | smb-winserver | ssh}

set status {enable | disable}

end

Variable

Description

Default

encryption-key <key>

Enter the encryption key for backup/restore.

 

folder <path_str>

Enter the path of the folder on the backup server where the FortiMail unit will store the mailbox backups, such as:

/home/fortimail/mailboxbackups

This field appears only if the backup media is an NFS server or SSH server.

FortiMail-mail-data-backup

full <full-backups_int>

Enter the total number of full backups to keep on the backup media. Valid values are between 1 and 10.

3

host <fortimail-fqdn_str>

If you want to restore all mailboxes from a backup labeled with the fully qualified domain name (FQDN) of a previous FQDN, or that of another FortiMail unit, enter the FQDN of the backup that you want to restore.

For example, to restore the most recent backup made by a FortiMail unit named fortimail.example.com, enter fortimail.example.com.

 

hour-of-day <hours_int>

Enter the hour of the day, according to a 24-hour clock, on the days of the week at which to make backups.

For example, to make backups at 9 PM, enter 21.

23

monthly-day-of-month

Enter the day of the month to perform the full backup.

 

monthly-incremental-days

Enter how often to perform the monthly incremental backup.

 

number-of-backups

Enter the number of full backups to keep.

 

port <port_int>

Enter the TCP port number on which the backup server listens for connections.

This field does not appear if the backup media is a USB disk.

22

protocol {ext-usb | ext-usb-auto | iscsi_server | nfs | smb-winserver | ssh}

Enter one of the following types of backup media:

ext-usb: An external hard drive connected to the FortiMail unit’s USB port.

ext-usb-auto: An external disk connected to the FortiMail unit’s USB port. Unlike the previous option, this option only creates a backup when you connect the USB disk, or when you manually initiate a backup rather than according to a schedule.

iscsi_server: An Internet SCSI (Small Computer System Interface), also called iSCSI, server.

nfs: A network file system (NFS) server.

smb/winserver: A Windows-style file share.

ssh: A server that supports secure shell (SSH) connections.

Other available options vary by your choice of backup media.

nfs

status {enable | disable}

Enable to allow backups and restoration to occur, whether manually initiated or automatically performed on schedule. Also configure the backup media in protocol {ext-usb | ext-usb-auto | iscsi_server | nfs | smb-winserver | ssh} and, if applicable to the type of the media, configure a schedule in encryption-key <key> and hour-of-day <hours_int>

Note:You should enable backups/restoration after configuring the other options if a scheduled backup will occur before you configure protocol {ext-usb | ext-usb-auto | iscsi_server | nfs | smb-winserver | ssh}. Failure to do so would result in a failed backup attempt, requiring you to wait for the failed attempt to terminate before you can continue to configure this feature.

disable

Related topics

system link-monitor

system backup-restore-mail

Use this command to configure backup and restoration of email user’s mailboxes.

For the initial backup, whether manually or automatically initiated, the FortiMail unit will make a full backup. For subsequent backups, the FortiMail unit will make the number of incremental backups, then make another full backup, and repeat this until it reaches the maximum number of full backups to keep on the backup media, which you selected in full <full-backups_int>. At that point, it will overwrite the oldest full backup.

For example, if full <full-backups_int> is 3 and monthly-incremental-days is 4, the FortiMail unit would make a full backup, then 4 incremental backups. It would repeat this two more times for a total of 3 backup sets, and then overwrite the oldest full backup when creating the next backup.

Syntax

config system backup-restore-mail

set encryption-key <key>

set folder <path_str>

set full <full-backups_int>

set host <fortimail-fqdn_str>

set hour-of-day <hours_int>

set monthly-day-of-month

set monthly-incremental-days

set number-of-backups

set port <port_int>

set protocol {ext-usb | ext-usb-auto | iscsi_server | nfs | smb-winserver | ssh}

set status {enable | disable}

end

Variable

Description

Default

encryption-key <key>

Enter the encryption key for backup/restore.

 

folder <path_str>

Enter the path of the folder on the backup server where the FortiMail unit will store the mailbox backups, such as:

/home/fortimail/mailboxbackups

This field appears only if the backup media is an NFS server or SSH server.

FortiMail-mail-data-backup

full <full-backups_int>

Enter the total number of full backups to keep on the backup media. Valid values are between 1 and 10.

3

host <fortimail-fqdn_str>

If you want to restore all mailboxes from a backup labeled with the fully qualified domain name (FQDN) of a previous FQDN, or that of another FortiMail unit, enter the FQDN of the backup that you want to restore.

For example, to restore the most recent backup made by a FortiMail unit named fortimail.example.com, enter fortimail.example.com.

 

hour-of-day <hours_int>

Enter the hour of the day, according to a 24-hour clock, on the days of the week at which to make backups.

For example, to make backups at 9 PM, enter 21.

23

monthly-day-of-month

Enter the day of the month to perform the full backup.

 

monthly-incremental-days

Enter how often to perform the monthly incremental backup.

 

number-of-backups

Enter the number of full backups to keep.

 

port <port_int>

Enter the TCP port number on which the backup server listens for connections.

This field does not appear if the backup media is a USB disk.

22

protocol {ext-usb | ext-usb-auto | iscsi_server | nfs | smb-winserver | ssh}

Enter one of the following types of backup media:

ext-usb: An external hard drive connected to the FortiMail unit’s USB port.

ext-usb-auto: An external disk connected to the FortiMail unit’s USB port. Unlike the previous option, this option only creates a backup when you connect the USB disk, or when you manually initiate a backup rather than according to a schedule.

iscsi_server: An Internet SCSI (Small Computer System Interface), also called iSCSI, server.

nfs: A network file system (NFS) server.

smb/winserver: A Windows-style file share.

ssh: A server that supports secure shell (SSH) connections.

Other available options vary by your choice of backup media.

nfs

status {enable | disable}

Enable to allow backups and restoration to occur, whether manually initiated or automatically performed on schedule. Also configure the backup media in protocol {ext-usb | ext-usb-auto | iscsi_server | nfs | smb-winserver | ssh} and, if applicable to the type of the media, configure a schedule in encryption-key <key> and hour-of-day <hours_int>

Note:You should enable backups/restoration after configuring the other options if a scheduled backup will occur before you configure protocol {ext-usb | ext-usb-auto | iscsi_server | nfs | smb-winserver | ssh}. Failure to do so would result in a failed backup attempt, requiring you to wait for the failed attempt to terminate before you can continue to configure this feature.

disable

Related topics

system link-monitor