topic Re: run-script output in API / CLI Discussion

run-script output

Marc_Guyard — Wed, 09 Nov 2016 10:35:28 GMT

Hi,

How can we retreive output for run-script API command ?

I can see result on Dashboard but it's possible to have this by API ?

Thanks

Re: run-script output

Marc_Guyard — Wed, 09 Nov 2016 10:42:36 GMT

I've find the solution.

Get task with full details :

{

"task-id" : "29118dcb-d3e2-4096-a8ad-e3e2451db891",

"details-level" : "full"

}

And you have in responseMessage field the output in base64.

Re: run-script output

Eugene_Grybinny — Thu, 10 Nov 2016 06:45:37 GMT

Hi Marc,

Yes, it is possible to retrieve output from run-script API command. It's returned being encoded to base64 inside the show-task API command response.

Getting run-script output through HTTP request

Run run-script command (it's asynchronous) and save the task-id from the response.
Run show-task command providing task-id that was saved in step 1. You have to run show-task command several times until response will contain status "succeeded". You have to run show-task with details-level set to "full".
Parse show-task response and extract the base64 encoded result by following path showTaskResult.tasks[0]["task-details"][0].responseMessage
Decode the base64 encoded result (In Javascript it can be done with atob function).

Getting run-script output through mgmt_cli tool (full example)

mgmt_cli -r true run-script script-name "list root" script "ls -l /" targets.1 "my-management" --format json 2> /dev/null \

| $CPDIR/jq/jq -r '(.tasks[0]["task-details"][0].responseMessage)' \

| base64 -di

Useful links

https://sc1.checkpoint.com/documents/R80/APIs/index.html#web/run-script

https://sc1.checkpoint.com/documents/R80/APIs/index.html#web/show-task

https://sc1.checkpoint.com/documents/R80/APIs/index.html#mgmt_cli

https://sc1.checkpoint.com/documents/R80/APIs/index.html#ws

Re: run-script output

PhoneBoy — Tue, 31 Jul 2018 23:06:11 GMT

Hey Robert Decker‌ can you update the above example for R80.10/R80.20.M1?

When I try to run something like:

mgmt_cli -r true show-task task-id 0490542b-e741-40b9-be65-45e1e00c9f79 details-level full --format json | $CPDIR/jq/jq -r '(.tasks[0]["task-details"].responseMessage)' | base64 -di

I get:

jq: error: Cannot index array with string

Re: run-script output

Marc_Guyard — Wed, 01 Aug 2018 07:57:34 GMT

Hi Dameon,

tasks-details is an objects list so try this command :

mgmt_cli -r true show-task task-id 0490542b-e741-40b9-be65-45e1e00c9f79 details-level full --format json | $CPDIR/jq/jq -r '(.tasks[0]["task-details"][0].responseMessage)' | base64 -di

Re: run-script output

Robert_Decker — Wed, 01 Aug 2018 08:17:06 GMT

Dameon,

You have missed the index notation for the ["task-details"], it should be ["task-details"][0], as it is a collection.

Robert.

Re: run-script output

PhoneBoy — Wed, 01 Aug 2018 15:40:19 GMT

Ah, yes, I did!

Gotta love JSON

Re: run-script output

Kellman_Meghu — Thu, 02 Aug 2018 11:28:56 GMT

Gotta love jq being included on the Check Point manager! I did not realize it was in there, I may do more in the shell versus remote through the API because of this!

Re: run-script output

jpanywhere — Wed, 02 Oct 2019 22:12:47 GMT

What would be the secret to getting this to work with multiple targets? When I run the command below the output only gives me the output for one firewall no matter how many targets I add.

mgmt_cli -r true run-script script-name "Show State" script "cphaprob state" targets.1 fw1 targets.2 fw2 --format json 2> /dev/null | $CPDIR/jq/jq -r '(.tasks[0]["task-details"][0].responseMessage)' | base64 -di

Re: run-script output

PhoneBoy — Wed, 02 Oct 2019 23:49:39 GMT

Right, because run-script creates a separate task for each target and you're only printing the first task details with jq.
Something like this should work:

mgmt_cli -r true run-script script-name "Show State" script "cphaprob state" targets.1 fw1 targets.2 fw2 --format json 2> /dev/null | $CPDIR/jq/jq -r '(.tasks[]["task-details"][].responseMessage)' | base64 -di

Re: run-script output

jpanywhere — Thu, 03 Oct 2019 22:11:28 GMT

Thx you were right. However it still didn't work for me. I figured out after you fixed my task issue that base64 didn't like the output from multiple firewalls. I had to add a while loop to get the output from both firewalls.

mgmt_cli -r true run-script script-name "Show State" script "cphaprob state" targets.1 fw1 targets.2 fw2 --format json | $CPDIR/jq/jq -r '(.tasks[]["task-details"][].responseMessage)' | while read line; do base64 -di <<< "$line"; done