This website uses Cookies. Click Accept to agree to our website's cookie use as described in our Privacy Policy. Click Preferences to customize your cookie settings.
This tool creates a backup of all GAIA gateway configurations with one CLI command "ebackup":
- Only one CLI command "ebackup" - Backup of all Gaia gateway configurations (Check Point appliances, Open Server, SMB appliances 11xx, 14xx) - Migrate export on SMS - Migrate-server on MDS - Backup all files to one TGZ file - FTP upload support backup file - CP upload support for backup file via cprid_util
- MDS > All CMA's are read out and their gateways backuped. - SMS > All gateways are read out and backuped.
Note: - Tested with R80.10, R80.20 and R80.30. - If the tool is started on a MDS, a mdsstop and mdsstart is performed during the migrate_server export.
CLI Parameter
Syntax
Description
-s
The option -s performs a cpstop and cpstart when the migrate export tool is executed.
-v
The option -v shows the gateway OS, JHF, Kernel, Type of all gateways.
-l
The option -l shows all ebackup tgz files in /var/log/.
-d
The option -d delete all ebackup tgz files in /var/log/.
-no_migrate / -n
The option -no_migrate has the consequence that no migrate export is executed.
-port <sms port> / -p <sms port>
The option -port <sms port> add the management server port, if it's not running on port 443.
-ftpserver <ftp server ip> -ftpuser <username> -ftppw <password>
The ftp options allow to upload the tar file to a ftp server.
- cpupload <cp_system_ip>
The option -cpupload performs a backup upload to a other Check Point gateway or SMS via cprid_util.
Example
# ebackup -> Backup all GAIA configs from all gateways + migrate export with locale backup file (/var/log/[date]_ebackup.tgz) # ebackup -s -> Backup all GAIA configs from all gateway + migrate export with cpstop and cpstart for migrate export # ebackup -no_migrate -> Backup all GAIA configs from all gateway without migrate export # ebackup -ftpserver 1.1.1.1 -ftpuser username -ftppw test123 -> Backup all GAIA configs from all gateway + migrate export with ftp upload
# ebackup -cpupload 1.1.1.1 -> Backup all GAIA configs from all gateway + migrate export with cp upload via cprid_util
Install Tool
Use this auto installer script from "Spoiler" on the SMS or MDS as CLI command in expert mode:
If an FTP upload is too insecure for you, you can also transfer the backup file to another Check Point system with the option -cpupload via cprid_util.
- Add parameter -s for cpstop/cpstart - Add ftpserver/ ftpuser and ftppw parameters for ftp upload.
0.1 03-15-2020 - oneliner to show backup clish configs 0.6 03-23-2020 - GA version ebackup 0.7 03-25-2020 - add parameter -s for cpstop/cpstart 0.8 03-26-2020 - add parameter -no_migrate (no migrate export) 0.9 03-26-2020 - bug fixed (special thanks to Paul_Gademsky) 1.0 03-27-2020 - bug fixed (SMS and MDS) 1.1 03-30-2020 - add option -port 1.2 03-30-2020 - bug fixed 1.3 03-31-2020 - ftp upload function (-ftpserver, -ftpuser, -ftppw)
2.0 04-04-2020 - MDS support 2.1 04-06-2020 - bug fixed 2.2 04-07-2020 - add option -v 2.3 04-09-2020 - add option -cpupload (upload tgz file to a other Check Point gateway or SMS)
3.0 06-20-2023 - Support for R81.20 3.1 01-28-2026 - Support for R82 + R82.10 + ElasticXL
➜ CCSM Elite, CCME, CCTE ➜ www.checkpoint.tips
asy Backup Tool
Features
This tool creates a backup of all GAIA gateway configurations with one CLI command "ebackup":
- Only one CLI command "ebackup" - Backup of all Gaia gateway configurations (Check Point appliances, Open Server, SMB appliances 11xx, 14xx) - Migrate export on SMS - Migrate-server on MDS - Backup all files to one TGZ file - FTP upload support backup file - CP upload support for backup file via cprid_util
Disclaimer: Check Point does not provide maintenance services or technical or customer support for third party content provided on this Site, including in CheckMates Toolbox. See also our Third Party Software Disclaimer.
I have a suggestion to add an option to change the API port. For example on my SMS, there is also Endpoint MGMT and default API port is changed to 4434 .
Thank you for the excellent script!
I have a suggestion to add an option to change the API port.
For example on my SMS, there is also Endpoint MGMT and default API port is changed to 4434 .
;
It should be fairly straight forward to do, but I'll leave that to Heiko to incorporate.
When it comes to storing the passwords for the ftp/scp/sftp on a server for a cron job, I tend to stay away from that.
My solution is to use the cprid capabilities to copy the file to a second Mgmt (HA), log server, SmartEvent server, or worse case a gateway, so that it exists in more than one location.
It should be fairly straight forward to do, but I'll leave that to Heiko to incorporate.
When it comes to storing the passwords for the ftp/scp/sftp on a server for a cron job, I tend to stay away from that.
My solution is to use the cprid capabilities to copy the file to a second Mgmt (HA), log server, SmartEvent server, or worse case a gateway, so that it exists in more than one location.
I have been following this article for the last few days. This is a really good idea that you've developed here. In my opinion the script should be published in a JHF or in the next R80 version.
We use it on several management servers of our customers and it's working great now.
I have been following this article for the last few days. This is a really good idea that you've developed here. In my opinion the script should be published in a JHF or in the next R80 version.
We use it on several management servers of our customers and it's working great now.
Thank you so much for an awesome tool - this has been a gap in my toolbox for so long. The only issue I have picked up in testing is a spelling mistake in the output file, as per attachment.
Thanks again, Ruan
Thank you so much for an awesome tool - this has been a gap in my toolbox for so long. The only issue I have picked up in testing is a spelling mistake in the output file, as per attachment.
Thank you for this script. One question in case of an Endpoint MGMT: is there also a opportunity to use the function of a migrate export with the syntax "--include-uepm-msi-files"?
That would great
Best regards
Moritz
Thank you for this script. One question in case of an Endpoint MGMT: is there also a opportunity to use the function of a migrate export with the syntax "--include-uepm-msi-files"?
Hello @HeikoAnkenbrand now I have a second question: after adding a test cronjob with ebackup, the topic of the job notification mail includes the users password. Is it possible to hide it?
And Im not sure if it is a typo in the script, because also in the job notification mail, I got an error message:
rm: cannot remove '/tmp/ebachup_cpupload': No such file or directory TERM environment variable not set.
Does this error occur because of "ebachup_cpupload" instead of "ebackup_cpupload". I can find it multiple times in the script.
Best regards
Moritz
Hello
@HeikoAnkenbrand now I have a second question: after adding a test cronjob with ebackup, the topic of the job notification mail includes the users password. Is it possible to hide it?
And Im not sure if it is a typo in the script, because also in the job notification mail, I got an error message:
rm: cannot remove '/tmp/ebachup_cpupload': No such file or directory TERM environment variable not set.
Does this error occur because of "ebachup_cpupload" instead of "ebackup_cpup
Hi. Great work. I am in process of replacing my ancient nightly backup script with ebackup. I would like to see a feature that just does the migrate of the SMS and skips the gateways. In my use case I have 400 appliances that don't really change all the much so I think backing up those once per week makes sense. However the with policy changes, etc. my preference is to use your script to get a migrate done nightly.
Thoughts?
Would this be something others would like to see?
Good day.
Hi. Great work. I am in process of replacing my ancient nightly backup script with ebackup. I would like to see a feature that just does the migrate of the SMS and skips the gateways. In my use case I have 400 appliances that don't really change all the much so I think backing up those once per week makes sense. However the with policy changes, etc. my preference is to use your script to get a migrate done nightly.