topic Re: Using XML API to query policy post rules in Automation/API Discussions

Using XML API to query policy post rules

julio.toledo — Thu, 15 Jul 2021 14:58:02 GMT

Trying to find the correct syntax for querying Panorama for policy post rules by matching IP address (source or destination IP) using the PanOS XML API.

I have looked at:

our XML API Browser page (i.e. https://<mypanoramahostname>/api),
the online docs (https://docs.paloaltonetworks.com/pan-os/9-1/pan-os-panorama-api/),
A documented Postman collection(https://documenter.getpostman.com/view/2937330/7LgDQwG), and
this LIVEcommunity site.

Still not finding what I am looking for. Is it me, or is API not sufficiently well documented? Can anyone point me to where I can find documentation for each PanOS XML API endpoint, preferably with syntax examples for all possible endpoint parameters?

Re: Using XML API to query policy post rules

JimmyHolland — Mon, 19 Jul 2021 17:13:19 GMT

Hi @julio.toledo, I believe you're trying to use the "test policy match" feature via API? If so, I did something similar a couple of weeks ago. I did NAT rules, but you could easily change the API call below to use security rules instead.

https://{{panorama-host}}/api?key={{key}}&type=op&cmd=<request-batch><op-command><device><entry name="{{fw1-serial}}"><vsys><list><member>vsys1</member></list></vsys></entry><entry name="{{fw2-serial}}"><vsys><list><member>vsys1</member></list></vsys></entry></device><test><nat-policy-match><from>Management</from><to>External</to><source>172.31.10.50</source><destination>8.8.8.8</destination><destination-port>443</destination-port><protocol>6</protocol></nat-policy-match></test></op-command></request-batch>

I find the easiest way to find API calls is to debug the GUI, or debug the CLI.

Re: Using XML API to query policy post rules

julio.toledo — Mon, 19 Jul 2021 18:31:04 GMT

Thanks @JimmyHolland. Yes, I am trying to query security rules via API, either aggregate rules from all devices or from a particular device. However I am not a network or firewall engineer, so things like PanOS CLI commands and Panorama schema (objects, properties, etc.) are new to me.

I find it hard to understand that there is no online reference to the Panorama schema and how it maps to either CLI commands and/or API requests. Reverse engineering it by debugging the GUI or the CLI seems rather backwards, don't you agree?

Re: Using XML API to query policy post rules

JimmyHolland — Mon, 19 Jul 2021 19:44:58 GMT

Hi @julio.toledo, I understand learning the PAN-OS schema must be a challenge if you are new to PAN-OS and firewalls/network-security/networking. There is no exhaustive list of XML API endpoints to the full extent, which is why the debug approach usually works best, especially as the CLI/GUI are themselves clients of the XML API. The newer REST API is improving this situation, however, and continues to gain coverage with each release of PAN-OS, so that's something to keep an eye on.

Re: Using XML API to query policy post rules

julio.toledo — Thu, 22 Jul 2021 16:23:21 GMT

Thanks @JimmyHolland I figured out how to structure a 'security-policy-match', however it's requiring arguments that make the query far too specific/narrow. It seems that both 'protocol' and 'destination-port' are required, and neither one allows 'any' or '*' or even a range of values (integers only).

Is there a way to match policies across:

all PAN-OS devices (without having to explicitly enumerate them)
all destination-ports (i.e. "any")
all IP protocols ( i.e. "any", or at least {6,17} ).

Re: Using XML API to query policy post rules

JimmyHolland — Fri, 23 Jul 2021 09:07:50 GMT

Hi @julio.toledo, the API structure for this feature will match what you see in the GUI, where there are indeed mandatory fields (the red boxes) like destination ports, and protocol is a drop-down between TCP/UDP/ICMP:

Test Policy Match GUI Screenshot

I think this feature is designed to give people a way to test if specific traffic will theoretically pass through the firewall, rather than the very broad and almost audit-type requirement which you have. If you talk with your allocated Systems Engineer or reseller (if you're unsure who they are, send me a direct message on here and I will assist) then they will be able to discuss your requirements and potentially raise a feature request.

Other options to fulfil your requirements would involve an approach of systematically checking the live configurations of your firewall estate, by exporting the Panorama running config and walking through the XML data in your programming language of choice.

Re: Using XML API to query policy post rules

julio.toledo — Fri, 23 Jul 2021 15:49:23 GMT

Ding, ding, ding! We have a winner. So what I am looking to accomplish is audit/research level work.

On a competitor's product (which shall remain nameless) I am able to issue the following simple, single-line CLI command (on a device-by-device basis) and get back an exhaustive std output of every member rule matching the IP that I'm searching for --either as source or as destination:

show access-list | include {{ lookupIP }}

This is exactly the kind of functionality that I'm looking for from Panorama/PAN-OS.

Re: Using XML API to query policy post rules

JimmyHolland — Tue, 03 Aug 2021 09:30:55 GMT

Thanks for confirming @julio.toledo. Per DM, we've connected you with your SE in order to discuss this topic in more detail.