topic Re: Bulk Add Network Objects in API / CLI Discussion

Bulk Add Network Objects

Ed_Eades — Thu, 07 Sep 2017 21:06:25 GMT

I am looking for advice on how to bulk add network objects. I need to add around 550 networks and we are on GAIA R80.10. I have read some about dbedit, Using a dbedit script to create new network objects and network object groups, but I am not sure if that would still be the best method. I will also mention I have never used dbedit. When adding these network objects I would also like to add a description on each network object. The dbedit link does not include the syntax for the description.

I came across a thread on cpug that If R80, there are more robust CLI for these things. You can find documentation and several examples at https://community.checkpoint.com.

Thanks in advance!

Re: Bulk Add Network Objects

PhoneBoy — Fri, 21 Jun 2019 08:57:24 GMT

For this task, you can use dbedit, but you don't need to.

R80+ has a new API/CLI that is a bit easier to use than dbedit.

See the documentation for using mgmt_cli add host here: Check Point - Management API reference: add host

There are several examples in the https://community.checkpoint.com/community/developers?sr=search&searchId=b0714703-c1b9-449b-afb4-0840f74320f5&searchIndex=0‌ space.

One specific example that might be useful here: CLI API Example for exporting, importing, and deleting different objects using CSV files (v 00.25.01 and later)‌

Re: Bulk Add Network Objects

Ed_Eades — Fri, 08 Sep 2017 15:02:18 GMT

Very helpful, thank you. Can you tell me what the Parameter Name would be for the "Comment" Field? I would like put a comment on all the networks I am adding.

Thanks again!

Re: Bulk Add Network Objects

PhoneBoy — Fri, 08 Sep 2017 17:16:45 GMT

The parameter is comments.

It's listed in the documentation, but hidden behind text that can be expanded with a "More" link.

Re: Bulk Add Network Objects

Tim_Koopman — Mon, 11 Sep 2017 02:35:24 GMT

Hi,

I have created a PowerShell module that uses the Web API calls. One of the examples I have using it is doing an import from Excel file of network objects. Very easy to import as many objects as you like.

R80 PowerShell Module | GitHub: Import from Excel Example

Regards

Tim

Re: Bulk Add Network Objects

Ed_Eades — Fri, 06 Apr 2018 15:49:26 GMT

I have tried testing using the API/CLI with a .csv file but receive an error message. I uploaded file test.csv to the var/log directory and ran the command, mgmt_cli add network --batch var/log/test.csv

The .csv file looks like this

name,subnet,subnet-mask,comments
NET_10.10.16.0,10.10.16.0,255.255.255.0,Test Network

The error message received is:

Line 2: code: "generic_err_invalid_parameter_name"
message: "Unrecognized parameter [name]"

I am not sure what may be causing this to fail.

Thanks.

Re: Bulk Add Network Objects

Robert_Decker — Sun, 08 Apr 2018 08:57:04 GMT

Hi Ed,

The command and the content of the csv file look correct.

From which directory are you running the mgmt_cli tool?

Robert.

Re: Bulk Add Network Objects

Ed_Eades — Fri, 27 Apr 2018 20:52:26 GMT

I had underscores in the name field of the CSV file. Eventhough GAIA accepts names with underscores, CSV files typically do not handle underscores well. After removing the underscore I was able to import using the mgmt._cli add network --batch command. The import is a huge time saver.

Thanks for all the input.

Re: Bulk Add Network Objects

Ankur_Datta — Tue, 08 Jan 2019 06:20:13 GMT

I am trying to add objects into CMA. but when i run api command i get below error:

Line 11: code: "generic_err_invalid_parameter"
message: "Parameter [nat-settings] value is not valid"

I ran following command:

mgmt_cli add host --batch networkobjects.csv

and excel sheet has following fields:

and nat settings has

kindly advise.

Re: Bulk Add Network Objects

PhoneBoy — Tue, 08 Jan 2019 06:49:17 GMT

If you want to set individual NAT settings in a CSV, you must specify each setting correctly as a name value pair.

Since nat-settings has subsettings, this means you will need multiple parameters.

For example, you would need nat-settings.hide-behind with value "ip-address" and nat-settings.ipv4-address with value "yourip".

Re: Bulk Add Network Objects

Ankur_Datta — Tue, 08 Jan 2019 07:28:41 GMT

Thanks Dameon. got it. I thought export csv file from smart console will work but i was wrong.

I have one more question. If i want to move network objects from one CMA to another CMA in same MDS through api. What is the procedure? I tested this but unfortunately objects didn't appeared in new CMA.

I was in CMA env and executed the api command from there through CLI.

Re: Bulk Add Network Objects

PhoneBoy — Tue, 08 Jan 2019 15:55:37 GMT

At a high level, you would be making successive calls to the relevant APIs to read the objects against one CMA, then write them to the other CMA.

There are several working examples of this on CheckMates.

Re: Bulk Add Network Objects

Ankur_Datta — Tue, 08 Jan 2019 17:01:12 GMT

Hi Dameon,

I can't find any post.

kindly can you please share the link if you are aware off.

Thanks

Re: Bulk Add Network Objects

PhoneBoy — Tue, 08 Jan 2019 17:08:17 GMT

You're corresponding with our R&D on one such tool

Here's another that does export/import via CSV files: CLI API Example for exporting, importing, and deleting different objects using CSV files (v 00.29.02 and later)‌

I also provided a sample with raw API calls recently here (calling via curl on the CLI): https://community.checkpoint.com/thread/5999-cli-help?commentID=36360#comment-36360

Re: Bulk Add Network Objects

Tom_Cripps — Fri, 16 Aug 2019 13:39:47 GMT

Hi Robert,

I'm running into a similar issue, my names don't have underscores like Ed's. I'm running this application from within the home/admin directory with the csv also within that directory as well.

Any tips?

Re: Bulk Add Network Objects

Aathi — Wed, 27 Nov 2019 12:50:17 GMT

Hi Team,

Can you guide how to import the range of ip address which is in csv file in checkpoint managment server.

119.227.224.0-119.227.255.255

Regards

Aathi

Re: Bulk Add Network Objects

Jason_Grubbs — Thu, 12 Nov 2020 15:47:18 GMT

@PhoneBoy I know this is an old post, but I found it when searching for information about bulk importing. So far, the info has been excellent!

I have one question about adding networks to an existing group using a csv.

I see from the API reference https://sc1.checkpoint.com/documents/latest/APIs/index.html#cli/add-network~v1.1%20 that I can add a network to a group, but what is the syntax I use in the CSV? Same for Tags...

For Example:

name	subnet	subnet-mask	comments	tags
Zoom-101.36.167.0/24	101.36.167.0	255.255.255.0	Zoom-101.36.167.0/24	Zoom

Or do I need to add more info to the tags field:

name	subnet	subnet-mask	comments	tags
Zoom-101.36.167.0/24	101.36.167.0	255.255.255.0	Zoom-101.36.167.0/24	name "Zoom"

Re: Bulk Add Network Objects

PhoneBoy — Thu, 12 Nov 2020 17:16:32 GMT

In the CSV header line, use groups.1 or tags.1 as appropriate.
To add to additional groups as part of the same CSV, increment the number (e.g. groups.2, tags.2).
You can see an example here: https://community.checkpoint.com/t5/API-CLI-Discussion-and-Samples/One-liner-Convert-CSV-for-Management-API/m-p/81018#M4677