Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

restore

Use this command to:

  • restore the configuration or database from a file
  • change the FortiAnalyzer unit image
  • Restore device logs, DLP archives, and reports from specified servers.

This command will disconnect all sessions and restart the FortiAnalyzer unit.

Syntax

execute restore all-settings {ftp | sftp} <ip:port> <filename> <username> <password> [<crptpasswd>] [option1+option2+...]

execute restore all-settings scp <ip> <filename> <username> <ssh-cert> [<crptpasswd>] [option1+option2+...]

execute restore image ftp <filepath> <ip:port> <username> <password>

execute restore image tftp <filename> <ip>

execute restore logs <device name(s)> {ftp | scp | sftp} <ip> <username> <password> <directory> [vdlist]

execute restore logs-only <device name(s)> {ftp | scp | sftp} <ip> <username> <password> <directory> [vdlist]

execute restore reports <report name(s)> {ftp | scp | sftp} <ip> <username> <password> <directory> [vdlist]

execute restore reports-config {<adom_name> | all]} {ftp | scp | sftp} <ip> <username> <password> <directory> [full]

Variable

Description

all-settings

Restore all FortiAnalyzersettings from a file on a FTP, SFTP, or SCP server. The new settings replace the existing settings, including administrator accounts and passwords.

image

Upload a firmware image from an FTP or TFTP server to the FortiAnalyzer unit. The FortiAnalyzer unit reboots, loading the new firmware.

logs

Restore device logs and DLP archives from a specified server.

logs-only

Restore device logs from a specified server.

reports

Restore reports from a specified server.

reports-config

Restore report configurations to a specified server.

ftp

Restore from an FTP server.

sftp

Restore from a SFTP server.

scp

Restore from an SCP server.

<ip:port>

Enter the IP address of the server to get the file from and optionally , for FTP servers, the port number.

<ip>

Enter the server IP address.

<device names>

Device name or names, separated by commas, or all for all devices. Example: FWF40C3911000061

<report name(s)>

Backup specific reports (separated by commas), all for all reports, or reports with names containing given pattern.

A '?' matches any single character.

A '*' matches any string, including the empty string, e.g.: 

  • foo: for exact match
  • *foo: for report names ending with foo
  • foo*: for report names starting with foo
  • *foo*: for report names containing foo substring.

{<adom_name> | all]}

Select to backup a specific ADOM or all ADOMs.

<filename>

Enter the file to get from the server. You can enter a path with the filename, if required.

<filepath>

Enter the file path on the FTP server.

<username>

The username to log on to the server. This option is not available for restore operations from TFTP servers.

<password>

Enter the password, or - if there is no password..

<ssh-cert>

Enter the SSH certificate used for user authentication on the SCP server.

[<crptpasswd>]

Optional password to protect backup content. Use any for no password.

<directory>

Enter the directory.

[option1+option2+...]

Enter keepbasic to retain IP and routing information on the original unit.

[full]

Reports configuration full restoration.

Example

This example shows how to upload a configuration file from a FTP server to the FortiAnalyzer unit. The name of the configuration file on the FTP server is backupconfig. The IP address of the FTP server is 192.168.1.23. The user is admin with a password of mypasword. The configuration file is located in the /usr/local/backups/ directory on the FTP server.

execute restore all-settings ftp 192.168.1.23 /usr/local/backups/backupconfig admin mypasword

restore

Use this command to:

  • restore the configuration or database from a file
  • change the FortiAnalyzer unit image
  • Restore device logs, DLP archives, and reports from specified servers.

This command will disconnect all sessions and restart the FortiAnalyzer unit.

Syntax

execute restore all-settings {ftp | sftp} <ip:port> <filename> <username> <password> [<crptpasswd>] [option1+option2+...]

execute restore all-settings scp <ip> <filename> <username> <ssh-cert> [<crptpasswd>] [option1+option2+...]

execute restore image ftp <filepath> <ip:port> <username> <password>

execute restore image tftp <filename> <ip>

execute restore logs <device name(s)> {ftp | scp | sftp} <ip> <username> <password> <directory> [vdlist]

execute restore logs-only <device name(s)> {ftp | scp | sftp} <ip> <username> <password> <directory> [vdlist]

execute restore reports <report name(s)> {ftp | scp | sftp} <ip> <username> <password> <directory> [vdlist]

execute restore reports-config {<adom_name> | all]} {ftp | scp | sftp} <ip> <username> <password> <directory> [full]

Variable

Description

all-settings

Restore all FortiAnalyzersettings from a file on a FTP, SFTP, or SCP server. The new settings replace the existing settings, including administrator accounts and passwords.

image

Upload a firmware image from an FTP or TFTP server to the FortiAnalyzer unit. The FortiAnalyzer unit reboots, loading the new firmware.

logs

Restore device logs and DLP archives from a specified server.

logs-only

Restore device logs from a specified server.

reports

Restore reports from a specified server.

reports-config

Restore report configurations to a specified server.

ftp

Restore from an FTP server.

sftp

Restore from a SFTP server.

scp

Restore from an SCP server.

<ip:port>

Enter the IP address of the server to get the file from and optionally , for FTP servers, the port number.

<ip>

Enter the server IP address.

<device names>

Device name or names, separated by commas, or all for all devices. Example: FWF40C3911000061

<report name(s)>

Backup specific reports (separated by commas), all for all reports, or reports with names containing given pattern.

A '?' matches any single character.

A '*' matches any string, including the empty string, e.g.: 

  • foo: for exact match
  • *foo: for report names ending with foo
  • foo*: for report names starting with foo
  • *foo*: for report names containing foo substring.

{<adom_name> | all]}

Select to backup a specific ADOM or all ADOMs.

<filename>

Enter the file to get from the server. You can enter a path with the filename, if required.

<filepath>

Enter the file path on the FTP server.

<username>

The username to log on to the server. This option is not available for restore operations from TFTP servers.

<password>

Enter the password, or - if there is no password..

<ssh-cert>

Enter the SSH certificate used for user authentication on the SCP server.

[<crptpasswd>]

Optional password to protect backup content. Use any for no password.

<directory>

Enter the directory.

[option1+option2+...]

Enter keepbasic to retain IP and routing information on the original unit.

[full]

Reports configuration full restoration.

Example

This example shows how to upload a configuration file from a FTP server to the FortiAnalyzer unit. The name of the configuration file on the FTP server is backupconfig. The IP address of the FTP server is 192.168.1.23. The user is admin with a password of mypasword. The configuration file is located in the /usr/local/backups/ directory on the FTP server.

execute restore all-settings ftp 192.168.1.23 /usr/local/backups/backupconfig admin mypasword