topic Re: Getting the times of 'Install Policy" in API / CLI Discussion

Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 07:00:29 GMT

Hi,

Is there an easy way to get the install times for the "Install Policy" operations like in the embedded picture, but with a WAPI REST API call? The screenshot is from Audit Logs, from the Checkpoint controller portal.

I can't find any REST API in the documentation. I used 'show-tasks', which doesn't have any "install" references in the"task-name" field (from the REST API's response message). I also tried to use show-logs, but got the permissions error (see embedded picture).

Thanks for your prompt help.

Re: Getting the times of 'Install Policy"

Tal_Paz-Fridman — Thu, 07 Sep 2023 08:10:08 GMT

Here are a few suggestions:

1| Go directly to the Install Policy log file in $FWDIR/log/install_policy.elg

2| Use the same shows-tasks command with grep and before and after lines, for example:

mgmt_cli show tasks status successful details-level standard | grep -A 10 -B 10 "Policy installation"

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 12:34:14 GMT

Thanks @Tal_Paz-Fridman .

I don't think we have permissions to access the Checkpoint FW, and issue CLI commands from our python program to issue the mgmt_cli show tasks command.

All our calls to the Checkpoint firewall is via REST API calls (Web Services), with a service account. Is there a REST API solution to get the Install Policy times?

Re: Getting the times of 'Install Policy"

Tal_Paz-Fridman — Thu, 07 Sep 2023 12:47:58 GMT

The API command is one that should be able to run remotely using Web Services

https://sc1.checkpoint.com/documents/latest/APIs/index.html#web/show-tasks~v1.9%20

It is important that the administrators using the run the command has the relevant permissions.

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 13:13:21 GMT

Yes, we are already using it like below, and search for the firewall and the 'policy installation' keyword in the REST API response's "task-name", but all the tasks in the response are for a different (not the one we are interested in) firewall and are related to an automated script running.

Would the WAPI show-tasks call grabs the tasks for all the firewalls in the mgmt controller? I am wondering why I see one firewall in the response, which isn't the firewall that the policy was installed on. Even a max value of 500 for the body's parameter "limit", I can't see my target firewall.

Maybe there is a permission issue I need to look more into. But the service account is admin, so there shouldn't be any permission issue I don't believe.

url = f"{url}/show-tasks"
body = {"details-level": "standard", "limit": 500, "offset": 0}

response = self.session.post(url, json=body, verify=self.verify)

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 13:27:15 GMT

@Tal_Paz-Fridman I just thought of something, so my program is using a 'admin' service account, when making that 'show-tasks' api call. The response only shows tasks from one firewall (the 'wrong' firewall, where the access rule wasn't installed on).

The policy install was actually done by an admin person, manually (not via our program with a install-policy REST API POST call). Would the show-tasks API call will also grab all the tasks, including those policy install tasks by that admin person?

So far, I only see the 'creator' field being the service account that my program is using, in the response.

Wondering why? Maybe it's a permissions issue, that causes 'show-tasks' not being able to grab all the tasks for all firewalls managed in the mgmt controller? Maybe, the admin service accounts that my program is using needs more permissions roles?

Re: Getting the times of 'Install Policy"

Tal_Paz-Fridman — Thu, 07 Sep 2023 14:10:36 GMT

The output should show all install policy actions regardless of the administrator.

Consider running a test where you initiate install policy (or someone in your team), then shortly after check that you see the output using the shows-tasks command.

Another option would to use the show-logs command:

mgmt_cli show logs new-query.time-frame last-hour new-query.type audit

https://sc1.checkpoint.com/documents/latest/APIs/index.html#cli/show-logs~v1.9%20

This will allow to go over the same audit logs you attached as an image.

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 14:33:13 GMT

Thanks @Tal_Paz-Fridman, I will go from there and try out per your suggestions.

Re: Getting the times of 'Install Policy"

Bob_Zimmerman — Thu, 07 Sep 2023 15:00:26 GMT

Sadly, you have to filter on the task-name field. The rest of the task's fields depend on the type of task it is, but there is no distinct "task-type" field. Also note the tasks are first-in-first-out. Task 1 is the oldest task in the list. To get recent policy installations, you have to look at the tasks towards the end of the list (thus my 'offset 2500' below).

Here is an exemplar task object corresponding to a successful policy installation. The policy package's name was Standard, and the firewall's name was DallasSA. Standard detail level first, then full detail level:

[Expert@DallasSA]# mgmt_cli -f json -r true show tasks limit 500 offset 2500 | jq -c '.tasks[]' | grep "Policy installation" | tail -n 1 | jq . { "task-id": "a8dee8f6-00f4-4a34-9d94-e29fa9ac6328", "task-name": "Policy installation - Standard", "status": "succeeded", "progress-percentage": 100, "suppressed": false, "comments": "Installation succeeded on DallasSA", "meta-info": { "lock": "unlocked", "validation-state": "ok", "last-modify-time": { "posix": 1691255301129, "iso-8601": "2023-08-05T17:08+0000" }, "last-modifier": "System", "creation-time": { "posix": 1691255275000, "iso-8601": "2023-08-05T17:07+0000" }, "creator": "System" } } [Expert@DallasSA]# mgmt_cli -f json -r true show tasks limit 500 offset 2500 details-level full | jq -c '.tasks[]' | grep "Policy installation" | tail -n 1 | jq . { "uid": "d3e5cd97-5e4a-4730-a515-7a237a977131", "type": "task", "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "task-id": "a8dee8f6-00f4-4a34-9d94-e29fa9ac6328", "task-name": "Policy installation - Standard", "status": "succeeded", "progress-percentage": 100, "start-time": { "posix": 1691255274991, "iso-8601": "2023-08-05T17:07+0000" }, "last-update-time": { "posix": 1691255301107, "iso-8601": "2023-08-05T17:08+0000" }, "suppressed": false, "task-details": [ { "uid": "385ec945-276e-49ed-b0c7-1e793159c713", "name": null, "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "color": "black", "statusCode": "succeeded", "statusDescription": "Succeeded", "taskNotification": "d3e5cd97-5e4a-4730-a515-7a237a977131", "gatewayId": "ea61e15b-0a8e-e441-a015-31dec0dcd15b", "policyId": "f9835641-5436-49fa-97e4-042a9fbb88de", "fastInstallStatus": { "worksessionId": "19ec3896-de91-4a08-998f-d057cdbac941", "gatewayId": "ea61e15b-0a8e-e441-a015-31dec0dcd15b", "policyId": "f9835641-5436-49fa-97e4-042a9fbb88de", "status": "eligible", "detailedReason": [] }, "runningStages": [], "waitingStages": [], "stagesInfo": [ { "type": "info", "stage": "modern verification", "messages": [] } ], "cluster": false, "meta-info": { "validation-state": "ok", "last-modify-time": { "posix": 1691255298536, "iso-8601": "2023-08-05T17:08+0000" }, "last-modifier": "System", "creation-time": { "posix": 1691255275622, "iso-8601": "2023-08-05T17:07+0000" }, "creator": "System" }, "tags": [], "icon": "General/globalsNa", "comments": "", "display-name": "", "customFields": null, "gatewayName": "DallasSA", "revision": "19ec3896-de91-4a08-998f-d057cdbac941" } ], "comments": "Installation succeeded on DallasSA", "color": "black", "icon": "General/globalsNa", "tags": [], "meta-info": { "lock": "unlocked", "validation-state": "ok", "last-modify-time": { "posix": 1691255301129, "iso-8601": "2023-08-05T17:08+0000" }, "last-modifier": "System", "creation-time": { "posix": 1691255275000, "iso-8601": "2023-08-05T17:07+0000" }, "creator": "System" }, "read-only": false }

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 15:17:05 GMT

Thanks @Bob_Zimmerman for the feedbacks. As I mentioned before, currently we (our Python program) are only allowed to interact with the Checkpoint via REST API. I will check with my Checkpoint admin guy to see about using the CLI commands and CLI logs.

I just tried to use show-tasks API call, with that large offset value, but got nothing back. Any good explanation why?

Request body:

{
"details-level": "standard",
"limit": 500,
"offset": 2500
}

Response:

{
"tasks": [
],
"total": 0
}

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 15:28:24 GMT

I think I got it! It returns nothing since there isn't that many (> 2500) tasks, right?

I do see my firewall now and the 'Policy installation'. So I just need to loop through, with incrementing offset. Our program currently is using a fixed offset of 0!

Thank you everyone for your feedbacks. I love this Checkpoint forum, so responsive to my questions! 👍

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 16:01:58 GMT

Actually, can someone share with me the request's body that will help sort the tasks by 'task-name', then by the 'iso-8601' time of the 'last-modify-time' field?

I tried (screenshot), but not working.

Re: Getting the times of 'Install Policy"

Bob_Zimmerman — Thu, 07 Sep 2023 19:27:52 GMT

The body looks correct, but the only valid value for "ASC" or "DESC" is "name". You can't sort by any other keys as of APIv1.9.1.

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 19:46:44 GMT

Not sure why 'filter' doesn't work, even though it's listed in the documentation. So I have v1.8, and still got the "message": "Unrecognized parameter [filter]" error message, with show-tasks.

Can you please shred some light?

Re: Getting the times of 'Install Policy"

Bob_Zimmerman — Thu, 07 Sep 2023 20:36:09 GMT

Probably a documentation bug. Everything to do with tasks feels very unfinished.

Re: Getting the times of 'Install Policy"

pdn — Thu, 07 Sep 2023 20:45:43 GMT

OK then, thanks for the prompt response.