Configuring Scheduled Backups

Important:

When you create a backup on a Management Server Check Point Single-Domain Security Management Server or a Multi-Domain Security Management Server., make sure to close all SmartConsole Check Point GUI application used to manage a Check Point environment - configure Security Policies, configure devices, monitor products and events, install updates, and so on. clients. Otherwise, scheduled backup does not start.
Maestro Security Groups that contain different Security Appliance models do not support Gaia Check Point security operating system that combines the strengths of both SecurePlatform and IPSO operating systems. Backup operations (in the Global Gaia Portal Web interface for the Check Point Gaia operating system. or Global Gaia Clish The name of the default command line shell in Check Point Gaia operating system. This is a restricted shell (role-based administration controls the number of commands available in the shell).).

To collect or import a Gaia Backup in such a Security Group, connect directly to Gaia Portal or Gaia Clish on each Security Appliance in the Security Group.
You can configure only one schedule for one location. For example, you can configure only one schedule for an SCP server, and only one schedule for an FTP server.
For regular backups, see Backing Up and Restoring the System.

Note - Gaia Operating System uses these templates for the name of a scheduled backup output file:

Gaia Date Format	Template	Example for 20 Nov 2022, 18:04:43
`dd/mm/yyyy`	`backup_-<Name_of_Scheduled_Backup>-_<HostName>.<Domain>_<DD>_<MM>_<YYYY>_<HH>_<MM>_<SS>.tgz`	`backup_-MyDailyBkp-_MyGW.MyDomain.com_20_11_2022_18_04_43.tgz`
`mm/dd/yyyy`	`backup_-<Name_of_Scheduled_Backup>-_<HostName>.<Domain>_<MM>_<DD>_<YYYY>_<HH>_<MM>_<SS>.tgz`	`backup_-MyDailyBkp-_MyGW.MyDomain.com_11_20_2022_18_04_43.tgz`
`yyyy/mm/dd`	`backup_-<Name_of_Scheduled_Backup>-_<HostName>.<Domain>_<YYYY>_<MM>_<DD>_<HH>_<MM>_<SS>.tgz`	`backup_-MyDailyBkp-_MyGW.MyDomain.com_2022_11_20_18_04_43.tgz`
`dd-mmm-yyyy`	`backup_-<Name_of_Scheduled_Backup>-_<HostName>.<Domain>_<DD>_<MMM>_<YYYY>_<HH>_<MM>_<SS>.tgz`	`backup_-MyDailyBkp-_MyGW.MyDomain.com_20_Nov_2022_18_04_43.tgz`

Configuring Scheduled Backups in Gaia Portal

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

Watch the Video

Adding a scheduled backup

Step

Instructions

In the navigation tree, click Maintenance > System Backup.

Refer to the Scheduled Backup section.

Click Add Scheduled Backup.

In the Backup Name field, enter the name of the job.

The maximal length is 15 characters.
The name can consist only of letters, numbers, or underscore "_".

In the Backup Type section, configure the location of the backup file:

This appliance

To keep the collected backup locally in the /var/log/CPbackup/backups/ directory.

Management

To send the collected backup to the Management Server that manages this Security Gateway Dedicated Check Point server that runs Check Point software to inspect traffic and enforce Security Policies for connected network resources. (or Cluster Member Security Gateway that is part of a cluster.).

Enter the User name and Password for the applicable SCP user.

The Security Gateway (or Cluster Two or more Security Gateways that work together in a redundant configuration - High Availability, or Load Sharing. Member) uploads the file to the /home/<username>/ directory on the Management Server.

Important - Follow sk164234 to configure the Security Gateway (or Cluster Member) as a trusted host on the Management Server.

SCP server

To send the collected backup to an SCP server.

Enter the IP address, User name, Password, and Upload path.

Important - Follow sk164234 to configure ‎the ‎SCP ‎server as a trusted host on Gaia.

FTP server

To send the collected backup to an FTP server.

Enter the IP address, User name, Password, and Upload path.
TFTP server

To send the collected backup to a TFTP server.

Enter the IP address.

In the Backup Schedule section, configure the frequency (Daily, Weekly, Monthly) for this backup.

Click Add.

The scheduled backup appears in the Scheduled Backups table.

Deleting a scheduled backup

Step	Instructions
1	In the navigation tree, click Maintenance > System Backup. Refer to the Scheduled Backup section.
2	Select the backup to delete.
3	Click Delete.

Step

Instructions

In the navigation tree, click Maintenance > System Backup.

Refer to the Scheduled Backup section.

Select the backup to delete.

Click Delete.

Configuring Scheduled Backups in Gaia Clish

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

Workflow

Step	Instructions
1	Add a backup schedule.
2	Configure the recurrence.
3	Configure the retention policy.
4	Examine the configuration.

