topic Re: Generic API, List Index in API / CLI Discussion

Generic API, List Index

Christian_Riede — Mon, 06 Apr 2020 20:48:04 GMT

Hello,

in dbedit, according to the documentation, you can edit elements of a list in the following way:

dbedit> modify network_objects My_FW interfaces:3:ipaddr IP_ADDRESS

This changes the attribute ipaddr of the 3rd interface.

How is this achieved which the gerneic api? How does one change attributes of a object in a list. Note that I am not asking how to change an ip address via api. My question is about general API syntax.

My use case is to go into a firewall object, navigate to the realmsForBlades section and change the userloginattr.

Something like

set generic-object uid="something'" realmsForBlades.1.directory.userloginattr SAMACOUNTNAME

, but that specific syntax does not work.

Probably, it's something like

set generic-object uid="something'" realmsForBlades.set .... ,but I cannot find the correct syntax anywhere.

Can anyone help?

Thanks

Christian Riede

Re: Generic API, List Index

PhoneBoy — Wed, 08 Apr 2020 00:06:00 GMT

Someone else ran into a similar situation trying to edit the platform portal URL, which requires a similar sort of change.
My understanding (confirmed by R&D) is the generic-object API doesn't provide a way to edit these sorts of attributes.
See: https://community.checkpoint.com/t5/CloudGuard-IaaS/Azure-VMSS-Gaia-Certificates/m-p/80948#M1745
You can still use dbedit, however.

Re: Generic API, List Index

Christian_Riede — Wed, 08 Apr 2020 09:24:01 GMT

Well. "generic"... ok.

Re: Generic API, List Index

Christian_Riede — Wed, 08 Apr 2020 10:05:17 GMT

on dbedit:

# dbedit
Enter Server name (ENTER for 'localhost'):

Please enter a command, -h for help or -q to quit:
dbedit> modify network_objects <name-of-firewall> realmsForBlades:0:directory:userloginattr SAMACCOUNTNAME
failed to get field realmsForBlades

Reason: in objects_5.0.C, it's realms_for_blades, not realmsForBlades. And it's not SAMACCOUNTNAME, but sAMAccountName

the following works:

modify network_objects <name-of-firewall> realms_for_blades:0:directory:UserLoginAttr sAMAccountName

Now please Checkpoint, can we get rid of dbedit soon?

Re: Generic API, List Index

PhoneBoy — Wed, 08 Apr 2020 18:52:14 GMT

That's the ultimate plan, yes.

Re: Generic API, List Index

Christian_Riede — Thu, 09 Apr 2020 07:53:14 GMT

Adding support for indexes like in dbedit to the generic API seems to be a low hanging fruit and would solve the problem in a general way.

Having a specific API for all the objects is probably the long term solution.

Re: Generic API, List Index

PhoneBoy — Sat, 11 Apr 2020 00:54:04 GMT

The ultimate goal is to eliminate the need for the generic-object API entirely, which means having proper, supported API endpoints for everything.

Re: Generic API, List Index

Christian_Riede — Mon, 20 Apr 2020 09:09:07 GMT

So the question is: What happens first - get rid of dbedit by making the generic api functional or get rid of dbedit and generic api at the same time once the specific api is available? 😂

Re: Generic API, List Index

PhoneBoy — Mon, 20 Apr 2020 18:54:58 GMT

Remember that the generic-object API largely exists to deal with things that need to be automated in a RESTful way but don't have formal API support yet.
Once there is formal API support for something, there's no need to have support for it via generic-object, which was never meant to be a formally supported API to begin with.
Which means: the second option is most likely.