Fortinet black logo

CLI Reference

config system auto backup

config system auto backup

Use this command to configure scheduled system backup.

Syntax

config system auto-backup

set address <ip>

set folder <string>

set overwrite-config {enable|disable}

set password <string>

set port <integer>

set scheduled-backup-day {Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday}

set scheduled-backup-frequency {daily|weekly|every}

set scheduled-backup-status {enable|disable}

set scheduled-backup-time <hh:mm>

set storage {disk|sftp}

set username <string>

end

address

The IP address of the SFTP server.

folder

Specify the folder path on the SFTP server.

overwrite-config

Enable or disable "overwrite-config" when "storage" is "disk". If overwrite-config is disabled, FortiADC will stop backing up configurations when the maximum size or files is met. By default, this setting is disabled.

port

Specify the listening port on the SFTP server.

scheduled-backup-day

Specify one day of the week (i.e., Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.)

scheduled-backup-frequency

Specify a scheduled backup frequency:

  • Daily—Specify the time of day for daily backup.
  • Weekly—Specify the day and time for weekly backup.
  • Every—Specify the time for periodic backup.
scheduled-backup-status

Enable or disable scheduled backup.

scheduled-backup-time

Specify the backup time in the format of <hh:mm> hour and minute, hh: 0-23, mm: {00|15|30|45}.

storage

Specify where to save the backup configuration files:

  • disk—Hard disk.
  • sftp—SFTP server.
username

The user name used to log into the SFTP server.

password

The password used to log into the SFTP server.

Example

The following example for a scenario where the storage is on a local disk:

FortiADC-VM # config system auto-backup

FortiADC-VM (auto-backup) # get

scheduled-backup-status : disable

FortiADC-VM (auto-backup) # set scheduled-backup-status enable

FortiADC-VM (auto-backup) # set scheduled-backup-day Monday

FortiADC-VM (auto-backup) # set scheduled-backup-time 03:30

FortiADC-VM (auto-backup) # set overwrite-config enable

FortiADC-VM (auto-backup) # show full

config system auto-backup

set scheduled-backup-status enable

set scheduled-backup-frequency weekly

set scheduled-backup-day Monday

set scheduled-backup-time 03:30

set storage disk

set overwrite-config enable

end

FortiADC-VM (auto-backup) # get

scheduled-backup-status : enable

scheduled-backup-frequency : weekly

scheduled-backup-day : Monday

scheduled-backup-time : 03:30

storage : disk

overwrite-config : enable

The following example is for a scenario where the storage is on an SFTP server:

FortiADC-VM # config sys auto-backup

FortiADC-VM (auto-backup) # set scheduled-backup-status enable

FortiADC-VM (auto-backup) # set storage sftp

FortiADC-VM (auto-backup) # set scheduled-backup-frequency daily

FortiADC-VM (auto-backup) # set scheduled-backup-time 12:00

FortiADC-VM (auto-backup) # set address 10.0.100.2

FortiADC-VM (auto-backup) # set username test

FortiADC-VM (auto-backup) # set password test

FortiADC-VM (auto-backup) # set folder /backup

FortiADC-VM (auto-backup) # show full

config system auto-backup

set scheduled-backup-status enable

set scheduled-backup-frequency daily

set scheduled-backup-time 12:00

set storage sftp

set address 10.0.100.2

set port 22

set username test

set password ENC FQ21TuLJKNMzW3AD3GkVQX2yUyeMiC8251rM6XFbNuZkE80xcV+miFjCymkvA+LS8211ZJ8trQFF7RI1NnANdFOlyiABjZ2ZB/YqsbOETL/Ckywe

set folder /backup

end

FortiADC-VM (auto-backup) # get

scheduled-backup-status : enable

scheduled-backup-frequency : daily

scheduled-backup-time : 12:00

storage : sftp

address : 10.0.100.2

port : 22

username : test

password : *

folder : /backup

config system auto backup

Use this command to configure scheduled system backup.

Syntax

config system auto-backup

set address <ip>

set folder <string>

set overwrite-config {enable|disable}

set password <string>

set port <integer>

set scheduled-backup-day {Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday}

set scheduled-backup-frequency {daily|weekly|every}

set scheduled-backup-status {enable|disable}

set scheduled-backup-time <hh:mm>

set storage {disk|sftp}

set username <string>

end

address

The IP address of the SFTP server.

folder

Specify the folder path on the SFTP server.

overwrite-config

Enable or disable "overwrite-config" when "storage" is "disk". If overwrite-config is disabled, FortiADC will stop backing up configurations when the maximum size or files is met. By default, this setting is disabled.

port

Specify the listening port on the SFTP server.

scheduled-backup-day

Specify one day of the week (i.e., Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.)

scheduled-backup-frequency

Specify a scheduled backup frequency:

  • Daily—Specify the time of day for daily backup.
  • Weekly—Specify the day and time for weekly backup.
  • Every—Specify the time for periodic backup.
scheduled-backup-status

Enable or disable scheduled backup.

scheduled-backup-time

Specify the backup time in the format of <hh:mm> hour and minute, hh: 0-23, mm: {00|15|30|45}.

storage

Specify where to save the backup configuration files:

  • disk—Hard disk.
  • sftp—SFTP server.
username

The user name used to log into the SFTP server.

password

The password used to log into the SFTP server.

Example

The following example for a scenario where the storage is on a local disk:

FortiADC-VM # config system auto-backup

FortiADC-VM (auto-backup) # get

scheduled-backup-status : disable

FortiADC-VM (auto-backup) # set scheduled-backup-status enable

FortiADC-VM (auto-backup) # set scheduled-backup-day Monday

FortiADC-VM (auto-backup) # set scheduled-backup-time 03:30

FortiADC-VM (auto-backup) # set overwrite-config enable

FortiADC-VM (auto-backup) # show full

config system auto-backup

set scheduled-backup-status enable

set scheduled-backup-frequency weekly

set scheduled-backup-day Monday

set scheduled-backup-time 03:30

set storage disk

set overwrite-config enable

end

FortiADC-VM (auto-backup) # get

scheduled-backup-status : enable

scheduled-backup-frequency : weekly

scheduled-backup-day : Monday

scheduled-backup-time : 03:30

storage : disk

overwrite-config : enable

The following example is for a scenario where the storage is on an SFTP server:

FortiADC-VM # config sys auto-backup

FortiADC-VM (auto-backup) # set scheduled-backup-status enable

FortiADC-VM (auto-backup) # set storage sftp

FortiADC-VM (auto-backup) # set scheduled-backup-frequency daily

FortiADC-VM (auto-backup) # set scheduled-backup-time 12:00

FortiADC-VM (auto-backup) # set address 10.0.100.2

FortiADC-VM (auto-backup) # set username test

FortiADC-VM (auto-backup) # set password test

FortiADC-VM (auto-backup) # set folder /backup

FortiADC-VM (auto-backup) # show full

config system auto-backup

set scheduled-backup-status enable

set scheduled-backup-frequency daily

set scheduled-backup-time 12:00

set storage sftp

set address 10.0.100.2

set port 22

set username test

set password ENC FQ21TuLJKNMzW3AD3GkVQX2yUyeMiC8251rM6XFbNuZkE80xcV+miFjCymkvA+LS8211ZJ8trQFF7RI1NnANdFOlyiABjZ2ZB/YqsbOETL/Ckywe

set folder /backup

end

FortiADC-VM (auto-backup) # get

scheduled-backup-status : enable

scheduled-backup-frequency : daily

scheduled-backup-time : 12:00

storage : sftp

address : 10.0.100.2

port : 22

username : test

password : *

folder : /backup