Syntax

add backup-scheduled name <Name of Schedule>

      ftp <Options>

      local

      management <Options>

      scp <Options>

      tftp <Options>

set backup-scheduled name <Name of Schedule>

      recurrence <Options>

      retention-policy <Options>

show backup-scheduled

delete backup-scheduled

Procedure

Configuring the backup schedule to limit the disk space for backup files

set backup-scheduled name <Name of Schedule> retention-policy

      keep-occupied-disk-space-in-MB {<Disk Space> | 0}

      max-backups-to-keep {<Number> | 0}

      min-backups-to-keep {<Number> | 0}

Note - These settings are available only in Gaia Clish.

Important - After you add, configure, or delete features, run the "save config" command to save the settings permanently.

Parameters

CLI Parameters

Parameter

Description

name <Name of Schedule>

Defines the name of the scheduled backup:

The maximal length is 15 characters.
The name can consist only of letters, numbers, or underscore "_".

local

Keeps the backup file locally on this Security Gateway (or Cluster Member).

Gaia keeps the file in the /var/log/CPbackup/backups/ directory.

management username <SCP User Name on Management Server> password <Password in Plain Text>

Uploads the backup file over SCP to the Management Server that manages this Security Gateway.

The Security Gateway (or Cluster Member) uploads the file to the /home/<username>/ directory on the Management Server.

Important - Follow sk164234 to configure the Security Gateway (or Cluster Member) as a trusted host on the Management Server.

ftp ip <IPv4 Address of FTP Server>

Specifies the IPv4 address of the remote FTP server.

scp ip <IPv4 Address of SCP Server>

Specifies the IPv4 address of the remote SCP server.

tftp ip <IPv4 Address of TFTP Server>

Specifies the IPv4 address of the remote TFTP server.

path <Path on FTP Server>

Specifies the path on the remote FTP server where to upload the backup file.

path <Path on SCP Server>

Specifies the path on the remote SCP server where to upload the backup file.

username <User Name on FTP Server>

Specifies the user name required to log in to the remote FTP server.

username <User Name on SCP Server>

Specifies the user name required to log in to the remote SCP server.

password <Password in Plain Text>

Specifies the password (in plain text) required to log in to the remote server.

recurrence daily time <HH:MM>

Specifies that the job must run once a day - each day, at specified time.

Enter the time of day in the 24-hour clock format - <Hours>:<Minutes>.
Example: 14:35

recurrence monthly month <1-12> days <1-31> time <HH:MM>

Specifies that the job must run once a month - on specified months, on specified dates, and at specified time.

Months are specified by numbers from 1 to 12: January = 1, February = 2, ..., December = 12.

Dates of month are specified by numbers from 1 to 31.

To specify consequent months, enter their numbers separated by commas.
Example: for January through March, enter 1,2,3

To specify consequent dates, enter their numbers separated by commas.
Example: for 1st, 2nd and 3rd day of month, enter 1,2,3

recurrence weekly days <0-6> time <HH:MM>

Specifies that the job must run once a week - on specified days of week, and at specified time.

Days of week are specified by numbers from 0 to 6: Sunday = 0, Monday = 1, Tuesday = 2, Wednesday = 3, Thursday = 4, Friday = 5, Saturday = 6.

To specify consequent days of a week, enter their numbers separated by commas.
Example: for Sunday, Monday, and Tuesday, enter 0,1,2

retention-policy <Options>

Specifies how many much disk space the backup files can take and how many backup files to keep on Gaia:

retention-policy keep-occupied-disk-space-in-MB {<Disk Space> | 0}

Specifies how many much disk space (in megabytes) the existing backup files can take on Gaia.
retention-policy max-backups-to-keep {<Number> | 0}

Specifies how many backup files to keep on Gaia at maximum.

If the job creates a new backup file, it deletes the oldest existing backup file.

The value for maximum number of backup files to keep must be greater than the value for minimum number of backup files.
retention-policy min-backups-to-keep {<Number> | 0}

Specifies how many backup files to keep on Gaia at minimum.

Notes:

These settings are available only in Gaia Clish.

Gaia Portal only shows the configured retention policy.
Each of these settings is optional.
To change the current configuration, run the command again with a new value.
To disable this configuration, run the command again with the value 0 (zero).
If the job uploads a backup file to a remote server, the username must have permissions to delete files on the remote server.
The scheduled backup job stops if Gaia is not able to meet the configured retention policy.

For example, the disk space limit is not enough to create a new backup file, and the minimum number of backup files does not allow to delete the existing backup files.
These settings do not support a job that uploads a backup file to a TFTP server because TFTP servers cannot delete files.
These settings apply only to scheduled backup files configured and created in R81.10 version.

Troubleshooting

Examine the location of the backup file.

Examine the /var/log/messages files.