topic Re: Proper place to put custom scripts in API / CLI Discussion

Proper place to put custom scripts

HristoGrigorov — Mon, 19 Nov 2018 06:26:33 GMT

Hi,

So, I wrote my own backup script for Security Management Server and I thought the proper place to put it in is /usr/local/sbin/

Well, I was wrong. When I upgraded server from R80.10 to R80.20 my script was silently deleted.

Where shall I place my scripts so that they are preserved between upgrades?

Re: Proper place to put custom scripts

PhoneBoy — Mon, 19 Nov 2018 06:41:59 GMT

Somewhere under your home directory is probably the safest place to put it as it should not be affected by an upgrade.

Re: Proper place to put custom scripts

HristoGrigorov — Mon, 19 Nov 2018 07:03:53 GMT

Thank you, /home/bin/ it is then.

Re: Proper place to put custom scripts

Danny — Tue, 20 Nov 2018 13:59:51 GMT

It depends. Check via set with paths are defined in your environment. I prefer /usr/local/bin

Re: Proper place to put custom scripts

PhoneBoy — Tue, 20 Nov 2018 16:42:47 GMT

I think he said that location got overwritten, thus why I suggested somewhere else.

Re: Proper place to put custom scripts

HristoGrigorov — Tue, 20 Nov 2018 17:06:22 GMT

Yes, I just need a path that won't be touched by the upgrade scripts. I vaguely remember according to LSB, /usr/local/bin/ is the right one. Do not like to put executables in home dir but in this case I probably have no other choice.

Re: Proper place to put custom scripts

JozkoMrkvicka — Tue, 20 Nov 2018 19:11:58 GMT

The best would be to do deep pre-check before upgrade. Save all custom scripts and cron jobs outside of the machine to be available for all collegues and ready to be put back after upgrade. This is also valid for all .conf and .def files.

Re: Proper place to put custom scripts

Tomer_Sole — Tue, 20 Nov 2018 19:21:48 GMT

Our recommendation is to use the Script Repository available in SmartConsole.

As Check Point Objects, they will survive all upgrades.

Later you can run that script on gateways by right-clicking them. You can also run them with the Management API referring to just the name of the Script object with the parameters "script-name", representing a title for the script, and "script", representing the script code.

Re: Proper place to put custom scripts

HristoGrigorov — Tue, 20 Nov 2018 19:35:58 GMT

I like that the most, thanx Tomer. Only need to figure out how to invoke script from Job Scheduler using Management API. Shouldn't be that difficult...

Re: Proper place to put custom scripts

Ronen_Zel — Wed, 21 Nov 2018 10:46:02 GMT

Thanks for the information Tomer. I just created a new SecureKnowledge article with this information, sk140852.

Re: Proper place to put custom scripts

HristoGrigorov — Wed, 21 Nov 2018 11:00:33 GMT

Great idea, thanx! Just to mention, there is a small error in SK. Parameter name is "script" and not "script-body".

Re: Proper place to put custom scripts

Tomer_Sole — Wed, 21 Nov 2018 11:16:46 GMT

sorry about that, I made the mistake originally in this thread..

Re: Proper place to put custom scripts

Ronen_Zel — Wed, 21 Nov 2018 11:58:09 GMT

Thanks. I just fixed the sk. The fixed version should be available within a few minutes.

Re: Proper place to put custom scripts

Sven_Glock — Sat, 24 Nov 2018 10:31:45 GMT

If you like to share your exprience with running scripts thru the Scrpit Repository your are more than welcome to join my threat: SmartConsole Scripts Repository usecases and experience

Re: Proper place to put custom scripts

Petr_Hantak — Mon, 26 Nov 2018 14:40:47 GMT

In case you want to invoke job scheduler then I think it is still the best way put it to some /home/ directory and attach job to cron. Just attach it there via WebUI or CLI commands:

HostName> set cron job JOB_NAME command ... 
HostName> set cron job JOB_NAME recurrence ...‍‍

In that case job stay to be scheduled in your configuration file. On the other hand you must still have the script itself backuped somewhere.

For me personally it is not a bafd enchancement to have possibility to use Script repository and just schedule same script for example on different firewalls throuh console...

Re: Proper place to put custom scripts

jacneto — Wed, 24 Feb 2021 00:25:21 GMT

Make no sense to me put a scripts in the Script Repository and run it with Security Management API calling the script by the name ("script-name" parameter) and still using the "script" parameter (which is required) with the script body. Am I missing something?