topic Re: Script to Automate GAIA Configuration backup in API / CLI Discussion

Script to Automate GAIA Configuration backup

Harshpal_Bhati — Mon, 02 Jul 2018 11:30:46 GMT

Hi,

i wrote below script for my customer to automate gaia configuration backup of gateway . Script runs on management and it can fetch the "show configuration" of all the gateway and create a file for individual gateway .

Steps :

Perform below on management server .

Create a Directory called gaiagwbkp under /var/log
Create a file called gateway_ip_list.txt under /opt/CPsuite-R80/fw1/scripts and add ip address of the gateway which is being managed by same management server
[Expert@PROD-MGMT-R80:0]# cat gateway_ip_list.txt
10.1.1.254
[Expert@PROD-MGMT-R80:0]#
Create a file called gaiafwbkp.sh under /opt/CPsuite-R80/fw1/scripts and copy the script content and change file permission

*****************************************

[Expert@PROD-MGMT-R80:0]# cat gaiafwbkp.sh
#!/bin/sh
source /opt/CPshrd-R80/tmp/.CPprofile.sh
for dest in $(<gateway_ip_list.txt); do
hostname=`cprid_util -server $dest -verbose rexec -rcmd /bin/bash -c "hostname"`
now=$(date +"%m_%d_%Y")
cprid_util -server $dest -verbose rexec -rcmd /bin/clish -c "show configuration" > /var/log/gaiagwbkp/$hostname$now
done

************************************

4. run script gaiafwbkp.sh

5. Schedule job from GAIA portal using job scheduler

6. if needed you can run another job to ftp this backup files to ftp server as well

Re: Script to Automate GAIA Configuration backup

ED — Tue, 03 Jul 2018 07:02:49 GMT

Thanks for sharing, very useful.

Re: Script to Automate GAIA Configuration backup

HeikoAnkenbrand — Tue, 03 Jul 2018 15:47:19 GMT

Nice!

Re: Script to Automate GAIA Configuration backup

Martin_Valenta — Fri, 06 Jul 2018 15:18:41 GMT

CDT is better way to do that.

Re: Script to Automate GAIA Configuration backup

PhoneBoy — Fri, 06 Jul 2018 17:12:26 GMT

CDT only works on R77.30 and later.

I could see this script being useful on older systems, potentially.

That said, I must provide a word of caution with this approach.

Especially in some earlier versions of Gaia, the order that "show configuration" outputs the commands in won't necessarily work when you import that same configuration.

Re: Script to Automate GAIA Configuration backup

Allen_Fambro — Mon, 25 Mar 2019 17:16:59 GMT

Does CDT work for SMB appliances (1100's, 1400's) that are centrally managed?? One of the requirements is that the gateways are on Gaia R77.30 however the "Gaia Embedded" software line is only at R77.20.85 to date.

Re: Script to Automate GAIA Configuration backup

PhoneBoy — Mon, 25 Mar 2019 18:21:12 GMT

CDT is not supported for SMB appliances.

Re: Script to Automate GAIA Configuration backup

Dave_Taylor1 — Tue, 21 May 2019 14:44:51 GMT

What is CDT?

Re: Script to Automate GAIA Configuration backup

Timothy_Hall — Tue, 21 May 2019 14:48:33 GMT

sk111158: Central Deployment Tool (CDT)

Re: Script to Automate GAIA Configuration backup

Vladimir — Tue, 21 May 2019 17:04:54 GMT

@PhoneBoy , yep: the add and set sequence gets out of whack. Still seeing it happening when attempting to replicate old Gaia configs on the newly deployed gateways using output of "show configuration".

Theoretically, pasting this file twice should solve these issues, as the prerequisites will take effect in the first pass and dependent settings in second.

Re: Script to Automate GAIA Configuration backup

Andrew_Larrick — Wed, 01 Jul 2020 13:51:54 GMT

I love this idea, and the script works great if I run it manually but has anyone been able to make it run via Job Scheduler? Doesn't work for me. Running R80.30. I have updated the relevant paths to R80.30 and even went so far as to add an absolute path for cprid_util, still nothing.

Thanks for any suggestions

Andrew

Re: Script to Automate GAIA Configuration backup

Danny — Wed, 01 Jul 2020 17:35:33 GMT

Just install CDT on your management, edit $CDTDIR/CentralDeploymentTool.xml to your needs and add the following line to the job scheduler of your management server:

source /etc/profile.d/CP.sh; . $CDTDIR/CentralDeploymentTool -rma -backupall 2>/dev/null

Re: Script to Automate GAIA Configuration backup

dj0Nz — Tue, 17 Aug 2021 08:12:14 GMT

Late to the show but maybe this helps anyone else: For me, a similar solution worked only after adding hostname entries for the gateways. And I had to remove nonprintables from hostnames which did get there anyhow I dont know. You may find scripts for adding hostnames and doing config backups on my Github repository (https://github.com/dj0nz/cptools).

But I agree with other comments here: Check out CDT if you can spare the time. Probably the better long-term solution.

Re: Script to Automate GAIA Configuration backup

Sudip_Majee — Fri, 19 Jul 2024 07:05:20 GMT

Thank you Harshpal for sharing the detailed steps.

I have successfully implemented this in my infra, but facing one issue, the configuration file is being written max 59kb and for some gw , the configuration output is incomplete due to this.
is there any way to increase the output file size or wait until the complete configuration captured before running the scripts on the next Gw.