Fortinet black logo

CLI Reference

backup

backup

Use this command to back up the configuration file to either a TFTP server or FortiManager (management-station).

This command does not produce a complete backup. For information on how to back up other configuration files such as Bayesian databases, see the FortiMail Administration Guide.

Syntax

execute backup {config | full-config | ibe-data | mail-queue | user-config}

{tftp <filename_str> <tftp_ipv4> [<password_str>] | management-station [<comments_str>]}

Variable

Description

Default

{config | full-config | ibe-data | mail-queue | user-config}

Type either:

  • config: Back up configuration changes only. The default settings will not be backed up.
  • full-config: Back up the entire configuration file (no default settings either), including the IBE data and user config.
  • ibe-data: Back up the IBE data.
  • mail-queue: Back up the mail queues.
  • user-config: Back up the user-specific configurations, such as user preferences, personal block/safelists, and secondary addresses. Before backing up, you should update the user configuration file. To update the configurations, see user-config.

<filename_str>

Type the file name that will be used for the backup file, such as fortimail_backup.txt.

<tftp_ipv4>

Type the IP address of the TFTP server.

[<password_str>]

Type a password that will be used to encrypt the backup file, and which must be provided when restoring the backup file.

If you do not provide a password, the backup file is stored as clear text.

[<comments_str>]

If you are adding a comment, do not add spaces, underscore characters ( _ ), or quotation marks ( “ ) or any other punctuation marks.

Example

This example uploads a password-encrypted partial configuration backup to a TFTP server.

execute backup full-config tftp fortimail_backup.cfg 172.16.1. 1 P@ssword1

No user configuration available!

Do you want to continue? (y/n)y

No IBE data available!

Do you want to continue? (y/n)y

System time: Tue Sep 27 13:07:43 2011

Backup with current user defined configuration and ibe data. Do you want to continue? (y/n)y

Connect to tftp server 172.16.1.1 ...

Please wait...

Optionally encrypt backup content

For improved confidence and privacy, you can protect the back up configuration file with an encryption password. This password must match when restoring the back up configuration.

Example

execute backup config tftp config1.cfg 1.1.1.1

<Enter>|<passwd> Optional password to protect the backup content.

Related topics

restore config

user-config

backup

Use this command to back up the configuration file to either a TFTP server or FortiManager (management-station).

This command does not produce a complete backup. For information on how to back up other configuration files such as Bayesian databases, see the FortiMail Administration Guide.

Syntax

execute backup {config | full-config | ibe-data | mail-queue | user-config}

{tftp <filename_str> <tftp_ipv4> [<password_str>] | management-station [<comments_str>]}

Variable

Description

Default

{config | full-config | ibe-data | mail-queue | user-config}

Type either:

  • config: Back up configuration changes only. The default settings will not be backed up.
  • full-config: Back up the entire configuration file (no default settings either), including the IBE data and user config.
  • ibe-data: Back up the IBE data.
  • mail-queue: Back up the mail queues.
  • user-config: Back up the user-specific configurations, such as user preferences, personal block/safelists, and secondary addresses. Before backing up, you should update the user configuration file. To update the configurations, see user-config.

<filename_str>

Type the file name that will be used for the backup file, such as fortimail_backup.txt.

<tftp_ipv4>

Type the IP address of the TFTP server.

[<password_str>]

Type a password that will be used to encrypt the backup file, and which must be provided when restoring the backup file.

If you do not provide a password, the backup file is stored as clear text.

[<comments_str>]

If you are adding a comment, do not add spaces, underscore characters ( _ ), or quotation marks ( “ ) or any other punctuation marks.

Example

This example uploads a password-encrypted partial configuration backup to a TFTP server.

execute backup full-config tftp fortimail_backup.cfg 172.16.1. 1 P@ssword1

No user configuration available!

Do you want to continue? (y/n)y

No IBE data available!

Do you want to continue? (y/n)y

System time: Tue Sep 27 13:07:43 2011

Backup with current user defined configuration and ibe data. Do you want to continue? (y/n)y

Connect to tftp server 172.16.1.1 ...

Please wait...

Optionally encrypt backup content

For improved confidence and privacy, you can protect the back up configuration file with an encryption password. This password must match when restoring the back up configuration.

Example

execute backup config tftp config1.cfg 1.1.1.1

<Enter>|<passwd> Optional password to protect the backup content.

Related topics

restore config

user-config