topic Re: Add simple-cluster with groups over API in API / CLI Discussion

Add simple-cluster with groups over API

jimmy1 — Mon, 31 Jul 2023 12:36:25 GMT

Hello everybody!

I wanted to add a new simple cluster object over the mgmt-API including a list of groups with the "add-simple-cluster" command.

However if i add the "groups" parameter with a list of group names as value an error occurs:
"Validation failed with 1 blocking-error -> blocking-errors: -message: One of the objects that you selected could not be linked."

I think the "groups" parameter is not expecting a list of group names.

I don't understand it because with the "add-simple-gateway" command it works as expected.

So does anybody know what the groups parameter expects and can provide an example? Because in the Management API Reference it only says "Object" as an expected value for the "groups" parameter, but i don't know what is meant by that?

Here is a sample json where i get this error:

{
"name" : <name>,
"ip-address" : <ip-address>,
"groups" : [list of group names]
}

Re: Add simple-cluster with groups over API

the_rock — Mon, 31 Jul 2023 13:03:20 GMT

Can you send an example of command you tried? I can give it a go in R81.20 lab

Andy

Re: Add simple-cluster with groups over API

jimmy1 — Mon, 31 Jul 2023 13:22:28 GMT

I use the Python sdk API library:
GitHub - CheckPointSW/cp_mgmt_api_python_sdk: Check Point API Python Development Kit simplifies the use of the Check Point Management APIs.

Here is sample:

MGMT_SERVER_IP = <server-ip>
client_args = APIClientArgs(server=MGMT_SERVER_IP)
with APIClient(client_args) as client:
data = {
"name" : "cluster-name",
"ip-address" : "1.1.1.1",
"groups" : [list of existing group names]
}
response = client.api_call("add-simple-cluster", data)
if response.success:
print("success")
else:
print(f"{response.error_message}")

Re: Add simple-cluster with groups over API

the_rock — Mon, 31 Jul 2023 13:25:03 GMT

I was thinking below is what you tried, but let me test it.

Andy

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

Re: Add simple-cluster with groups over API

the_rock — Tue, 01 Aug 2023 01:04:33 GMT

Sorry, forgot to update, apologies. I got same issue as you in my R81.20 lab, but will check again tomorrow. Seems like there is minor syntax error somewhere, just my gut feeling, but I could be mistaken.

Andy

Re: Add simple-cluster with groups over API

jimmy1 — Tue, 01 Aug 2023 05:32:00 GMT

I am using the WEB-API and therefore a python library exist which handles the https connection and so on.

But basically it is the same as normal, because i have to build the json and then call the library function to send it to the server.

Surely I have to login before calling the library function with the login command.

Re: Add simple-cluster with groups over API

jimmy1 — Wed, 02 Aug 2023 12:03:50 GMT

Anything new?

Re: Add simple-cluster with groups over API

the_rock — Wed, 02 Aug 2023 15:50:10 GMT

Im off today, was travelling, but will check soon and let you know.

Cheers,

Andy

Re: Add simple-cluster with groups over API

the_rock — Wed, 02 Aug 2023 16:54:44 GMT

K, I just followed example at the bottom of this link and worked fine.

Andy

https://sc1.checkpoint.com/documents/latest/APIs/?#cli/add-simple-cluster~v1.9%20

Re: Add simple-cluster with groups over API

jimmy1 — Thu, 03 Aug 2023 07:07:24 GMT

Did you use a list of groups or what did you use?

And I am using a R81.10 Management Server, can you test it with this version as well?

Re: Add simple-cluster with groups over API

the_rock — Thu, 03 Aug 2023 11:55:19 GMT

I did and it failed.

Andy

Re: Add simple-cluster with groups over API

the_rock — Thu, 03 Aug 2023 13:22:32 GMT

Honestly, I would contact TAC and provide all the details, as it appears R81.10 code related.

Andy