cancel
Showing results for 
Search instead for 
Did you mean: 
cancel
Announcements

5835
Views
50
Helpful
33
Replies
Highlighted
Cisco Employee

API based tool to save the Access Control Policy from FMC as CSV

Hello Everyone,

 

Very often as Network Administrator there is a need to save the ACP on the Firepower Management Center(FMC) as CSV, while the FMC in itself supports the policy import and export option as a full-fledged feature there is no way to save the ACP as CSV.

 

The script attached here solves the problem, however, this is not a replacement for the backup features from FMC.

 

Note: This tool by no means is a replacement for the policy import and export option of FMC. This tool is intended to have the CSV generated for ACP.


It does not take the backup of the objects or IPS/File Policy associated, it just gives a listing of the configuration.

 

What is supported:

1. Policy extraction from the FMC over API.
2. Extracts Zones, Networks, Applications, URL's, Users, IPS Policy, File Policy, Variable Sets, Logging configurations.
3. The output format is in CSV with ";" separated multiple entries within a specific field.
4. Currently supported only on FMC, no FDM support available.


Upcoming features:

1. Auto-listing of available policies across the domains.
2. Support for ISE/SGT attributes.

3. Writing the CSV backup as ACP to the FMC.

 

 

The tool will be updated every month with new features wherever applicable.

 

#Firepower #FMC

P.S: This is not an official tool, so please leave your comment/feedback below and we will try our best to address it as soon as possible.

 

@Anupam Pavithran

33 REPLIES 33
Highlighted
Enthusiast

Has anyone been able to get this to work successfully?  We would love to have this capability for our firewall policy reviews, but have not been able to get this to work yet.  Is there any more specific documentation available?

Any direction would be greatly appreciated.

Highlighted

Hi Nelson,

 

The requirements to get this working are as below:

1. A machine that has python 2.7 installed.

2. Connectivity to the FMC from the machine.

3. Install the pre-req mentioned in the requirements.txt when the attachment is unzipped.

4. Ensure that the contents of the folder remain intact.

 

If you are facing any specific errors or challenges let us know.

 

 

Highlighted

Thank you so much for your help!  We have this working and it will be a life saver for us as we do our firewall reviews.  Awesome tool!

Highlighted

one more request - the current conversion does not include the comment field.  would it be possible to include the comments?  we need those for our PCI reviews so that would be very helpful.

 

thanks again for putting this together.

Highlighted

Hi Nelson,

Thanks for the feedback, i am really glad that the tool is useful.

As far as the comments section is concerned in the tool, we will surely look into it and keep you posted.

 

Really appreciate all the feedback which helps us make it better.

Highlighted

Hi Nelson,

The next build of the tool will have the comments also.

Currently working on the beta testing of the same internally.

Highlighted

Thank you so much! That will be great to have the comments in the output as well. We appreciate you adding this feature and will watch for the next build.
Highlighted

The new build is available as an attachment in the main post.

Features added:

1. Support for Python3

2. Auto listing of the ACP configured on the box.

3. Support for multi-domains.

4. Comments added as part of the export.

Highlighted

This is a great script, but I've had to make a few changes.


The readme.md in Policy CSV-rel2.zip still says it requires Python 2.7!
Newlines and commas in comments cause the remaining columns to split to a new line in CSV. Insert the middle 2 lines below (below line 182) to replace newline char with ;LF; text.

for obj in temp['comments']:
obj['comment'] = obj['comment'].replace('\n',';LF;')
obj['comment'] = obj['comment'].replace(',',';')
comment = obj['comment']​


Our rules appear to have comments that were added in during a rule import. These comments have no user attached, which crashes the script out.

After line 184 I added:
if not 'name' in obj['user']:
obj['user']['name'] = "Admin_Import"

Result:
date = date.split(".")[0]
if not 'name' in obj['user']:
obj['user']['name'] = "Admin_Import"
user = obj['user']['name']​

The above changes force a username into a comment with no user, allowing the script to complete.
Commas in rule name also need sanitisation.

Find (around line 157):
line['name'] = rule['name']

Replace line to show:
line['name'] = rule['name'].replace(",",";")​

 

EDIT1: However the remaining columns don't input until the next line. So there's still some tidying to do on the change. But at least it completes....

EDIT2: Confirmed that newlines within comment were causing issues, added code to replace newline with text. Also replace commas in comments and names.

Highlighted

Hi Kieran,

 

Thanks for making those necessary changes.

Comments section in the rules was not heavily focussed hence you can feel free to share the modified code for larger community

Highlighted

Hi,

 

is there anyway to export the nat rules?

 

Thanks,

Highlighted

Sorry for coming back late on this, have not started working on the NAT config part, but through API it should be possible

Highlighted
Beginner

Hi @Raghunath Kulkarni 

 

I was wondering if you could help me with this issue i´m having with the script. I get the following error mid rule export. Im using python 2.7.18. I tried with both releases.

UnicodeEncodeError: 'ascii' codec can't encode character u'\xf3'

 

erro.jpeg

Thanks

Highlighted

This looks to be a problem with the logging configuration on Rule # 17 or the next rule.

Can you share the screen shot of the logging tab within the rule 17 and next one, so that i can quickly check what is causing the unicode error

Content for Community-Ad